Oolite JavaScript Reference: SystemInfo - Revision history

Hiran at 20:26, 18 June 2021

2021-06-18T20:26:25Z

2018-11-15T23:24:50Z

‎setProperty

2015-07-04T19:36:50Z

1.82 change

2015-03-08T15:11:10Z

‎setInterstellarProperty

2015-03-07T15:33:29Z

‎Static methods: setInterstellarProperty

2015-02-24T18:07:36Z

‎setProperty: Document 1.81

2014-09-13T11:03:16Z

‎Methods: samplePrice

2013-07-13T13:33:39Z

‎systemsInRange: SystemInfo.systemsInRange is not encouraged

2012-12-22T13:04:33Z

‎routeToSystem: note bug

2012-01-20T11:54:58Z

Removed outdated beta stuff.

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
-'''<code>SystemInfo</code>''' objects provide information about a specific system. <code>SystemInfo</code>s can be retrieved for any system in any galaxy as of version 1.82. In previous versions, only systems for the current galaxy could be read.
+'''<code>SystemInfo</code>''' objects provide information about a specific star system. <code>SystemInfo</code>s can be retrieved for any system in any galaxy as of version 1.82. In previous versions, only systems for the current galaxy could be read.
 In interstellar space, <code>system.info</code> refers to a temporary <code>SystemInfo</code> object whose properties cannot be written to. Attempting to read properties of such a temporary <code>SystemInfo</code> after leaving interstellar space will raise an exception.

@@ Line 70: / Line 70: @@
 === <code>setProperty</code> ===
 {{oolite-method-added|1.81}}
- function '''setProperty'''(key : String, value: String, layer: Number [, manifest: String])
+ function '''setProperty'''(layer: Number, key : String, value: String [, manifest: String])
 This lets you set properties with more control than provided by writing directly to <code>systemInfo.property</code>. <code>layer</code> is the layer from 0 to 3 that the change should be applied at, as in [[planetinfo.plist]]. Layer 2 is the default layer for Javascript-initiated changes, but 3 may be used for changes absolutely crucial for OXP functionality.

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
-'''<code>SystemInfo</code>''' objects provide information about a specific system. <code>SystemInfo</code>s can be retrieved for any system in the current galaxy, but not systems in other galaxies. If you keep a reference to a <code>SystemInfo</code> object after the player goes to a different galaxy, attempts to read properties of the stored <code>SystemInfo</code> will cause an exception.
+'''<code>SystemInfo</code>''' objects provide information about a specific system. <code>SystemInfo</code>s can be retrieved for any system in any galaxy as of version 1.82. In previous versions, only systems for the current galaxy could be read.
 In interstellar space, <code>system.info</code> refers to a temporary <code>SystemInfo</code> object whose properties cannot be written to. Attempting to read properties of such a temporary <code>SystemInfo</code> after leaving interstellar space will raise an exception.

@@ Line 107: / Line 107: @@
 === <code>setInterstellarProperty</code> ===
 {{oolite-method-added|1.81}}
- function '''setInterstellarProperty'''(galaxy : Number, fromsystem : Number, tosystem : Number, key : String, value: String, layer: Number [, manifest: String])
+ function '''setInterstellarProperty'''(galaxy : Number, fromsystem : Number, tosystem : Number, layer: Number, key : String, value: String, [, manifest: String])
 This is similar to [[#setProperty|setProperty]] but for setting properties of interstellar space regions. Changes made to the current interstellar space region will only take effect if the player leaves and returns.

@@ Line 104: / Line 104: @@
     });
+ }
 [[Category:Oolite JavaScript Reference]]

@@ Line 67: / Line 67: @@
  function '''samplePrice'''(commodity : String) : Array
 Return a sample main market price in decicredits for the commodity with that key in this system. As this requires reading system information, it will only work for systems in the current galaxy. There is of course no guarantee that the price returned by this function will be anywhere near the actual price when the system is next entered.
 === <code>systemsInRange</code> ===

← Older revision		Revision as of 11:03, 13 September 2014
Line 62:		Line 62:

	Warning: in version 1.76 or earlier there is a bug in this method which may cause a crash if either the start or end of the route is in interstellar space (i.e. system ID -1). In later versions this simply returns null.		Warning: in version 1.76 or earlier there is a bug in this method which may cause a crash if either the start or end of the route is in interstellar space (i.e. system ID -1). In later versions this simply returns null.
		+
		+	=== <code>samplePrice</code> ===
		+	{{oolite-method-added\|1.81}}
		+	function '''samplePrice'''(commodity : String) : Array
		+	Return a sample main market price in decicredits for the commodity with that key in this system. As this requires reading system information, it will only work for systems in the current galaxy. There is of course no guarantee that the price returned by this function will be anywhere near the actual price when the system is next entered.

	=== <code>systemsInRange</code> ===		=== <code>systemsInRange</code> ===

@@ Line 71: / Line 71: @@
 '''Example:'''
  system.info.systemsInRange(5);
 == Static methods ==

@@ Line 60: / Line 60: @@
 .40  (distance of added jumps)
 .40 (travelled time)
 === <code>systemsInRange</code> ===

@@ Line 21: / Line 21: @@
 === <code>internalCoordinates</code> ===
  '''internalCoordinates''' : {{oojsclass|Vector3D}} (read-only)
 '''Discouraged in favour of <code>[[#coordinates|coordinates]]</code>.'''<br />
@@ Line 79: / Line 78: @@
 '''Example:'''
- // This is the actual implementation of <code>[[#systemsInRange|systemsInRange()]]</code> in 1.75.1.
+ // This is the actual implementation of <code>[[#systemsInRange|systemsInRange()]]</code>.
  SystemInfo.prototype.systemsInRange = function systemsInRange(range)
+ {