Difference between revisions of "Oolite JavaScript Reference: Ship"
m (→Properties: Noted that AI switching is disallowed for player.) |
m (Moving draft scripting documentation to separate category.) |
||
| Line 41: | Line 41: | ||
void switchAI(AIName); | void switchAI(AIName); | ||
Set the current AI, exiting the old one. Equivalent to the <code>[[AI_methods|switchAITo]]:</code> AI method. May not be used on player. | Set the current AI, exiting the old one. Equivalent to the <code>[[AI_methods|switchAITo]]:</code> AI method. May not be used on player. | ||
| − | |||
| − | |||
| − | |||
Revision as of 14:34, 3 August 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
Properties
shipDescription
shipDescription [read-only string]
The name of the ship type (name key in shipdata.plist).
roles
roles [read-only array]
The roles of the ship. Probabilities are not included.
AI
AI [read-only string]
The name of the ship’s current AI. (See also: AIState, setAI(), switchAI())
AIState
AIState [read-write string, read-only for player]
The ship’s AI’s current state. (See also: AI, setAI(), switchAI())
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)
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.
Properties
setAI
void setAI(AIName);
Set the current AI, leaving the old one suspended. Equivalent to the setAITo: AI method. May not be used on player.
switchAI
void switchAI(AIName);
Set the current AI, exiting the old one. Equivalent to the switchAITo: AI method. May not be used on player.
