Difference between revisions of "Oolite JavaScript Reference: System"
(→<code>sun</code>) |
(Changed future-scripting tag to added-in-1.70, updated links.) |
||
| Line 1: | Line 1: | ||
<small>'''Prototype:''' <code>Object</code></small><br /> | <small>'''Prototype:''' <code>Object</code></small><br /> | ||
<small>'''Subtypes:''' none | <small>'''Subtypes:''' none | ||
| − | |||
| − | |||
The '''<code>System</code>''' class represents the current system. There is always one <code>System</code> object, available through the global propery <code>system</code>. | The '''<code>System</code>''' class represents the current system. There is always one <code>System</code> object, available through the global propery <code>system</code>. | ||
| Line 10: | Line 8: | ||
== Properties == | == Properties == | ||
=== <code>allShips</code> === | === <code>allShips</code> === | ||
| + | {{Oolite-prop-added|1.70}} | ||
'''allShips''' : Array (read-only) | '''allShips''' : Array (read-only) | ||
A list of the ships in the system. If there are none, an empty list. | A list of the ships in the system. If there are none, an empty list. | ||
| Line 36: | Line 35: | ||
=== <code>government</code> === | === <code>government</code> === | ||
| − | '''government''' : Number ( | + | '''government''' : Number (read/write, integer) |
The type of government in the current system, ranging from 0 (Anarchy) to 7 (Corporate State). (See also: <code>[[#governmentDescription|governmentDescription]]</code>) | The type of government in the current system, ranging from 0 (Anarchy) to 7 (Corporate State). (See also: <code>[[#governmentDescription|governmentDescription]]</code>) | ||
| Line 52: | Line 51: | ||
=== <code>isInterstellarSpace</code> === | === <code>isInterstellarSpace</code> === | ||
| + | {{Oolite-prop-added|1.70}} | ||
'''isInterstellarSpace''' : Boolean (read-only) | '''isInterstellarSpace''' : Boolean (read-only) | ||
<code>true</code> if the current system is in interstellar space, <code>false</code> otherwise. | <code>true</code> if the current system is in interstellar space, <code>false</code> otherwise. | ||
=== <code>mainPlanet</code> === | === <code>mainPlanet</code> === | ||
| − | '''mainPlanet''' : [[Oolite | + | {{Oolite-prop-added|1.70}} |
| + | '''mainPlanet''' : [[Oolite JavaScript Reference: Planet|Planet]] (read-only) | ||
The system’s main planet, or <code>null</code> if there is none. | The system’s main planet, or <code>null</code> if there is none. | ||
=== <code>mainStation</code> === | === <code>mainStation</code> === | ||
| − | '''mainStation''' : [[Oolite | + | {{Oolite-prop-added|1.70}} |
| + | '''mainStation''' : [[Oolite JavaScript Reference: Station|Station]] (read-only) | ||
The system’s main station, or <code>null</code> if there is none. | The system’s main station, or <code>null</code> if there is none. | ||
=== <code>planets</code> === | === <code>planets</code> === | ||
| + | {{Oolite-prop-added|1.70}} | ||
'''planets''' : Array (read-only) | '''planets''' : Array (read-only) | ||
A list of the planets in the system. If there are none, an empty list. | A list of the planets in the system. If there are none, an empty list. | ||
| Line 76: | Line 79: | ||
=== <code>sun</code> === | === <code>sun</code> === | ||
| − | '''sun''' : [[Oolite | + | {{Oolite-prop-added|1.70}} |
| + | '''sun''' : [[Oolite JavaScript Reference: Sun|Sun]] (read-only) | ||
The system’s sun, or <code>null</code> if there is none. | The system’s sun, or <code>null</code> if there is none. | ||
| Line 98: | Line 102: | ||
=== <code>entitiesWithScanClass</code> === | === <code>entitiesWithScanClass</code> === | ||
| − | '''entitiesWithScanClass'''(scanClass : String [, relativeTo : [[Oolite | + | {{Oolite-method-added|1.70}} |
| + | '''entitiesWithScanClass'''(scanClass : String [, relativeTo : [[Oolite JavaScript Reference: Entity|Entity]] [, range : Number]]) : Array | ||
A list of the entities in the system whose scan class is <code>scanClass</code>. If <code>relativeTo</code> is specified, the list will be sorted in order of proximity to <code>relativeTo</code> (i.e., the first element of the list is closest). If <code>range</code> is also specified, entities further than <code>range</code> metres from <code>relativeTo</code> will be excluded. If no matching entities are found, an empty array is returned. | A list of the entities in the system whose scan class is <code>scanClass</code>. If <code>relativeTo</code> is specified, the list will be sorted in order of proximity to <code>relativeTo</code> (i.e., the first element of the list is closest). If <code>range</code> is also specified, entities further than <code>range</code> metres from <code>relativeTo</code> will be excluded. If no matching entities are found, an empty array is returned. | ||
| Line 104: | Line 109: | ||
=== <code>filteredEntities</code> === | === <code>filteredEntities</code> === | ||
| − | '''filteredEntities'''(this : Object, predicate : Function [, relativeTo : [[Oolite | + | {{Oolite-method-added|1.70}} |
| + | '''filteredEntities'''(this : Object, predicate : Function [, relativeTo : [[Oolite JavaScript Reference: Entity|Entity]] [, range : Number]]) : Array | ||
A list of the entities for which <code>predicate</code> returns <code>true</code>. If <code>relativeTo</code> is specified, the list will be sorted in order of proximity to <code>relativeTo</code> (i.e., the first element of the list is closest). If <code>range</code> is also specified, entities further than <code>range</code> metres from <code>relativeTo</code> will be excluded. If no matching entities are found, an empty array is returned. | A list of the entities for which <code>predicate</code> returns <code>true</code>. If <code>relativeTo</code> is specified, the list will be sorted in order of proximity to <code>relativeTo</code> (i.e., the first element of the list is closest). If <code>range</code> is also specified, entities further than <code>range</code> metres from <code>relativeTo</code> will be excluded. If no matching entities are found, an empty array is returned. | ||
| Line 135: | Line 141: | ||
=== <code>setSunNova</code> === | === <code>setSunNova</code> === | ||
| − | '''setSunNova'''(secondsUntilNova) | + | '''setSunNova'''(secondsUntilNova : Number) |
Sets the system’s sun to go nova after the specified time interval. Time is specified in [[Time scales in Oolite#Game real time|game real time]]. | Sets the system’s sun to go nova after the specified time interval. Time is specified in [[Time scales in Oolite#Game real time|game real time]]. | ||
=== <code>shipsWithPrimaryRole</code> === | === <code>shipsWithPrimaryRole</code> === | ||
| − | '''shipsWithPrimaryRole'''(role : String [, relativeTo : [[Oolite | + | {{Oolite-method-added|1.70}} |
| − | A list of the entities in the system whose [[Oolite | + | '''shipsWithPrimaryRole'''(role : String [, relativeTo : [[Oolite JavaScript Reference: Entity|Entity]] [, range : Number]]) : Array |
| + | A list of the entities in the system whose [[Oolite JavaScript Reference: Ship#primaryRole|primary role]] is <code>role</code>. If <code>relativeTo</code> is specified, the list will be sorted in order of proximity to <code>relativeTo</code> (i.e., the first element of the list is closest). If <code>range</code> is also specified, entities further than <code>range</code> metres from <code>relativeTo</code> will be excluded. If no matching entities are found, an empty array is returned. | ||
'''See Also:''' <code>[[#shipsWithRole|shipsWithRole]]()</code>, <code>[[#entitiesWithScanClass|entitiesWithScanClass]]()</code>, <code>[[#filteredEntities|filteredEntities]]()</code>. | '''See Also:''' <code>[[#shipsWithRole|shipsWithRole]]()</code>, <code>[[#entitiesWithScanClass|entitiesWithScanClass]]()</code>, <code>[[#filteredEntities|filteredEntities]]()</code>. | ||
=== <code>shipsWithRole</code> === | === <code>shipsWithRole</code> === | ||
| − | '''shipsWithRole'''(role : String [, relativeTo : [[Oolite | + | {{Oolite-method-added|1.70}} |
| − | A list of the entities in the system whose [[Oolite | + | '''shipsWithRole'''(role : String [, relativeTo : [[Oolite JavaScript Reference: Entity|Entity]] [, range : Number]]) : Array |
| + | A list of the entities in the system whose [[Oolite JavaScript Reference: Ship#roles|role set]] contains <code>role</code>. If <code>relativeTo</code> is specified, the list will be sorted in order of proximity to <code>relativeTo</code> (i.e., the first element of the list is closest). If <code>range</code> is also specified, entities further than <code>range</code> metres from <code>relativeTo</code> will be excluded. If no matching entities are found, an empty array is returned. | ||
'''See Also:''' <code>[[#shipsWithRole|shipsWithRole]]()</code>, <code>[[#entitiesWithScanClass|entitiesWithScanClass]]()</code>, <code>[[#filteredEntities|filteredEntities]]()</code>. | '''See Also:''' <code>[[#shipsWithRole|shipsWithRole]]()</code>, <code>[[#entitiesWithScanClass|entitiesWithScanClass]]()</code>, <code>[[#filteredEntities|filteredEntities]]()</code>. | ||
| + | |||
| + | [[Category: Oolite scripting]] | ||
Revision as of 12:37, 6 December 2007
Prototype: Object
Subtypes: none
The System class represents the current system. There is always one System object, available through the global propery system.
Attempts to change system properties are ignored in interstellar space (i.e., the place you end up in after a witchspace malfunction).
Contents
Properties
allShips
This property was added in Oolite test release 1.70.
allShips : Array (read-only)
A list of the ships in the system. If there are none, an empty list.
See Also: shipsWithPrimaryRole(), shipsWithRole(), entitiesWithScanClass(), filteredEntities().
description
description : String (read/write)
The description of the current system, as seen on the planet info screen.
economy
economy : Number (integer, read/write)
The type of economy in the current system, ranging from 0 (Rich Industrial) to 7 (Poor Agricultural). (See also: economyDescription)
economyDescription
economyDescription : String (read-only)
A description of the economy type, for example, “Mostly Industrial”. (See also: economy)
goingNova
goingNova : Boolean (read-only)
true if the system’s sun is in the process of going nova, false otherwise. (To do: this should be a propery of the sun.) (See also: goneNova, setSunNova())
goneNova
goneNova : Boolean (read-only)
true if the system’s sun hase gone nova, false otherwise. (To do: this should be a propery of the sun.) (See also: goingNova, setSunNova())
government
government : Number (read/write, integer)
The type of government in the current system, ranging from 0 (Anarchy) to 7 (Corporate State). (See also: governmentDescription)
governmentDescription
governmentDescription : String (read-only)
A description of the government type, for example, “Democracy”. (See also: government)
ID
ID : Number (integer, read-only)
A number identifying the system. 0 to 255, or -1 for interstellar space. Equivalent to planet_number in plist scripts.
inhabitantsDescription
inhabitantsDescription : String (read/write)
The description of the inhabitants of the current system, such as “Slimy Blue Frogs”.
isInterstellarSpace
This property was added in Oolite test release 1.70.
isInterstellarSpace : Boolean (read-only)
true if the current system is in interstellar space, false otherwise.
mainPlanet
This property was added in Oolite test release 1.70.
mainPlanet : Planet (read-only)
The system’s main planet, or null if there is none.
mainStation
This property was added in Oolite test release 1.70.
mainStation : Station (read-only)
The system’s main station, or null if there is none.
planets
This property was added in Oolite test release 1.70.
planets : Array (read-only)
A list of the planets in the system. If there are none, an empty list.
population
population : Number (integer, read/write)
The population of the current system.
productivity
productivity : Number (integer, read/write)
The productivity of the current system.
sun
This property was added in Oolite test release 1.70.
sun : Sun (read-only)
The system’s sun, or null if there is none.
techLevel
techLevel : Number (integer, read/write)
The technology level of the current system, ranging from 0 to 15.
Methods
addMoon
addMoon(planetInfoKey : String)
Adds a moon to the system, using the specified entry in planetinfo.plist. A moon is the same as a planet, except that it has no atmosphere. (See also: addPlanet())
addPlanet
addPlanet(planetInfoKey : String)
Adds a planet to the system, using the specified entry in planetinfo.plist. (See also: addMoon())
countShipsWithRole
countShipsWithRole(role : String) : Number (integer)
Returns the number of ships with the specified role in the system; equivalent to checkForShips: in plist scripts.
entitiesWithScanClass
This method was added in Oolite test release 1.70.
entitiesWithScanClass(scanClass : String [, relativeTo : Entity [, range : Number]]) : Array
A list of the entities in the system whose scan class is scanClass. If relativeTo is specified, the list will be sorted in order of proximity to relativeTo (i.e., the first element of the list is closest). If range is also specified, entities further than range metres from relativeTo will be excluded. If no matching entities are found, an empty array is returned.
See Also: shipsWithPrimaryRole(), shipsWithRole(), filteredEntities().
filteredEntities
This method was added in Oolite test release 1.70.
filteredEntities(this : Object, predicate : Function [, relativeTo : Entity [, range : Number]]) : Array
A list of the entities for which predicate returns true. If relativeTo is specified, the list will be sorted in order of proximity to relativeTo (i.e., the first element of the list is closest). If range is also specified, entities further than range metres from relativeTo will be excluded. If no matching entities are found, an empty array is returned.
Example:
this.findIdlePoliceInScannerRange = function()
{
function isIdlePolice(entity)
{
return entity.isShip && entity.isPolice && !entity.target
}
return system.filteredEntities(this, isIdlePolice, player, 25600)
}
See Also: shipsWithPrimaryRole(), shipsWithRole(), entitiesWithScanClass().
legacy_addShips etc.
legacy_addShips(role : String, count : Number) legacy_addSystemShips(role : String, count : Number, position : Number) legacy_addShipsAt(role : String, count : Number, coordscheme : String, where : vectorExpression) legacy_addShipsAtPrecisely(role : String, count : Number, coordscheme : String, where : vectorExpression) legacy_addShipsWithinRadius(role : String, count : Number, coordScheme : String, where : vectorExpression, radius : Number) legacy_spawn(role : String, count : Number) legacy_spawnShip(shipDataKey : String)
Various ways of causing ships to appear. Each of these corresponds to a legacy scripting method. A new, more flexible addShips() function will supersede all of them.
sendAllShipsAway
sendAllShipsAway()
Makes all ships hyperspace out of the system.
setSunNova
setSunNova(secondsUntilNova : Number)
Sets the system’s sun to go nova after the specified time interval. Time is specified in game real time.
shipsWithPrimaryRole
This method was added in Oolite test release 1.70.
shipsWithPrimaryRole(role : String [, relativeTo : Entity [, range : Number]]) : Array
A list of the entities in the system whose primary role is role. If relativeTo is specified, the list will be sorted in order of proximity to relativeTo (i.e., the first element of the list is closest). If range is also specified, entities further than range metres from relativeTo will be excluded. If no matching entities are found, an empty array is returned.
See Also: shipsWithRole(), entitiesWithScanClass(), filteredEntities().
shipsWithRole
This method was added in Oolite test release 1.70.
shipsWithRole(role : String [, relativeTo : Entity [, range : Number]]) : Array
A list of the entities in the system whose role set contains role. If relativeTo is specified, the list will be sorted in order of proximity to relativeTo (i.e., the first element of the list is closest). If range is also specified, entities further than range metres from relativeTo will be excluded. If no matching entities are found, an empty array is returned.
See Also: shipsWithRole(), entitiesWithScanClass(), filteredEntities().
