Oolite JavaScript Reference: System - Revision history

Phkb: Updating BB links

2024-03-18T13:51:01Z

Updating BB links

Phkb: Updating BB links

2024-02-29T02:19:29Z

Updating BB links

Massively Locked: /* government */ added link

2022-11-11T00:16:59Z

‎government: added link

Massively Locked: /* economy */ added link

2022-11-11T00:15:29Z

‎economy: added link

Massively Locked: /* setPopulator */ uniform null format

2022-10-29T21:02:10Z

‎setPopulator: uniform null format

Massively Locked: replaced "function" (x3)

2022-10-28T18:47:10Z

replaced "function" (x3)

Massively Locked: /* systemIDForName */ uniform string format

2022-10-20T15:54:20Z

‎systemIDForName: uniform string format

Massively Locked: /* infoForSystem */ uniform string format, cleared up wording

2022-10-20T15:48:01Z

‎infoForSystem: uniform string format, cleared up wording

Massively Locked: /* inhabitantsDescription */ uniform string format

2022-10-20T15:36:48Z

‎inhabitantsDescription: uniform string format

Massively Locked: /* governmentDescription */ uniform string format

2022-10-20T15:35:08Z

‎governmentDescription: uniform string format

@@ Line 263: / Line 263: @@
 Returns a number that’s greater than or equal to zero and less than one. It will always return the same value for a given <code>salt</code> value and system. Crucially, the relationship between systems and numbers is effectively completely different for each salt value, so scripts making similar decisions based on <code>scrambledPseudoRandomNumber()</code> but using different salts will get uncorrelated results. For example, if two different OXPs add a certain type of station to 25% of systems using <code>if (system.pseudoRandomNumber < 0.25)</code>, the two station types will always be found in the same system; using <code>scrambledPseudoRandomNumber()</code> with different salts avoids this.
