Oolite JavaScript Reference: EquipmentInfo - Revision history

Phkb at 22:50, 1 May 2019

2019-05-01T22:50:48Z

2017-12-04T23:36:40Z

2017-12-04T23:35:08Z

2017-08-03T20:35:20Z

2013-10-20T20:00:58Z

New equipment properties

2013-03-30T21:13:59Z

There's no such word as “its'”.

2013-02-11T15:23:00Z

‎infoForKey: (new section) See also: Equipment.plist

2012-05-15T17:55:03Z

‎Properties: damageProbability

2012-05-10T22:06:21Z

‎isAvailableToNPCs: typo

2012-05-10T07:34:08Z

isAvailableToAll : added npc info.

@@ Line 9: / Line 9: @@
 == Properties ==
 === <code>canBeDamaged</code> ===
  '''canBeDamaged''' : Boolean (read-only)

@@ Line 91: / Line 91: @@
 === <code>provides</code> ===
  '''provides''' : Array (read-only)
 Returns an array of equipment keys which define the function(s) this equipment is providing to the ship, as defined in the <code>provides</code> element in [[equipment.plist]].

@@ Line 89: / Line 89: @@
  '''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.
 === <code>requiredCargoSpace</code> ===

@@ Line 25: / Line 25: @@
  '''description''' : String (read-only)
 A short description of the equipment, as seen on the Ship Outfitting screen.
 === <code>effectiveTechLevel</code> ===

@@ Line 36: / Line 36: @@
  '''equipmentKey''' : String (read-only)
 The equipment key for the equipment described by this <code>EquipmentInfo</code> object. For EQ_MISSILE, this is "EQ_MISSILE".
 === <code>incompatibleEquipment</code> ===

@@ Line 20: / Line 20: @@
 {{oolite-prop-added|1.77}}
  '''damageProbability''' : Number (read-only nonnegative)
-The relative probability of this item of equipment being damaged, as specified by the <code>damage_probability</code> key in [[equipment.plist]]. This is always zero for mines and missiles, and defaults to one for other equipment. The chance of a particular piece of equipment being damaged is its' damageProbability divided by the total damageProbability of all remaining undamaged equipment.
+The relative probability of this item of equipment being damaged, as specified by the <code>damage_probability</code> key in [[equipment.plist]]. This is always zero for mines and missiles, and defaults to one for other equipment. The chance of a particular piece of equipment being damaged is its damageProbability divided by the total damageProbability of all remaining undamaged equipment.
 === <code>description</code> ===
@@ Line 57: / Line 57: @@
 === <code>isExternalStore</code> ===
  '''isExternalStore''' : Boolean (read-only)
-<code>true</code> for _MISSILE and _MINE equipment types.
+The value of the <code>is_external_store</code> equipment.plist key, if specified; otherwise, <code>true</code> for _MISSILE and _MINE equipment types, and <code>false</code> for others.
 === <code>isPortableBetweenShips</code> ===

← Older revision		Revision as of 15:23, 11 February 2013
Line 151:		Line 151:

	[[Category:Oolite JavaScript Reference]]		[[Category:Oolite JavaScript Reference]]
		+
		+	==See also==
		+	* [[Equipment.plist]]

@@ Line 16: / Line 16: @@
  '''canCarryMultiple''' : Boolean (read-only)
 <code>true</code> if multiple instances of the equipment type can be used at once, <code>false</code> otherwise. Currently, this is hard-coded to trumbles, passenger berths and external stores.
 === <code>description</code> ===

@@ Line 44: / Line 44: @@
 === <code>isAvailableToNPCs</code> ===
  '''isAvailableToNPCs''' : Boolean (read-only)
-<code>true</code> if the equipment type can be used by non-player ships (<code>available_to_player</code> in [[equipment.plist]], default <code>true</code>).
+<code>true</code> if the equipment type can be used by non-player ships (<code>available_to_NPCs</code> in [[equipment.plist]], default <code>true</code>).
 === <code>isAvailableToPlayer</code> ===

@@ Line 40: / Line 40: @@
 === <code>isAvailableToAll</code> ===
  '''isAvailableToAll''' : Boolean (read-only)
-<code>true</code> if the equipment type can be used with any ship, regardless of its shipyard settings.
+<code>true</code> if the equipment type can be used with any ship, regardless of its shipyard settings. It only has effect on player ships. npc ships always can have it, unless they are explicit excluded with the <code>isAvailableToNPCs</code> key.
 === <code>isAvailableToNPCs</code> ===