Difference between revisions of "Oolite JavaScript Reference: Ship"
(Added script.) |
(→Properties: Updated roles, added roleProbabilities and primaryRole.) |
||
| Line 80: | Line 80: | ||
potentialCollider [read-only Entity] | potentialCollider [read-only Entity] | ||
The entity the ship is currently trying not to crash into, if any. | The entity the ship is currently trying not to crash into, if any. | ||
| + | |||
| + | === <code>primaryRole</code> === | ||
| + | primaryRole [read/write string] | ||
| + | The main role of the ship; the role for which it was created. For instance, if a ship’s ''shipdata.plist'' entry specifies the roles “pirate trader(0.5) escort”, and a ship of that type is spawned to be a trader, its <code>primaryRole</code> is <code>"pirate"</code>, its <code>roles</code> is <code>["escort", "pirate", "trader"]</code> and its <code>roleProbabilities</code> is <code> { "escort":1, "pirate":1, "trader":0.5}</code>. | ||
| + | |||
| + | '''See also:''' <code>[[#roles|roles]]</code>, <code>[[#roleProbabilities|roleProbabilities]]</code>. | ||
=== <code>reportAIMessages</code> === | === <code>reportAIMessages</code> === | ||
reportAIMessages [read/write boolean] | reportAIMessages [read/write boolean] | ||
| − | Debugging facility: set to <code>true</code> to dump information about AI activity to the log. | + | Debugging facility: set to <code>true</code> to dump information about AI activity to the log. |
| + | |||
| + | === <code>roleProbabilities</code> === | ||
| + | roles [read-only object] | ||
| + | The probabilities for each role in <code>[[#roles|roles]]</code>. Example: | ||
| + | this.pirateProb = ship.roleProbabilities["pirate"] | ||
| + | '''See also:''' <code>[[#primaryRole|primaryRole]]</code>, <code>[[#roles|roles]]</code>. | ||
=== <code>roles</code> === | === <code>roles</code> === | ||
roles [read-only array] | roles [read-only array] | ||
| − | The roles of the ship. | + | The roles of the ship. This consists of the roles specified in the ship’s ''shipdata.plist'' entry, as well as the <code>[[#primaryRole|primaryRole]]</code> if it is not among those. |
| + | |||
| + | '''See also:''' <code>[[#primaryRole|primaryRole]]</code>, <code>[[#roleProbabilities|roleProbabilities]]</code>. | ||
=== <code>scannerRange</code> === | === <code>scannerRange</code> === | ||
| Line 124: | Line 138: | ||
withinStationAegis [read-only boolean] | withinStationAegis [read-only boolean] | ||
<code>true</code> if the ship is within the aegis of the system’s main station (i.e., no more than 51 200 game metres from the station, or twice scanner range). | <code>true</code> if the ship is within the aegis of the system’s main station (i.e., no more than 51 200 game metres from the station, or twice scanner range). | ||
| − | |||
== Methods == | == Methods == | ||
Revision as of 12:37, 7 September 2007
Prototype: Entity
Subtypes: Station, Player
The Ship class is an Entity representing a ship, station, missile, cargo pod or other flying item – anything that can be specified in shipdata.plist. A Ship has all the properties and methods of a Entity, and several others.
Stations and the Player are types of ship. Note that these more specific types have additional properties and methods.
Contents
- 1 Properties
- 1.1 AI
- 1.2 AIState
- 1.3 beaconCode
- 1.4 bounty
- 1.5 entityPersonality
- 1.6 escorts
- 1.7 fuel
- 1.8 groupID
- 1.9 hasHostileTarget
- 1.10 hasSuspendedAI
- 1.11 heatInsulation
- 1.12 isBeacon
- 1.13 isCloaked
- 1.14 isFrangible
- 1.15 isJamming
- 1.16 maxCargo
- 1.17 maxSpeed
- 1.18 potentialCollider
- 1.19 primaryRole
- 1.20 reportAIMessages
- 1.21 roleProbabilities
- 1.22 roles
- 1.23 scannerRange
- 1.24 script
- 1.25 speed
- 1.26 shipDescription
- 1.27 subEntities
- 1.28 target
- 1.29 temperature
- 1.30 weaponRange
- 1.31 withinStationAegis
- 2 Methods
Properties
AI
AI [read-only string]
The name of the ship’s current AI. (See also: AIState, setAI(), switchAI(), exitAI())
AIState
AIState [read/write string, read-only for player]
The ship’s AI’s current state. (See also: AI, reactToAIMessage(), hasSuspendedAI)
beaconCode
beaconCode [read-only string]
If the ship is a beacon, an identifying string. The first character is used for identification on the Advanced Space Compass. For non-beacons, this property is null. (See also: isBeacon)
bounty
bounty [read/write integer]
The bounty on the ship. This also determines its legal status. In the case of the player, it is halved at each witchspace jump.
entityPersonality
entityPersonality [read-only int]
A random number in the range 0..32767 which is generated when the ship is created. Equivalent to the entityPersonalityInt uniform binding.
escorts
target [read-only array of Entitys]
The ship’s deployed targets.
fuel
fuel [read/write double]
The ship’s current fuel capacity, in LY. The game will limit this to the range 0..7, and round it off to the nearest tenth. (See also: Player.fuelLeakRate)
groupID
groupID [read-only int]
The ID of the group to which this ship belongs. 0 for no group. An example of a group is a ship with escorts and the escorts.
hasHostileTarget
hasHostileTarget [read-only boolean]
true if the ship’s AI is trying to kill something, false otherwise. Always false for the player.
hasSuspendedAI
hasSuspendedAI [read-only boolean]
true if the ship has suspended AIs, false otherwise.
heatInsulation
heatInsulation [read/write double]
The ship’s heat insulation factor. 1.0 is normal, higher values mean more resistance to heat.
isBeacon
isBeacon [read-only boolean]
true if the ship is a beacon (i.e., can show up on the Advanced Space Compass with a character indicating its identity), false otherwise. (See also: beaconCode)
isCloaked
isCloaked [read/write boolean]
true if the ship has a cloaking device which is currently active false otherwise. If the ship has a cloaking device and sufficient energy to use it, you can activate it by setting isCloaked to true.
isFrangible
isFrangible [read-only boolean]
true if the ship is frangible (i.e., its subentities can be destroyed separately from the main ship), false otherwise. (See also: subEntities)
isJamming
isJamming [read-only boolean]
true if the ship has a military scanner jammer which is currently active false otherwise.
maxCargo
maxCargo [read-only integer]
The ship’s cargo capacity.
maxSpeed
maxSpeed [read-only double]
The ship’s maximum speed under normal power. Note that speed may exceed this when witch fuel injectors or hyperspeed are in use. (See also: speed)
potentialCollider
potentialCollider [read-only Entity]
The entity the ship is currently trying not to crash into, if any.
primaryRole
primaryRole [read/write string]
The main role of the ship; the role for which it was created. For instance, if a ship’s shipdata.plist entry specifies the roles “pirate trader(0.5) escort”, and a ship of that type is spawned to be a trader, its primaryRole is "pirate", its roles is ["escort", "pirate", "trader"] and its roleProbabilities is { "escort":1, "pirate":1, "trader":0.5}.
See also: roles, roleProbabilities.
reportAIMessages
reportAIMessages [read/write boolean]
Debugging facility: set to true to dump information about AI activity to the log.
roleProbabilities
roles [read-only object]
The probabilities for each role in roles. Example:
this.pirateProb = ship.roleProbabilities["pirate"]
See also: primaryRole, roles.
roles
roles [read-only array]
The roles of the ship. This consists of the roles specified in the ship’s shipdata.plist entry, as well as the primaryRole if it is not among those.
See also: primaryRole, roleProbabilities.
scannerRange
scannerRange [read-only double]
The range of the ship’s scanner.
script
script [read-only Script]
The ship’s script.
speed
speed [read-only double]
The ship’s current speed. (See also: maxSpeed)
shipDescription
shipDescription [read-only string]
The name of the ship type (name key in shipdata.plist).
subEntities
subEntities [read-only array of Ships]
The ships subentities, or null if it has none. Special subentities such as flashers and exhaust plumes are not included. (See also: isFrangible)
target
target [read/write Oolite/Development/Scripting/Class/Ship|Ship]
The ship’s primary target, i.e. the entity it will attempt to shoot at. This value is automatically co-ordinated between a ship and its subentities.
temperature
temperature [read/write double]
The ship’s temperature, normalized such that a temperature of 1.0 is the level at which a ship starts taking heat damage.
weaponRange
weaponRange [read-only double]
The maximum range of the ship’s primary weapon.
withinStationAegis
withinStationAegis [read-only boolean]
true if the ship is within the aegis of the system’s main station (i.e., no more than 51 200 game metres from the station, or twice scanner range).
Methods
deployEscorts
deployEscorts()
Launch the ship’s escorts, if any.
dockEscorts
dockEscorts()
Dock the ship’s deployed escorts, if any.
exitAI
exitAI()
Exit the current AI, restoring the previous one. Equivalent to the exitAI: AI method. May not be used on player. Will generate a warning if there are no suspended AI states. (See also: AI, setAI(), hasSuspendedAI)
reactToAIMessage
reactToAIMessage(AIState)
Immediately execute the ship’s AI in the specified state.
setAI
setAI(AIName)
Set the current AI, leaving the old one suspended. Equivalent to the setAITo: AI method. May not be used on player. (See also: AI, switchAI(), exitAI())
switchAI
void switchAI(AIName)
Set the current AI, exiting the old one. Equivalent to the switchAITo: AI method. May not be used on player. (See also: AI, setAI(), exitAI())
