Class: Player

Pirates. Player

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

new Pirates.Player()

Initializes a Player with basic logic as provided by the Creer code generator. Never use this directly. It is for internal Joueur use.

Extends

Members

string clientType

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

string gameObjectName

Inherited From:
Pirates.GameObject#gameObjectName
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.

number gold

The amount of gold this Player has in reserve.

string id

Inherited From:
Pirates.GameObject#id
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.

number infamy

The amount of infamy this Player has.

Array.<string> logs

Inherited From:
Pirates.GameObject#logs
Any strings logged will be stored here. Intended for debugging.

boolean lost

If the player lost the game or not.

string name

The name of the player.

Pirates.Player opponent

This player's opponent in the game.
The Port owned by this Player.

string reasonLost

The reason why the player lost the game.

string reasonWon

The reason why the player won the game.

number timeRemaining

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

Array.<Pirates.Unit> units

Every Unit owned by this Player.

boolean won

If the player won the game or not.

Methods

log(message)

Inherited From:
Pirates.GameObject#log
Adds a message to this GameObject's logs. Intended for your own debugging purposes, as strings stored here are saved in the gamelog.
Name Type Description
message string A string to add to this GameObject's log. Intended for debugging.

string toString()

Inherited From:
BaseGameObject#toString
toString override for easier debugging
Returns: string
readable string in the format `GameObjectName #id`