Difference between revisions of "Oolite JavaScript Reference: EquipmentInfo"
(→Properties) |
|||
| Line 103: | Line 103: | ||
function '''infoForKey'''(equipmentKey : String) : EquipmentInfo | function '''infoForKey'''(equipmentKey : String) : EquipmentInfo | ||
Returns the equipment info object for a given type of equipment, or <code>null</code> for an unrecognised key. Example: <code>var missileInfo = EquipmentInfo.infoForKey("EQ_MISSILE");</code> | Returns the equipment info object for a given type of equipment, or <code>null</code> for an unrecognised key. Example: <code>var missileInfo = EquipmentInfo.infoForKey("EQ_MISSILE");</code> | ||
| + | |||
| + | [[Category:Oolite scripting]] | ||
Revision as of 23:03, 17 October 2008
Prototype: Object
EquipmentInfo objects provide information about a type of equipment. To acquire an EquipmentInfo object, use the infoForKey() method, as in:
var missileInfo = EquipmentInfo.infoForKey("EQ_MISSILE");
Contents
- 1 Properties
- 1.1 description
- 1.2 effectiveTechLevel
- 1.3 equipmentKey
- 1.4 incompatibleEquipment
- 1.5 isAvailableToAll
- 1.6 isExternalStore
- 1.7 isPortableBetweenShips
- 1.8 name
- 1.9 price
- 1.10 requiredCargoSpace
- 1.11 requiresAnyEquipment
- 1.12 requiresCleanLegalRecord
- 1.13 requiresEmptyPylon
- 1.14 requiresEquipment
- 1.15 requiresFreePassengerBerth
- 1.16 requiresFullFuel
- 1.17 requiresMountedPylon
- 1.18 requiresNonCleanLegalRecord
- 1.19 requiresNonFullFuel
- 1.20 techLevel
- 2 Static methods
Properties
description
description : String (read-only)
A short description of the equipment, as seen on the Ship Outfitting screen.
effectiveTechLevel
effectiveTechLevel : Number (read/write nonnegative integer)
The effective tech level required to purchase this item. Unlike techLevel, this takes the special meaning of 99 and TL_FOR_EQ_WHATEVER mission variables into account. If the raw tech level is 99, changing the value of effectiveTechLevel is equivalent to setting the appropriate TL_FOR_EQ_WHATEVER mission variable. If the raw tech level is not 99, changes to effectiveTechLevel are ignored.
See also: techLevel
equipmentKey
equipmentKey : String (read-only)
The equipment key for the equipment described by this EquipmentInfo object. For EQ_MISSILE, this is "EQ_MISSILE".
incompatibleEquipment
incompatibleEquipment : Array (read-only)
An array of equipment keys (in arbitrary order). In order to be installed, no item in this array may already be installed.
See also: requiresAnyEquipment, requiresEquipment
isAvailableToAll
isAvailableToAll : Boolean (read-only)
isExternalStore
isExternalStore : Boolean (read-only)
True for _MISSILE and _MINE equipment types.
isPortableBetweenShips
isPortableBetweenShips : Boolean (read-only)
name
name : String (read-only)
The display name for the equipment described by this EquipmentInfo object. This string is localized. For EQ_MISSILE in English, this is "Missile".
price
price : Number (read-only nonnegative integer)
requiredCargoSpace
requiredCargoSpace : Number (read-only nonnegative integer)
requiresAnyEquipment
requiresAnyEquipment : Array (read-only)
An array of equipment keys (in arbitrary order). In order to be installed, at least one item in this array must already be installed.
See also: incompatibleEquipment, requiresEquipment
requiresCleanLegalRecord
requiresCleanLegalRecord : Boolean (read-only)
See also: requiresNonCleanLegalRecord
requiresEmptyPylon
requiresEmptyPylon : Boolean (read-only)
True for equipment that requires at least one pylon to have nothing on it.
See also: requiresMountedPylon
requiresEquipment
requiresEquipment : Array (read-only)
An array of equipment keys (in arbitrary order). In order to be installed, all items in this array must already be installed.
See also: incompatibleEquipment, requiresAnyEquipment
requiresFreePassengerBerth
requiresFreePassengerBerth : Boolean (read-only)
requiresFullFuel
requiresFullFuel : Boolean (read-only)
See also: requiresNonFullFuel
requiresMountedPylon
requiresMountedPylon : Boolean (read-only)
True for equipment that requires at least one pylon to have a store (missile, mine or equipment) on it.
See also: requiresEmptyPylon
requiresNonCleanLegalRecord
requiresNonCleanLegalRecord : Boolean (read-only)
See also: requiresCleanLegalRecord
requiresNonFullFuel
requiresNonFullFuel : Boolean (read-only)
See also: requiresFullFuel
techLevel
techLevel : Number (read-only nonnegative integer)
The raw tech level required to purchase this item. Unlike effectiveTechLevel, this does not take the special meaning of 99 and TL_FOR_EQ_WHATEVER mission variables into account.
See also: effectiveTechLevel
Static methods
infoForKey
function infoForKey(equipmentKey : String) : EquipmentInfo
Returns the equipment info object for a given type of equipment, or null for an unrecognised key. Example: var missileInfo = EquipmentInfo.infoForKey("EQ_MISSILE");
