JavaScript Joueur Client

Class: Port

Pirates. Port

A port on a Tile.

new Pirates.Port()

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

Extends

Members

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

For players, how much more gold this Port can spend this turn. For merchants, how much gold this Port has accumulated (it will spawn a ship when the Port can afford one).

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 investment

(Merchants only) How much gold was invested into this Port. Investment determines the strength and value of the next ship.

Array.<string> logs

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

Pirates.Player owner

The owner of this Port, or null if owned by merchants.

Pirates.Tile tile

The Tile this Port is on.

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.

boolean spawn(type)

Spawn a Unit on this port.
Name Type Description
type string What type of Unit to create ('crew' or 'ship').
Returns: boolean
True if Unit was created successfully, false otherwise.

string toString()

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