Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Player

A player in this game. Every AI controls one player.

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

clientType

clientType: string

What type of client this is, e.g. 'Python', 'JavaScript', or some other language. For potential data mining purposes.

gameObjectName

gameObjectName: string

String representing the top level Class that this game object is an instance of. Used for reflection to create new instances on clients, but exposed for convenience should AIs want this data.

generatorTiles

generatorTiles: Tile[]

Every generator Tile owned by this Player. (listed from the outer edges inward, from top to bottom).

heat

heat: number

The amount of heat this Player has.

id

id: string

A unique id for each instance of a GameObject or a sub class. Used for client and server communication. Should never change value after being set.

internSpawn

internSpawn: number

The time left till a intern spawns. (0 to spawnTime).

logs

logs: string[]

Any strings logged will be stored here. Intended for debugging.

lost

lost: boolean

If the player lost the game or not.

managerSpawn

managerSpawn: number

The time left till a manager spawns. (0 to spawnTime).

name

name: string

The name of the player.

opponent

opponent: Player

This player's opponent in the game.

physicistSpawn

physicistSpawn: number

The time left till a physicist spawns. (0 to spawnTime).

pressure

pressure: number

The amount of pressure this Player has.

reasonLost

reasonLost: string

The reason why the player lost the game.

reasonWon

reasonWon: string

The reason why the player won the game.

spawnTiles

spawnTiles: Tile[]

All the tiles this Player's units can spawn on. (listed from the outer edges inward, from top to bottom).

timeRemaining

timeRemaining: number

The amount of time (in ns) remaining for this AI to send commands.

units

units: Unit[]

Every Unit owned by this Player.

won

won: boolean

If the player won the game or not.

Methods

log

  • log(message: string): Promise<void>
  • Adds a message to this GameObject's logs. Intended for your own debugging purposes, as strings stored here are saved in the gamelog.

    Parameters

    • message: string

      A string to add to this GameObject's log. Intended for debugging.

    Returns Promise<void>

toString

  • toString(): string
  • A toString override for easier debugging.

    example

    String(gameObject); 🠞 "GameObjectName #1245"

    Returns string

    A human readable representation of the game object.

Generated using TypeDoc