Class Player

Hierarchy

Player

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Player(encodedData: XMLPlayer, universe: Universe): Player

- Defined in src/player/player.ts:28
Parameters
- encodedData: XMLPlayer
- universe: Universe
Returns Player

Properties

Optional alliance

alliance: LazyAlliance

Reference to the player's alliance. May be undefined

id

id: string

Player's identifier

name

name: string

Player's name

planets

planets: Planet[]

Player's planets. First element will always be the homeplanet

positions

positions: PlayerPositions

Player positions tuple. Index 3 will always be a military position

timestamp

timestamp: string

UNIX timestamp of when the object was parsed

universe

universe: Universe

Methods

Private parseAlliance

parseAlliance(alliance?: XMLLazyAlliance): undefined | LazyAlliance

- Defined in src/player/player.ts:68
Parameters
- Optional alliance: XMLLazyAlliance
Returns undefined | LazyAlliance

Private parsePlanets

parsePlanets(planets: Solo<XMLPlayerPlanet>): Planet[]

- Defined in src/player/player.ts:55
Parameters
- planets: Solo<XMLPlayerPlanet>
Returns Planet[]

Private parsePositions

parsePositions(positions?: XMLPlayerPosition[]): undefined | [Position, Position, Position, Position & XMLMilitaryPlayerPosition, Position, Position, Position]

- Defined in src/player/player.ts:42
Parameters
- Optional positions: XMLPlayerPosition[]
Returns undefined | [Position, Position, Position, Position & XMLMilitaryPlayerPosition, Position, Position, Position]

Generated using TypeDoc