Oolite JavaScript Reference: Player
Prototype: Object
The Player class is represents the player. There is always exactly one Player object in existence, which can be accessed through the player global property.
Contents
Properties
alertAltitude
alertAltitude : Boolean (read-only)
Whether the player is dangerously close to a planet.
alertCondition
alertCondition : Number (read-only, integer)
Returns the current alert condition. 0 = Docked, 1 = Green, 2 = Yellow, 3 = Red.
alertEnergy
alertEnergy : Boolean (read-only)
Whether the player’s energy level is depleted (i.e., energy is less than maxEnergy).
alertHostiles
alertHostiles : Boolean (read-only)
Whether there are hostile ships within scanner range.
alertMassLocked
alertMassLocked : Boolean (read-only)
Whether the player is mass locked.
alertTemperature
alertTemperature : Boolean (read-only)
Whether the cabin temperature is dangerously high.
bounty
bounty : Number (read/write integer)
The bounty on the player, which determines legal status. It is halved at each witchspace jump.
See also: legalStatus
contractReputation
This property was added in Oolite test release 1.72.
contractReputation : Number (read-only integer)
The player’s cargo contract reputation, ranging from -7 to +7.
See also: decreaseContractReputation(), increaseContractReputation(), passengerReputation
credits
credits : Number (read/write, integer)
The amount of money the player has.
dockingClearanceStatus
This property was added in Oolite test release 1.72.
dockingClearanceStatus : String (read-only)
A string indicating whether the player has docking clearance. (Clarify: for which station? -Ahruman 20:34, 3 November 2008 (UTC)) Possible values are:
"DOCKING_CLEARANCE_STATUS_NONE""DOCKING_CLEARANCE_STATUS_REQUESTED""DOCKING_CLEARANCE_STATUS_NOT_REQUIRED""DOCKING_CLEARANCE_STATUS_GRANTED""DOCKING_CLEARANCE_STATUS_TIMING_OUT"
legalStatus
This property was added in Oolite test release 1.72.
legalStatus : String (read-only)
A string describing the player’s legal status for display purposes, based on bounty. In English, this is one of "Clean" (bounty = 0), "Offender" (0 < bounty ≤ 50) or "Fugitive", but note that it can be localized.
name
name : String (read-only)
The name of the player’s character (e.g., “Jameson”).
passengerReputation
This property was added in Oolite test release 1.72.
passengerReputation : Number (read-only integer)
The player’s passenger contract reputation, ranging from -7 to +7.
See also: contractReputation(), decreasePassengerReputation(), increasePassengerReputation()
rank
This property was added in Oolite test release 1.72.
rank : String (read-only)
A string describing the player’s rank for display purposes, based on score, such as "Mostly Harmless" or "Dangerous". Note that it can be localized.
score
score : Number (read/write, integer)
The player’s score; nominally the number of kills the player has made, although some missions award additional points.
trumbleCount
This property was added in Oolite test release 1.71.
trumbleCount : Number (read-only nonnegative integer)
The number of trumbles the player is currently blessed with.
Methods
commsMessage
function commsMessage(message : String [, duration: Number])
Writes the specified message in the player’s communications log, as well as displaying it as a console message. The optional duration parameter determines how long the message should be displayed on the console before fading out. It is clamped to the range [1, 10]. If no duration is specified, 4.5 seconds will be used. Example: player.commsMessage("Hello, cruel universe.", 6)
consoleMessage
function consoleMessage(message : String [, duration: Number])
Displays the specified message as a console message, that is, as a message on the HUD. The optional duration parameter determines how long the message should be displayed before fading out. It is clamped to the range [1, 10]. If no duration is specified, 3 seconds will be used.
decreaseContractReputation
function decreaseContractReputation()
Give the player a negative reputation point for cargo contracts.
See also: contractReputation, increaseContractReputation()
decreasePassengerReputation
function decreasePassengerReputation()
Give the player a negative reputation point for passenger contracts.
See also: passengerReputation, increasePassengerReputation()
increaseContractReputation
function increaseContractReputation()
Give the player a positive reputation point for cargo contracts.
See also: contractReputation, decreaseContractReputation()
increasePassengerReputation
function increasePassengerReputation()
Give the player a positive reputation point for passenger contracts.
See also: passengerReputation, decreasePassengerReputation()
