Oolite JavaScript Reference: EquipmentInfo - Revision history

Phkb at 00:27, 14 December 2023

2023-12-14T00:27:27Z

Phkb at 00:26, 14 December 2023

2023-12-14T00:26:01Z

Massively Locked: /* Properties */ uniform string format (x2)

2022-10-30T17:49:38Z

‎Properties: uniform string format (x2)

Massively Locked: /* Properties */ uniform boolean format (x2)

2022-10-27T00:56:31Z

‎Properties: uniform boolean format (x2)

Massively Locked: /* displayColor */ uniform null format

2022-10-18T00:20:20Z

‎displayColor: uniform null format

Massively Locked: /* techLevel */ closed bold

2022-10-04T14:53:03Z

‎techLevel: closed bold

Massively Locked: /* effectiveTechLevel */ closed bold

2022-10-04T14:51:09Z

‎effectiveTechLevel: closed bold

Massively Locked: /* displayColor */ cleared up wording, added link

2022-10-04T14:49:42Z

‎displayColor: cleared up wording, added link

Massively Locked: uniform screen names

2022-10-01T16:48:25Z

uniform screen names

Massively Locked: /* effectiveTechLevel */ deleted self-ref links

2022-10-01T16:11:48Z

‎effectiveTechLevel: deleted self-ref links

@@ Line 168: / Line 168: @@
 {{oolite-prop-added|1.91}}
   '''weaponInfo''' : Object (read-only)
