Difference between revisions of "Oolite JavaScript Reference: System"
(→<code>pseudoRandom255</code>) |
(→<code>infoForSystem</code>) |
||
Line 149: | Line 149: | ||
System.infoForSystem(0, 55).description = "This is a dull planet." | System.infoForSystem(0, 55).description = "This is a dull planet." | ||
sets the description of planet nr 55 in galaxy 0 to his is a dull planet." (added with Oolite 1.72.1) | sets the description of planet nr 55 in galaxy 0 to his is a dull planet." (added with Oolite 1.72.1) | ||
+ | Starting from Oolite 1.73, all system Info for the present galaxy is also readable. Eeven 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, null from the other galaxies. | ||
=== <code>legacy_addShips etc.</code> === | === <code>legacy_addShips etc.</code> === |
Revision as of 09:16, 23 August 2009
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
- 1 Properties
- 1.1 allShips
- 1.2 description
- 1.3 economy
- 1.4 economyDescription
- 1.5 goingNova
- 1.6 goneNova
- 1.7 government
- 1.8 governmentDescription
- 1.9 ID
- 1.10 info
- 1.11 inhabitantsDescription
- 1.12 isInterstellarSpace
- 1.13 mainPlanet
- 1.14 mainStation
- 1.15 planets
- 1.16 population
- 1.17 productivity
- 1.18 pseudoRandom100
- 1.19 pseudoRandom256
- 1.20 sun
- 1.21 techLevel
- 2 Methods
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.
info
info : String (write-only)
Overwrites existing info of the current system the player is in. As properties it uses the planetinfo.plist keys. e.g.
System.info.description = "This is a dull planet."
sets the description of the current planet to "This is a dull planet." (added with Oolite 1.72)
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.
pseudoRandom100
pseudoRandom100 : Number (integer, read)
A random number between 0 and 99 that is always the same for a given system.
pseudoRandom256
pseudoRandom256 : Number (integer, read)
A random number between 0 and 255 that is always the same for a given 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
function 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
function addPlanet(planetInfoKey : String)
Adds a planet to the system, using the specified entry in planetinfo.plist. (See also: addMoon()
)
countShipsWithRole
function countShipsWithRole(role : String) : Number (integer)
Returns the number of ships with the specified role in the system; Counts not only the primary role the ship is added with but all roles a ship can have. Specially useful for counting a group of ships linked together with a common but not used role.
countShipsWithPrimaryRole
function countShipsWithPrimaryRole(role : String) : Number (integer)
Returns the number of ships with the specified primary role in the system; equivalent to checkForShips: in plist scripts. (added with Oolite 1.72)
entitiesWithScanClass
This method was added in Oolite test release 1.70.
function 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.
function 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()
.
infoForSystem
function infoForSystem(galaxyNumber: Integer, systemID : Integer) (write-only)
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 his is a dull planet." (added with Oolite 1.72.1) Starting from Oolite 1.73, all system Info for the present galaxy is also readable. Eeven 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, null from the other galaxies.
legacy_addShips etc.
function legacy_addShips(role : String, count : Number) function legacy_addSystemShips(role : String, count : Number, position : Number) function legacy_addShipsAt(role : String, count : Number, coordscheme : String, where : vectorExpression) function legacy_addShipsAtPrecisely(role : String, count : Number, coordscheme : String, where : vectorExpression) function legacy_addShipsWithinRadius(role : String, count : Number, coordScheme : String, where : vectorExpression, radius : Number) function legacy_spawnShip(shipDataKey : String)
Various ways of causing ships to appear. Each of these corresponds to a legacy scripting method. For more info about the coordscheme, look at oolite coordinate systems. A new, more flexible addShips()
function will supersede all of them.
Important: legacy_addShipsWithinRadius
does not work in Oolite 1.70, but has been fixed for Oolite 1.71. legacy_spawn
, previously listed here, never worked as intended and has been replaced with Ship.spawn()
.
sendAllShipsAway
function sendAllShipsAway()
Makes all ships hyperspace out of the system.
setSunNova
function setSunNova(secondsUntilNova : Number)
Sets the system’s sun to go nova after the specified time interval. Time is specified in game real time. Deprecated since 1.72 in favour of: system.sun.goNova()
shipsWithPrimaryRole
This method was added in Oolite test release 1.70.
function 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.
function 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()
.
systemIDForName
function systemIDForName(systemName : String) : Integer
Returns the ID number of a system in the current galaxy based on the system name)
systemNameForID
function systemNameForID(systemID : Integer) : String
Returns the name of a system in the current galaxy based on the given ID number)