Class Universe

Hierarchy

Universe

Index

Constructors

constructor

Properties

endpoint

Methods

Constructors

constructor

new Universe(id: ID, region: Region): Universe
new Universe(encodedData: XMLUniverse): Universe
new Universe(endpoint: string): Universe

- Defined in src/universe/universe.ts:19
Parameters
- id: ID
  
  Universe's ID
- region: Region
  
  Universe's region Used by official GameForge servers
Returns Universe
- Defined in src/universe/universe.ts:25
todo

Disable XMLUniverse href parsing

todo

Disable XMLUniverse href parsing

Parameters
- encodedData: XMLUniverse
Returns Universe
- Defined in src/universe/universe.ts:26
Parameters
- endpoint: string
  
  Universe's API endpoint Used by unofficial servers
Returns Universe

Properties

endpoint

endpoint: string

Methods

getAlliancePositions

getAlliancePositions<T>(type: T): Promise<Position[]>

- Defined in src/universe/universe.ts:79
Gets universe's alliance positions (highscore)

Type parameters
- T: PositionType
Parameters
- type: T
Returns Promise<Position[]>

getAlliances

getAlliances(): Promise<Alliance[]>

- Defined in src/universe/universe.ts:59
Gets universe's alliances

Returns Promise<Alliance[]>

getLocalizations

getLocalizations(): Promise<LocalizationMap>

- Defined in src/universe/universe.ts:100
Gets universe's localizations

Returns Promise<LocalizationMap>

getPlanets

getPlanets(): Promise<Planet[]>

- Defined in src/universe/universe.ts:50
Gets universe's planets

Returns Promise<Planet[]>

getPlayer

getPlayer(id: string): Promise<Player>

- Defined in src/universe/universe.ts:109
Gets full player (no references) by id

Parameters
- id: string
Returns Promise<Player>

getPlayerPositions

getPlayerPositions<T>(type: T): Promise

- Defined in src/universe/universe.ts:68
Gets universe's player positions (highscore)

Type parameters
- T: PositionType
Parameters
- type: T
Returns Promise

getPlayers

getPlayers(): Promise<PlayerReference[]>

- Defined in src/universe/universe.ts:41
Gets universe's players

Returns Promise<PlayerReference[]>

getServer

getServer(): Promise<ServerMap>

- Defined in src/universe/universe.ts:90
Gets universe's properties

Returns Promise<ServerMap>

Static Private parseEndpoint

parseEndpoint(arg1: ID | XMLUniverse | string, arg2?: Region): string

- Defined in src/universe/universe.ts:119
Parses the universe id and region to create an API endpoint

Parameters
- arg1: ID | XMLUniverse | string
- Optional arg2: Region
Returns string

Generated using TypeDoc