Script.oos - Revision history

Cholmondely: Tagged as Legacy scripting

2021-08-09T09:45:07Z

Tagged as Legacy scripting

Makarius: Category sync for plist

2014-11-10T07:52:19Z

Category sync for plist

Eric Walch: script example from Oolite -> scripting page

2011-01-02T12:29:23Z

script example from Oolite -> scripting page

Ahruman at 21:08, 29 September 2008

2008-09-29T21:08:09Z

Ahruman: Added notice that OOS support will be dropped.

2007-07-15T11:09:03Z

Added notice that OOS support will be dropped.

Dajt at 06:54, 5 April 2006

2006-04-05T06:54:27Z

Dajt: /* Actions */

2006-04-05T06:41:09Z

‎Actions

Dajt: /* Structure */

2006-04-05T06:40:22Z

‎Structure

Dajt: /* Structure */

2006-04-05T06:29:14Z

‎Structure

Dajt: /* Structure */

2006-04-05T06:18:49Z

‎Structure

← Older revision		Revision as of 09:45, 9 August 2021
Line 188:		Line 188:

	[[Category:Oolite]]		[[Category:Oolite]]
−	[[Category:Oolite scripting]]	+	[[Category:Oolite scripting]] [[Category:Legacy scripting]]

← Older revision		Revision as of 07:52, 10 November 2014
Line 187:		Line 187:
	</pre>		</pre>

		+	[[Category:Oolite]]
	[[Category:Oolite scripting]]		[[Category:Oolite scripting]]

← Older revision		Revision as of 12:29, 2 January 2011
Line 187:		Line 187:
	</pre>		</pre>

−	[[Category:Oolite]]	+	[[Category:Oolite scripting]]

@@ Line 1: / Line 1: @@
 '''script.oos''' Used by [[OXP]]'s to check [[conditions]] and perform scripted [[methods|actions]] accordingly.
-:'''Due to lack of adaptation, OOS support will be removed after Oolite 1.69.1.'''
+:'''Due to lack of adaptation, OOS support was be removed in Oolite 1.70.'''
 The "oos" file format allows scripts to be written using a more BASIC-like syntax than the plist file format permits. Scripts in "oos" format

