Oolite JavaScript Reference: Manifest - Revision history

Milo: added notes about pre-1.82 aliases for liquor_wines, gem_stones and alien_items

2020-06-16T18:07:43Z

added notes about pre-1.82 aliases for liquor_wines, gem_stones and alien_items

Cim: 1.81 changes

2014-09-13T11:10:59Z

1.81 changes

Cim: /* Properties */ Canonical names of properties

2014-08-24T14:05:56Z

‎Properties: Canonical names of properties

Phasted: /* Behaviour notes */

2014-07-07T07:27:31Z

‎Behaviour notes

Cim: /* list */ 1.79 changes

2014-06-03T18:54:31Z

‎list: 1.79 changes

Ahruman: Update for 1.75.

2011-02-20T11:35:27Z

Update for 1.75.

Ahruman: Fixed dangling small

2010-06-28T08:40:50Z

Fixed dangling small

Ahruman: Undocumenting plusungood unrec nonforms p.p. MINITRUE

2010-06-19T19:40:48Z

Undocumenting plusungood unrec nonforms p.p. MINITRUE

Ahruman: Moving Oolite JS reference into a correctly-named subcategory of Oolite scripting.

2010-06-19T14:03:33Z

Moving Oolite JS reference into a *correctly-named* subcategory of Oolite scripting.

Ahruman: Moving Oolite JS reference into a subcategory of Oolite scripting.

2010-06-19T13:54:17Z

Moving Oolite JS reference into a subcategory of Oolite scripting.

@@ Line 48: / Line 48: @@
  '''liquor_wines''' : Number (read/write integer)
 The quantity of liquor/wines in the ship’s hold (t).
 === <code>luxuries</code> ===
@@ Line 88: / Line 90: @@
  '''gem_stones''' : Number (read/write integer)
 The quantity of gem-stones in the ship’s hold. 500000 g and more counts as 1 ton in [[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargoSpace]] calculations.
 === <code>alien_items</code> ===
  '''alien_items''' : Number (read/write integer)
 The quantity of alien items in the ship’s hold.
 === <code>list</code> ===

← Older revision		Revision as of 11:10, 13 September 2014
Line 125:		Line 125:
	manifest[c] = Math.floor(manifest[c] * 0.8);		manifest[c] = Math.floor(manifest[c] * 0.8);
	}		}
		+
		+	=== Extra properties ===
		+
		+	If an OXP defines a new trade good with key "xxx" then <code>manifest.xxx</code> will work for that good as it does for the built-in trade goods.
		+
		+	== Methods ==
		+
		+	=== comment ===
		+	{{oolite-method-added\|1.81}}
		+	function '''comment'''(commodity : String) : String
		+	Return the current long text comment for the named commodity, shown on the F8 F8 screen.
		+
		+	=== setComment ===
		+	{{oolite-method-added\|1.81}}
		+	function '''comment'''(commodity : String, value : String) : String
		+	Set the long text comment for the named commodity, shown on the F8 F8 screen.
		+
		+	=== setShortComment ===
		+	{{oolite-method-added\|1.81}}
		+	function '''comment'''(commodity : String, value : String) : String
		+	Set the short text comment for the named commodity, shown in the optional column on the F8 screen.
		+
		+	=== shortComment ===
		+	{{oolite-method-added\|1.81}}
		+	function '''shortComment'''(commodity : String) : String
		+	Return the current short text comment for the named commodity, shown in the optional column on the F8 screen.
		+
		+
		+

@@ Line 45: / Line 45: @@
 The quantity of slaves in the ship’s hold (t).
-=== <code>liquorWines</code> ===
+=== <code>liquor_wines</code> ===
- '''liquorWines''' : Number (read/write integer)
+ '''liquor_wines''' : Number (read/write integer)
 The quantity of liquor/wines in the ship’s hold (t).
@@ Line 85: / Line 85: @@
 The quantity of platinum in the ship’s hold (kg).
