Difference between revisions of "Script.plist"
Eric Walch (talk | contribs) (→Offering Missions) |
Cholmondely (talk | contribs) m (Tagged as Legacy scripting) |
||
| (9 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '''script.plist''' Used by [[Oolite_Missions|missions]] and [[OXP]]'s to check [[conditions]] and perform scripted actions accordingly. | + | '''script.[[plist]]''' Used by [[Oolite_Missions|missions]] and [[OXP]]'s to check [[conditions]] and perform scripted actions accordingly. The legacy scripting engine used by this is not recommended for use in new OXPs - use [[Oolite_JavaScript_Reference|Javascript]] for scripted behaviour instead. |
In OXP's it can provide Oolite with additional information to generate and populate customised systems. | In OXP's it can provide Oolite with additional information to generate and populate customised systems. | ||
| Line 7: | Line 7: | ||
''script.plist'''s structure is a dictionary, each entry is a particular script with a unique key. | ''script.plist'''s structure is a dictionary, each entry is a particular script with a unique key. | ||
| − | Each script is an array of actions and conditional statements that are executed or checked at regular intervals (every 10 seconds or so during flight). | + | Each script is an array of actions and conditional statements that are executed or checked at regular intervals (every 10 seconds or so during flight or docking). |
| + | |||
| + | For increased performance of a script one needs to add nested structures within the script structure. see: [[Structured Legacy Scripts]] | ||
== Actions == | == Actions == | ||
| Line 20: | Line 22: | ||
'''conditions''' consists of an array of tests to be performed. Each test checks whether the current status of one of a number of [[Methods#Querying_states|queriable states]] and [[mission_variable]]s are '''equal''', '''lessthan''', '''greaterthan''' a given value or state, or '''oneof''' a list of comma separated states. | '''conditions''' consists of an array of tests to be performed. Each test checks whether the current status of one of a number of [[Methods#Querying_states|queriable states]] and [[mission_variable]]s are '''equal''', '''lessthan''', '''greaterthan''' a given value or state, or '''oneof''' a list of comma separated states. | ||
| + | Note: As of v1.69 also a '''notequal''' operator will be available for Legacy scripting. | ||
Multiple conditions may be specified, a logical 'AND' is applied to determine whether the conditions are met or not. | Multiple conditions may be specified, a logical 'AND' is applied to determine whether the conditions are met or not. | ||
| Line 58: | Line 61: | ||
</dict> | </dict> | ||
| − | |||
| − | |||
| − | |||
==Examples== | ==Examples== | ||
A few simple ''rendezvous'' scripts, to make ships appear in space, can be found in [[OXP_howto_plist#script.plist|here]]. | A few simple ''rendezvous'' scripts, to make ships appear in space, can be found in [[OXP_howto_plist#script.plist|here]]. | ||
| + | |||
| + | Missions are offered with special commands. | ||
| + | How to do this so you won't disturb other OXP missions is seen [[OXP_mission_offering|here]]. | ||
| + | |||
[[Category:Oolite]] | [[Category:Oolite]] | ||
| + | [[Category:Oolite scripting]] [[Category:Legacy scripting]] | ||
Latest revision as of 09:45, 9 August 2021
script.plist Used by missions and OXP's to check conditions and perform scripted actions accordingly. The legacy scripting engine used by this is not recommended for use in new OXPs - use Javascript for scripted behaviour instead.
In OXP's it can provide Oolite with additional information to generate and populate customised systems.
Structure
script.plist's structure is a dictionary, each entry is a particular script with a unique key.
Each script is an array of actions and conditional statements that are executed or checked at regular intervals (every 10 seconds or so during flight or docking).
For increased performance of a script one needs to add nested structures within the script structure. see: Structured Legacy Scripts
Actions
An action is a simple string referring to a method
Conditional statements
Conditional statements consist of a dictionary with entries for the keys conditions and do (and optionally else.)
conditions
conditions consists of an array of tests to be performed. Each test checks whether the current status of one of a number of queriable states and mission_variables are equal, lessthan, greaterthan a given value or state, or oneof a list of comma separated states. Note: As of v1.69 also a notequal operator will be available for Legacy scripting.
Multiple conditions may be specified, a logical 'AND' is applied to determine whether the conditions are met or not.
If all the conditions are met then the do entry is executed, if any are not met then the else entry is executed (if it exists).
example:
<key>conditions</key>
<dict>
<array>
<string>shipsFound_number equal 0</string>
</array>
</dict>
do
do consists of an array of actions (and further conditional statements if required), executed if the conditions are met.
Example:
<key>do</key>
<dict>
<array>
<string>addShips: asp-cloaked 1</string>
<string>addShips: pirate 12</string>
</array>
</dict>
else
else consists of an array of actions (and further conditional statements if required), executed if the conditions are NOT met.
Example:
<key>else</key>
<dict>
<array>
<string>addShips: super-pirate 1</string>
</array>
</dict>
Examples
A few simple rendezvous scripts, to make ships appear in space, can be found in here.
Missions are offered with special commands. How to do this so you won't disturb other OXP missions is seen here.
