Oolite JavaScript Reference: EquipmentInfo
Prototype: Object
This class was added in Oolite test release 1.72.
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 Equipment Expressions
- 2 Properties
- 2.1 description
- 2.2 effectiveTechLevel
- 2.3 equipmentKey
- 2.4 incompatibleEquipment
- 2.5 isAvailableToAll
- 2.6 isExternalStore
- 2.7 isPortableBetweenShips
- 2.8 name
- 2.9 price
- 2.10 requiredCargoSpace
- 2.11 requiresAnyEquipment
- 2.12 requiresCleanLegalRecord
- 2.13 requiresEmptyPylon
- 2.14 requiresEquipment
- 2.15 requiresFreePassengerBerth
- 2.16 requiresFullFuel
- 2.17 requiresMountedPylon
- 2.18 requiresNonCleanLegalRecord
- 2.19 requiresNonFullFuel
- 2.20 scriptInfo
- 2.21 techLevel
- 3 Static methods
Equipment Expressions
Many methods can take either an EquipmentInfo or an equipment key. For instance, ship.hasEquipment("EQ_ECM") is equivalent to ship.hasEquipment(EquipmentInfo.infoForKey("EQ_ECM")). In specifications, this is represented by arguments typed equipmentInfoExpression.
Prior to Oolite 1.74, such methods would only accept equipment keys.
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.
Starting with 1.74: Setting "effectiveTechLevel = null", will remove the corresponding TL_FOR_EQ_WHATEVER mission variable.
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)
This is the value as used in the equipment.plist. Divide this by ten for the real value in credits.
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
scriptInfo
scriptInfo : Object (read-only)
The contents of the script_info key in the equipments’s equipment.plist entry, if any. This may be any property list object, but the reccomended approach is to use a dictionary whose keys have a unique prefix (such as you should be using for file names, ship names etc.). A property list dictionary is converted to a JavaScript object with properties corresponding to the dictionary’s keys. All other property list types used with Oolite have directly corresponding JavaScript types.
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");