← Older revision		Revision as of 11:09, 15 July 2007
Line 1:		Line 1:
	'''script.oos''' Used by [[OXP]]'s to check [[conditions]] and perform scripted [[methods\|actions]] accordingly.		'''script.oos''' Used by [[OXP]]'s to check [[conditions]] and perform scripted [[methods\|actions]] accordingly.
		+
		+	:'''Due to lack of adaptation, OOS support will be removed after Oolite 1.69.1.'''

	The "oos" file format allows scripts to be written using a more BASIC-like syntax than the plist file format permits. Scripts in "oos" format		The "oos" file format allows scripts to be written using a more BASIC-like syntax than the plist file format permits. Scripts in "oos" format

← Older revision		Revision as of 06:54, 5 April 2006
Line 5:		Line 5:

	If both script.plist and script.oos files exist in an OXP's Config directory, script.oos is loaded in preference to script.plist.		If both script.plist and script.oos files exist in an OXP's Config directory, script.oos is loaded in preference to script.plist.
		+
		+	This format cannot be used in other plist files such as planetinfo.plist. It can only be used to replace script.plist.

	== Structure ==		== Structure ==

@@ Line 99: / Line 99: @@
   // to be the name of the variable to be acted upon, not it's value
   add: local_y [local_x]
-−
   // print a message to the log
   debugMessage: Commander [commander_name] has [local_x] widgets and [local_y] twigs

← Older revision		Revision as of 06:40, 5 April 2006
Line 87:		Line 87:

	Any word in the set of parameters surrounded by square brakets is assumed to be either a variable or the name of a function. If the word '''''starts''''' with mission_, local_, or commander_ it is assumed to be a variable and the variable's value replaces the variable name and the square brackets before the action is executed. If the word '''''ends''''' with _string, _number, or _bool it is assumed to be a function and the function's return value replaces the function name and the square brackets before the action is executed.		Any word in the set of parameters surrounded by square brakets is assumed to be either a variable or the name of a function. If the word '''''starts''''' with mission_, local_, or commander_ it is assumed to be a variable and the variable's value replaces the variable name and the square brackets before the action is executed. If the word '''''ends''''' with _string, _number, or _bool it is assumed to be a function and the function's return value replaces the function name and the square brackets before the action is executed.
		+
		+	Some examples of actions with replacements:
		+
		+	// set the script local variable local_x to a number between 1 and 100
		+	set: local_x [d100_number]
		+
		+	// then set the script local variable local_y to a number between 1 and 100
		+	set: local_y [d100_number]
		+
		+	// and add local_x to it - notice local_y isn't in brackets because the first word has
		+	// to be the name of the variable to be acted upon, not it's value
		+	add: local_y [local_x]
		+
		+	// print a message to the log
		+	debugMessage: Commander [commander_name] has [local_x] widgets and [local_y] twigs

	Here is the longway.oxp script converted to oos format, with comments added:		Here is the longway.oxp script converted to oos format, with comments added:

@@ Line 86: / Line 86: @@
 The first word on an action line specifies the action to be performed. Some actions do not require any parameters, so the action line is a single word - "debugOn" for example. If the action requires any parameters, they are specified after a ":". There are examples of this above - "set" and "debugMessage".
-Any word in the set of parameters surrounded by square brakets is assumed to be either a variable or the name of a function. If the word '''''starts''''' with mission_, local_, or commander_ it is assumed to be a variable and the variable's value replaces the variable name and the square brackets before the action is executed. If the word '''''ends''''' with _string, _number, or _bool it is assumed to be a function and the function's return value replaces the variable name and the square brackets before the action is executed.
+Any word in the set of parameters surrounded by square brakets is assumed to be either a variable or the name of a function. If the word '''''starts''''' with mission_, local_, or commander_ it is assumed to be a variable and the variable's value replaces the variable name and the square brackets before the action is executed. If the word '''''ends''''' with _string, _number, or _bool it is assumed to be a function and the function's return value replaces the function name and the square brackets before the action is executed.
 [[Category:Oolite]]

@@ Line 25: / Line 25: @@
 </pre>
 === Specifying "if" conditions ===
@@ Line 57: / Line 70: @@
 If op is "oneof" then Y is considered to be a list of values separated by commas and the condition is true if X is equal to any one of them.
-=== do ===
+Each condition is terminated by the word "and" or "then" and each condition can be on a separate line, for example:
-'''do''' consists of an array of actions (and further conditional statements if required), executed if the '''conditions''' are met.
+=== Actions ===
-Example:
+If all the conditions in an "if" statement are met then the actions bounded by the "then" and the "else" or "endif" statement are executed. If any of the conditions in an "if" statement are not met and there is an "else" clause then the actions between the "else" and "endif" statement are executed.
-=== else ===
+Each action takes one line, and if finished by the end-of-line character(s).
-'''else''' consists of an array of actions (and further conditional statements if required), executed if the '''conditions''' are NOT met.
+The first word on an action line specifies the action to be performed. Some actions do not require any parameters, so the action line is a single word - "debugOn" for example. If the action requires any parameters, they are specified after a ":". There are examples of this above - "set" and "debugMessage".
-Example:
+Any word in the set of parameters surrounded by square brakets is assumed to be either a variable or the name of a function. If the word '''''starts''''' with mission_, local_, or commander_ it is assumed to be a variable and the variable's value replaces the variable name and the square brackets before the action is executed. If the word '''''ends''''' with _string, _number, or _bool it is assumed to be a function and the function's return value replaces the variable name and the square brackets before the action is executed.
 [[Category:Oolite]]