-{{QuoteText|Text=scrambledPseudoRandomNumber, was invented to generate 'random' numbers that are always the same for a given system. Useful to only add stations in certain systems and consistently over time. The salt was added to prevent all oxp's selecting the same 'random' choice for a given system. |Source=([http://oolite.bb.oolite.space/viewtopic.php?p=193483#p193483 Eric Walch])}}
+{{QuoteText|Text=scrambledPseudoRandomNumber, was invented to generate 'random' numbers that are always the same for a given system. Useful to only add stations in certain systems and consistently over time. The salt was added to prevent all oxp's selecting the same 'random' choice for a given system. |Source=([https://bb.oolite.space/viewtopic.php?p=193483#p193483 Eric Walch])}}
 '''See also''': <code>[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random math.random]</code>

@@ Line 263: / Line 263: @@
 Returns a number that’s greater than or equal to zero and less than one. It will always return the same value for a given <code>salt</code> value and system. Crucially, the relationship between systems and numbers is effectively completely different for each salt value, so scripts making similar decisions based on <code>scrambledPseudoRandomNumber()</code> but using different salts will get uncorrelated results. For example, if two different OXPs add a certain type of station to 25% of systems using <code>if (system.pseudoRandomNumber < 0.25)</code>, the two station types will always be found in the same system; using <code>scrambledPseudoRandomNumber()</code> with different salts avoids this.
-{{QuoteText|Text=scrambledPseudoRandomNumber, was invented to generate 'random' numbers that are always the same for a given system. Useful to only add stations in certain systems and consistently over time. The salt was added to prevent all oxp's selecting the same 'random' choice for a given system. |Source=([http://oolite.aegidian.org/bb/viewtopic.php?p=193483#p193483 Eric Walch])}}
+{{QuoteText|Text=scrambledPseudoRandomNumber, was invented to generate 'random' numbers that are always the same for a given system. Useful to only add stations in certain systems and consistently over time. The salt was added to prevent all oxp's selecting the same 'random' choice for a given system. |Source=([http://oolite.bb.oolite.space/viewtopic.php?p=193483#p193483 Eric Walch])}}
 '''See also''': <code>[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Math/random math.random]</code>

@@ Line 50: / Line 50: @@
 The type of government in the current system, ranging from 0 (Anarchy) to 7 (Corporate State).
-'''See Also:''' <code>[[#governmentDescription|governmentDescription]]</code>
+'''See Also:''' [[Planetinfo.plist#Government|Planetinfo.plist]], <code>[[#governmentDescription|governmentDescription]]</code>
 === <code>governmentDescription</code> ===

@@ Line 38: / Line 38: @@
 The type of economy in the current system, ranging from 0 (Rich Industrial) to 7 (Poor Agricultural).
-'''See Also:''' <code>[[#economyDescription|economyDescription]]</code>
+'''See Also:''' [[Planetinfo.plist#Economy|Planetinfo.plist]], <code>[[#economyDescription|economyDescription]]</code>
 === <code>economyDescription</code> ===

@@ Line 274: / Line 274: @@
 {{oolite-method-added|1.79}}
   function '''setPopulator'''(key : String, definition : Object)
-Sets the [[Oolite_System_Populator|populator settings]] for the specified key to the given definition, or deletes them if the definition is null. Calling this outside of the system population set up is possible but useless. See the populator settings page for more information on the format of the <code>definition</code> object.
+Sets the [[Oolite_System_Populator|populator settings]] for the specified key to the given definition, or deletes them if the definition is <code>null</code>. Calling this outside of the system population set up is possible but useless. See the populator settings page for more information on the format of the <code>definition</code> object.
 '''See Also:''' <code>[[#populatorSettings|populatorSettings]]</code>

@@ Line 178: / Line 178: @@
 Adds ships to the system and returns the added ships in an array. Position is in absolute coordinates. When no position is given, the witchpoint is assumed. When no radius is given, the maximum scanner range is used. Ships added in range of the witchpoint automatically create a witchpoint entry cloud.
-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 [[Oolite_JavaScript_Reference:_Vector3D#fromCoordinateSystem|fromCoordinateSystem]] method 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.
@@ Line 206: / Line 206: @@
 Adds a new visual effect with the effectKey in effectdata to the system, at the specified position, and returns the added effect. If the effectKey does not exist, or creation was otherwise impossible, this method will fail and return <code>null</code>.
-Note that unlike the functions for adding ships, <code>addVisualEffect</code> returns a single entity, not an array.
+Note that unlike the methods for adding ships, <code>addVisualEffect</code> returns a single entity, not an array.
 === <code>countEntitiesWithScanClass</code> ===
@@ Line 317: / Line 317: @@
 would return <code>"This is a dull planet."</code> if called from galaxy 0, and throw an exception if called from the other galaxies.
-Of particular note the spelling of the '''techlevel''' property when using the infoForSystem function to extract it. While the property of <code>system.'''techLevel'''</code> is spelt using camelCase, <code>System.infoForSystem(0, 55).'''techlevel'''</code> is all lowercase. This is because planetinfo.plist has always had the techlevel key spelt this way.
+Of particular note the spelling of the '''techlevel''' property when using the infoForSystem method to extract it. While the property of <code>system.'''techLevel'''</code> is spelt using camelCase, <code>System.infoForSystem(0, 55).'''techlevel'''</code> is all lowercase. This is because planetinfo.plist has always had the techlevel key spelt this way.
 === <code>systemIDForName</code> ===

@@ Line 323: / Line 323: @@
 Returns the ID number of a system in the current galaxy based on the system name.
-'''Note:''' in galaxy 8, there are two systems named “Inzaan”. <code>systemIDForName()</code> will return the lower ID, which is 22.
+'''Note:''' in galaxy 8, there are two systems named <code>"Inzaan"</code>. <code>systemIDForName()</code> will return the lower ID, which is 22.
 === <code>systemNameForID</code> ===

@@ Line 311: / Line 311: @@
 Overwrites existing info of the given system. As properties it uses the [[planetinfo.plist]] keys. e.g.
   System.infoForSystem(0, 55).description = "This is a dull planet."
-sets the description of planet nr 55 in galaxy 0 to "This is a dull planet."
+sets the description of planet nr 55 in galaxy 0 to <code>"This is a dull planet."</code>
 Starting from Oolite 1.73, all system Info for the present galaxy is also readable. Even though any galaxy system info property is fully settable, due to engine limitations other galaxies' data is not accessible. In other words
   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.
+would return <code>"This is a dull planet."</code> if called from galaxy 0, and throw an exception if called from the other galaxies.
-Of particular note the spelling of the '''techlevel''' property when using the infoForSystem function to extract it. While the property of system.techLevel is spelt using camelCase, System.infoForSystem(0, 55).techlevel is using all lower case. This is because planetinfo.plist has always had the techlevel key spelt this way.
+Of particular note the spelling of the '''techlevel''' property when using the infoForSystem function to extract it. While the property of <code>system.'''techLevel'''</code> is spelt using camelCase, <code>System.infoForSystem(0, 55).'''techlevel'''</code> is all lowercase. This is because planetinfo.plist has always had the techlevel key spelt this way.
 === <code>systemIDForName</code> ===

@@ Line 71: / Line 71: @@
 === <code>inhabitantsDescription</code> ===
   '''inhabitantsDescription''' : String (read/write)
-The description of the inhabitants of the current system, such as “Slimy Blue Frogs”.
+The description of the inhabitants of the current system, such as <code>"Slimy Blue Frogs"</code>.
 === <code>isInterstellarSpace</code> ===

@@ Line 54: / Line 54: @@
 === <code>governmentDescription</code> ===
   '''governmentDescription''' : String (read-only)
-A localized description of the government type, for example, “Democracy”. Since this string is localized, it should only be used for display purposes.
+A localized description of the government type, for example, <code>"Democracy"</code>. Since this string is localized, it should only be used for display purposes.
 '''See Also:''' <code>[[#government|government]]</code>