Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Player

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

Hierarchy

Implements

  • IBaseGameObject

Index

Properties

Methods

Properties

clientType

clientType: string

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

color

color: "black" | "white"

The color (side) of this player. Either 'white' or 'black', with the 'white' player having the first move.

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.

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.

logs

logs: string[]

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

lost

lost: boolean

If the player lost the game or not.

name

name: string

The name of the player.

opponent

opponent: Player

This player's opponent in the game.

reasonLost

reasonLost: string

The reason why the player lost the game.

reasonWon

reasonWon: string

The reason why the player won the game.

timeRemaining

timeRemaining: number

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

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