-Provides access to the <code>[[https://wiki.alioth.net/index.php/Equipment.plist#Creating_laser_weapons|weapon_info]]</code> section of the equipment item (if defined).
+Provides access to the <code>weapon_info</code> section of the equipment item (if defined).
 == Static properties ==

← Older revision		Revision as of 00:26, 14 December 2023
Line 164:		Line 164:

	'''See also:''' <code>[[#effectiveTechLevel\|effectiveTechLevel]]</code>		'''See also:''' <code>[[#effectiveTechLevel\|effectiveTechLevel]]</code>
		+
		+	=== <code>weaponInfo</code> ===
		+	{{oolite-prop-added\|1.91}}
		+	'''weaponInfo''' : Object (read-only)
		+	Provides access to the <code>[[https://wiki.alioth.net/index.php/Equipment.plist#Creating_laser_weapons\|weapon_info]]</code> section of the equipment item (if defined).

	== Static properties ==		== Static properties ==

@@ Line 45: / Line 45: @@
 === <code>equipmentKey</code> ===
   '''equipmentKey''' : String (read-only)
-The equipment key for the equipment described by this <code>EquipmentInfo</code> object. For EQ_MISSILE, this is "EQ_MISSILE".
+The equipment key for the equipment described by this <code>EquipmentInfo</code> object. For EQ_MISSILE, this is <code>"EQ_MISSILE"</code>.
 === <code>fastAffinityDefensive</code> ===
@@ Line 89: / Line 89: @@
 === <code>name</code> ===
   '''name''' : String (read-only)
-The display name for the equipment described by this <code>EquipmentInfo</code> object. This string is localized. For EQ_MISSILE in English, this is "Missile".
+The display name for the equipment described by this <code>EquipmentInfo</code> object. This string is localized. For EQ_MISSILE in English, this is <code>"Missile"</code>.
 === <code>price</code> ===

@@ Line 117: / Line 117: @@
 === <code>requiresEmptyPylon</code> ===
   '''requiresEmptyPylon''' : Boolean (read-only)
-True for equipment that requires at least one pylon to have nothing on it.
+<code>true</code> for equipment that requires at least one pylon to have nothing on it.
 '''See also:''' <code>[[#requiresMountedPylon|requiresMountedPylon]]</code>
@@ Line 137: / Line 137: @@
 === <code>requiresMountedPylon</code> ===
   '''requiresMountedPylon''' : Boolean (read-only)
-True for equipment that requires at least one pylon to have a store (missile, mine or equipment) on it.
+<code>true</code> for equipment that requires at least one pylon to have a store (missile, mine or equipment) on it.
 '''See also:''' <code>[[#requiresEmptyPylon|requiresEmptyPylon]]</code>

@@ Line 34: / Line 34: @@
 {{oolite-prop-added|1.85}}
   '''displayColor''' : Color (read/write)
-Gets and sets the color to be used for this item on the Outfitting (F3) and Status (F5) screens. Any valid [[Materials in Oolite#Colour specifiers|color specifier]] can be used. Setting a value of null will reset the color to use the default.
+Gets and sets the color to be used for this item on the Outfitting (F3) and Status (F5) screens. Any valid [[Materials in Oolite#Colour specifiers|color specifier]] can be used. Setting a value of <code>null</code> will reset the color to use the default.
 === <code>effectiveTechLevel</code> ===

@@ Line 163: / Line 163: @@
 The raw tech level required to purchase this item. Unlike <code>[[#effectiveTechLevel|effectiveTechLevel]]</code>, this does not take the special meaning of 99 and <code>TL_FOR_EQ_WHATEVER</code> mission variables into account.
-'''See also: <code>[[#effectiveTechLevel|effectiveTechLevel]]</code>
+'''See also:''' <code>[[#effectiveTechLevel|effectiveTechLevel]]</code>
 == Static properties ==

@@ Line 41: / Line 41: @@
 Setting <code>effectiveTechLevel</code> to <code>null</code>, will remove the corresponding <code>TL_FOR_EQ_WHATEVER</code> mission variable.
-'''See also: <code>[[#techLevel|techLevel]]</code>
+'''See also:''' <code>[[#techLevel|techLevel]]</code>
 === <code>equipmentKey</code> ===

@@ Line 29: / Line 29: @@
 === <code>description</code> ===
   '''description''' : String (read-only)
-A short description of the equipment, as seen on the Ship Outfitting screen.
+A short description of the equipment, as seen on the Outfitting (F3) screen.
 === <code>displayColor</code> ===
 {{oolite-prop-added|1.85}}
   '''displayColor''' : Color (read/write)
-Gets and sets the color to be used for this item on the F3 Equip Ship screen, as well as the F5 Status screen. Any valid color specifier can be used. Setting a value of null will reset the color to use the default.
+Gets and sets the color to be used for this item on the Outfitting (F3) screen, as well as the Status (F5) screen. Any valid color specifier can be used. Setting a value of null will reset the color to use the default.
 === <code>effectiveTechLevel</code> ===
@@ Line 85: / Line 85: @@
 === <code>isVisible</code> ===
   '''isVisible''' : Boolean (read-only)
-<code>true</code> if the equipment type is visible on the ship info screen (<code>visible</code> in [[equipment.plist]], default: <code>true</code>).
+<code>true</code> if the equipment type is visible on the Status (F5) screen (<code>visible</code> in [[equipment.plist]], default: <code>true</code>).
 === <code>name</code> ===
@@ Line 102: / Line 102: @@
 === <code>requiredCargoSpace</code> ===
   '''requiredCargoSpace''' : Number (read-only nonnegative integer)
-Until Oolite 1.76, this was only used to decide '''if''' an item could be displayed on the equipment screen. Starting with 1.77, this key will actually ensure that the equipment uses cargo space when installed.
+Until Oolite 1.76, this was only used to decide '''if''' an item could be displayed on the Outfitting (F3) screen. Starting with 1.77, this key will actually ensure that the equipment uses cargo space when installed.
 === <code>requiresAnyEquipment</code> ===

@@ Line 38: / Line 38: @@
 === <code>effectiveTechLevel</code> ===
   '''effectiveTechLevel''' : Number (read/write nonnegative integer)
-The effective tech level required to purchase this item. Unlike <code>[[#techLevel|techLevel]]</code>, this takes the special meaning of 99 and <code>TL_FOR_EQ_WHATEVER</code> mission variables into account. If the raw tech level is 99, changing the value of <code>[[#effectiveTechLevel|effectiveTechLevel]]</code> is equivalent to setting the appropriate <code>TL_FOR_EQ_WHATEVER</code> mission variable. If the raw tech level is not 99, changes to <code>[[#effectiveTechLevel|effectiveTechLevel]]</code> are ignored.<br>
+The effective tech level required to purchase this item. Unlike <code>[[#techLevel|techLevel]]</code>, this takes the special meaning of 99 and <code>TL_FOR_EQ_WHATEVER</code> mission variables into account. If the raw tech level is 99, changing the value of <code>effectiveTechLevel</code> is equivalent to setting the appropriate <code>TL_FOR_EQ_WHATEVER</code> mission variable. If the raw tech level is not 99, changes to <code>effectiveTechLevel</code> are ignored.<br>
 Setting <code>effectiveTechLevel</code> to <code>null</code>, will remove the corresponding <code>TL_FOR_EQ_WHATEVER</code> mission variable.