Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BasePlayer

The base interface that a Player implements in a game.

Hierarchy

Index

Properties

clientType

clientType: string

What type of client this is, for potential data mining purposes.

example

"Python", "JavaScript", or some other language.

gameObjectName

gameObjectName: string

A 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.

It 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.

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.

Generated using TypeDoc