-=== <code>gemStones</code> ===
+=== <code>gem_stones</code> ===
- '''gemStones''' : Number (read/write integer)
+ '''gem_stones''' : Number (read/write integer)
 The quantity of gem-stones in the ship’s hold. 500000 g and more counts as 1 ton in [[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargoSpace]] calculations.
-=== <code>alienItems</code> ===
+=== <code>alien_items</code> ===
- '''alienItems''' : Number (read/write integer)
+ '''alien_items''' : Number (read/write integer)
 The quantity of alien items in the ship’s hold.

@@ Line 9: / Line 9: @@
 When increasing a commodity, extra cargo beyond the ship’s capacity is discarded silently. For example, if the ship has 6 t of space available, and you add 10 to <code>player.ship.manifest.food</code>, only 6 t of food will be awarded.
-For gold an platinum, 500 kg and more rounds up to 1 t, below 500 kg counts as 0 t in [[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargo space]] calculations. This means a script can add up to 499 kg of gold or platinum into a nominally full hold. (The player himself can buy unlimited quantities at the market screen.) In the same way, 500 000 g of gemstones is rounded up to 1 t. (If you feel tempted to award the player half a tonne of gemstones, keep in mind that one can only sell up to 127 units of a commodity at a given station using the trading screen.)
+For gold and platinum, 500 kg or more rounds up to 1 t, below 500 kg counts as 0 t in [[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargo space]] calculations. This means a script can add up to 499 kg of gold or platinum into a nominally full hold. (The player himself can buy unlimited quantities at the market screen.) In the same way, 500 000 g of gemstones is rounded up to 1 t. (If you feel tempted to award the player half a tonne of gemstones, keep in mind that one can only sell up to 127 units of a commodity at a given station using the trading screen.)
 Example:
@@ Line 16: / Line 16: @@
      player.ship.manifest.food += 10;
+ }
 === Cargo marshalling ===
 When a player launches, all cargo from the manifest is loaded in cargo pods with the role “1t-cargopod”. This has some consequences for handling g and kg commodities when in flight:

@@ Line 97: / Line 97: @@
 Array of objects. Each object contains information for a commodity present in the player’s hold:
  commodity : String (the name of the corresponding property)
  quantity : Number (integer)
  displayName : String (commodity display name, can be different for different languages)
  unit : String (“t”, “kg” or “g”)
 '''Examples:'''

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
 <small>'''Subtypes:''' none</small>
 '''<code>Manifest</code>''' provides direct access to the cargo carried by the player.
@@ Line 11: / Line 9: @@
 When increasing a commodity, extra cargo beyond the ship’s capacity is discarded silently. For example, if the ship has 6 t of space available, and you add 10 to <code>player.ship.manifest.food</code>, only 6 t of food will be awarded.
-For gold an platinum, 500 kg and more rounds up to 1 t, below 500 kg counts as 0 t in [[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargo space]] calculations. This means as script can add up to 499 kg of gold or platinum into a nominally full hold. (The player himself can buy unlimited quantities at the market screen.) In the same way, 500 000 g of gemstones is rounded up to 1 t. (If you feel tempted to award the player half a tonne of gemstones, keep in mind that one can only sell up to 127 units of a commodity at a given station using the trading screen.)
+For gold an platinum, 500 kg and more rounds up to 1 t, below 500 kg counts as 0 t in [[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargo space]] calculations. This means a script can add up to 499 kg of gold or platinum into a nominally full hold. (The player himself can buy unlimited quantities at the market screen.) In the same way, 500 000 g of gemstones is rounded up to 1 t. (If you feel tempted to award the player half a tonne of gemstones, keep in mind that one can only sell up to 127 units of a commodity at a given station using the trading screen.)
 Example:

← Older revision		Revision as of 14:03, 19 June 2010
Line 134:		Line 134:


−	[[Category:Oolite JavaScript ~~reference~~]]	+	[[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 13:54, 19 June 2010
Line 134:		Line 134:


−	[[Category:Oolite ~~scripting~~]]	+	[[Category:Oolite JavaScript reference]]