Oolite JavaScript Reference: System - Revision history

Hiran at 20:24, 18 June 2021

2021-06-18T20:24:38Z

2018-01-16T00:02:53Z

‎wormholes

2018-01-15T23:25:47Z

‎setWaypoint

2018-01-15T23:25:03Z

‎waypoints

2018-01-03T02:42:30Z

‎ambientLevel

2018-01-03T02:40:20Z

2017-07-19T16:32:29Z

‎infoForSystem

2016-11-01T05:37:55Z

‎addShips: + note about creating ships via shipdatakey

2015-01-12T20:15:04Z

‎setWaypoint: 1.81 note

2014-07-04T16:50:04Z

‎setWaypoint: fix markup

@@ Line 2: / Line 2: @@
 <small>'''Subtypes:''' none</small>
-The '''<code>System</code>''' class represents the current system. There is always one <code>System</code> object, available through the global property <code>system</code>.
+The '''<code>System</code>''' class represents the current star system. There is always one <code>System</code> object, available through the global property <code>system</code>.
 Attempts to change system properties are ignored in interstellar space (i.e., the place you end up in after a witchspace malfunction).

@@ Line 137: / Line 137: @@
 {{oolite-prop-added|1.79}}
  '''wormholes''' : Array (read-only)
-A list of the wormholes in the system.
+A list of the [[Oolite_JavaScript_Reference:_Wormhole|wormholes]] in the system.
 === <code>waypoints</code> ===

@@ Line 274: / Line 274: @@
 {{oolite-method-added|1.79}}
  '''setWaypoint(key : String, position : VectorExpression, orientation : QuaternionExpression, parameters : Object)'''
-Adds a waypoint to the system with the given <code>key</code>, placed at the specified <code>position</code> and <code>orientation</code>. <code>parameter</code> is an object with the following optional keys:
+Adds a [[Oolite_JavaScript_Reference:_Waypoint|waypoint]] to the system with the given <code>key</code>, placed at the specified <code>position</code> and <code>orientation</code>. <code>parameter</code> is an object with the following optional keys:
 * '''size''': the radius of the waypoint in metres
 * '''beaconCode''': the beacon code (default "W")

@@ Line 142: / Line 142: @@
 {{oolite-prop-added|1.79}}
  '''waypoints''' : Array (read-only)
-A dictionary of the waypoints in the system by key and value.
+A dictionary of the [[Oolite_JavaScript_Reference:_Waypoint|waypoints]] in the system by key and value.
 '''See Also:''' <code>[[#setWaypoint|setWaypoint()]]</code>

@@ Line 21: / Line 21: @@
 {{oolite-prop-added|1.81}}
  '''ambientLevel''' : float (read/write)
-Adjusts the level of ambient light in the current system. This is will override the "ambient_level" setting defined in [[Planetinfo.plist]]. The change is not permanent and will be reset when the system is reloaded.
+Adjusts the level of ambient light in the current system. Values should typically be between 0.0 and 1.0 (1.0 is the default) but can be higher for a flat lit, cartoon-like effect. This is will override the "ambient_level" setting defined in [[Planetinfo.plist]]. The change is not permanent and will be reset when the system is reloaded.
 === <code>breakPattern</code> ===

@@ Line 17: / Line 17: @@
  '''allVisualEffects''' : Array (read-only)
 A list of the [[Oolite_JavaScript_Reference:_VisualEffect|visual effects]] in the system.
 === <code>breakPattern</code> ===

@@ Line 305: / Line 305: @@
  System.infoForSystem(0, 55).description
 would return "This is a dull planet." if called from galaxy 0, and throw an exception if called from the other galaxies.
 === <code>systemIDForName</code> ===

← Older revision		Revision as of 05:37, 1 November 2016
Line 171:		Line 171:

	When you want to use coordinates from the legacy "pwp" system you can use the function [[Oolite_JavaScript_Reference:_Vector3D#fromCoordinateSystem\|fromCoordinateSystem]] to convert legacy type coordinates to absolute coordinates.		When you want to use coordinates from the legacy "pwp" system you can use the function [[Oolite_JavaScript_Reference:_Vector3D#fromCoordinateSystem\|fromCoordinateSystem]] to convert legacy type coordinates to absolute coordinates.
		+
		+	If you wish to add ships of a specific shipdata key, pass the key as the "role" parameter, enclosed in square brackets.

	'''See Also:''' <code>[[#addGroup\|addGroup()]]</code>, <code>[[#addShipsToRoute\|addShipsToRoute()]]</code>		'''See Also:''' <code>[[#addGroup\|addGroup()]]</code>, <code>[[#addShipsToRoute\|addShipsToRoute()]]</code>

@@ Line 275: / Line 275: @@
  '''setWaypoint(key : String)'''
 Removes the waypoint with the specified <code>key</code>, if it exists.
 '''See Also:''' <code>[[#waypoints|waypoints]]</code>