Oolite JavaScript Reference: Manifest - Revision history

Massively Locked: /* Behaviour notes */ updated link

2022-10-23T19:49:47Z

‎Behaviour notes: updated link

2022-10-21T21:59:15Z

‎shortComment: reworded

2022-10-21T21:57:13Z

‎setShortComment: fixed syntax, reworded

2022-10-21T21:54:57Z

‎comment: reworded

2022-10-21T21:52:03Z

‎setComment: fixed syntax, reworded

2022-09-17T19:44:05Z

‎Behaviour notes: fixed link

2022-09-15T17:38:52Z

‎Methods: Corrected according to Massively Locked's suggestion

2020-06-16T18:07:43Z

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

2014-09-13T11:10:59Z

1.81 changes

2014-08-24T14:05:56Z

‎Properties: Canonical names of properties

@@ Line 12: / Line 12: @@
 Example:
-  if (player.ship.[[Oolite JavaScript Reference: PlayerShip#cargoSpaceAvailable|cargoSpaceAvailable]] >= 10)
+  if (player.ship.[[Oolite JavaScript Reference: Ship#cargoSpaceAvailable|cargoSpaceAvailable]] >= 10)
+  {
       player.ship.manifest.food += 10;

@@ Line 156: / Line 156: @@
 {{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.
+Returns the current short text comment for the named commodity as shown on the market (F8) screen.

@@ Line 150: / Line 150: @@
 === setShortComment ===
 {{oolite-method-added|1.81}}
-  function '''setShortComment'''(commodity : String, value : String) : String
+  function '''setShortComment'''(commodity : String, comment : String) : Boolean
-Set the short text comment for the named commodity, shown in the optional column on the F8 screen.
+Sets a short text comment for the named commodity as shown on the market (F8) screen.  Returns <code>false</code> on failure such as specifying an unrecognized commodity.
 === shortComment ===

@@ Line 141: / Line 141: @@
 {{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.
+Returns the current long text comment for the named commodity as shown on the individual commodity (F8F8) screen.
 === setComment ===

@@ Line 145: / Line 145: @@
 === setComment ===
 {{oolite-method-added|1.81}}
-  function '''setComment'''(commodity : String, value : String) : String
+  function '''setComment'''(commodity : String, comment : String) : Boolean
-Set the long text comment for the named commodity, shown on the F8 F8 screen.
+Sets a long text comment for the named commodity as shown on the individual commodity (F8F8) screen.  Returns <code>false</code> on failure such as specifying an unrecognized commodity.
 === setShortComment ===

@@ 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> ===

@@ Line 125: / Line 125: @@
   	manifest[c] = Math.floor(manifest[c] * 0.8);
+  }
 [[Category:Oolite JavaScript Reference]]

@@ 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.