Difference between revisions of "ISKernel:innerspace (Data Type)"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
This data type holds information about Inner Space. | This data type holds information about Inner Space. | ||
| + | |||
== Members == | == Members == | ||
| − | *[[ | + | *[[ObjectType:string|string]] '''Version''': Returns the Inner Space version number |
| − | *[[ | + | *[[ObjectType:int|int]] '''Build''': Returns the Inner Space build number |
| − | *[[ | + | *[[ObjectType:string|string]] '''ISXDK''': Returns the ISXDK version |
| + | *[[ObjectType:string|string]] '''Uplink''': Returns the Name of the current Uplink | ||
| + | *[[LavishSettings:settingsetref_(Object_Type)|settingsetref]] '''Configuration''': The main Inner Space settings (InnerSpace.XML) | ||
| + | *[[LavishSettings:settingsetref_(Object_Type)|settingsetref]] '''GameConfiguration''': The Inner Space Game Configuration settings (GameConfiguration.XML) | ||
| + | *[[LavishSettings:settingsetref_(Object_Type)|settingsetref]] '''InputConfiguration''': The Inner Space Input Devices configuration settings (InputDevices.XML) | ||
| + | *[[ISKernel:agent_(Object_Type)|agent]] '''Agent['''#''']''': Retrieves an [[ISKernel:Agent|Agent]], by ID | ||
| + | *[[ISKernel:agent_(Object_Type)|agent]] '''Agent['''name''']''': Retrieves an [[ISKernel:Agent|Agent]], by name | ||
| + | *[[ObjectType:jsonarray|jsonarray]] '''Agents''': Retrieves an array of JSON objects briefly describing all currently defined Agents | ||
| + | |||
| + | |||
== Methods == | == Methods == | ||
*'''LoadExtension['''name''']''': Loads <name> extension | *'''LoadExtension['''name''']''': Loads <name> extension | ||
| + | *'''AddAgent['''json''']''': Adds an Agent via a standalone JSON definition | ||
| + | |||
| + | |||
== Returns == | == Returns == | ||
'''NULL''' | '''NULL''' | ||
| Line 14: | Line 27: | ||
*InnerSpace:LoadExtension[test] | *InnerSpace:LoadExtension[test] | ||
:This will load the 'test' extension. | :This will load the 'test' extension. | ||
| + | |||
| + | |||
===Display the Version Number=== | ===Display the Version Number=== | ||
*echo ${InnerSpace.Version} | *echo ${InnerSpace.Version} | ||
:This will display the Inner Space version number to the console | :This will display the Inner Space version number to the console | ||
| + | |||
== See Also == | == See Also == | ||
Latest revision as of 21:46, 20 October 2019
Contents
Description
This data type holds information about Inner Space.
Members
- string Version: Returns the Inner Space version number
- int Build: Returns the Inner Space build number
- string ISXDK: Returns the ISXDK version
- string Uplink: Returns the Name of the current Uplink
- settingsetref Configuration: The main Inner Space settings (InnerSpace.XML)
- settingsetref GameConfiguration: The Inner Space Game Configuration settings (GameConfiguration.XML)
- settingsetref InputConfiguration: The Inner Space Input Devices configuration settings (InputDevices.XML)
- agent Agent[#]: Retrieves an Agent, by ID
- agent Agent[name]: Retrieves an Agent, by name
- jsonarray Agents: Retrieves an array of JSON objects briefly describing all currently defined Agents
Methods
- LoadExtension[name]: Loads <name> extension
- AddAgent[json]: Adds an Agent via a standalone JSON definition
Returns
NULL
Examples
Load an Extension in a script
- InnerSpace:LoadExtension[test]
- This will load the 'test' extension.
Display the Version Number
- echo ${InnerSpace.Version}
- This will display the Inner Space version number to the console
See Also
