Cabal Common Library Doc MissionHandling - Revision history

Svengali: formatting

2013-09-15T23:33:44Z

formatting

Svengali: /* Overview */

2012-05-29T22:49:03Z

‎Overview

Svengali: further doc

2012-03-25T18:30:23Z

further doc

Svengali: further work on doc

2012-03-15T20:53:10Z

further work on doc

Svengali: Started new doc for CCL1.5.1

2012-03-15T19:46:37Z

Started new doc for CCL1.5.1

New page

== Overview ==
The script handles incoming data from worldScripts to coordinate mission offerings based on tokens in system descriptions. OXPs can register on startUp and the script calls back whenever the conditions are matched.

{{CodeEx|codeex=var a = ["boring",{chance:0.1,gov:[1],name:"myOXP",func:"callback"}];
worldScripts.Cabal_Common_MissionHandling.mPool.push(a);}}

[[Category:OXPDoc]]

@@ Line 1: / Line 1: @@
 == Overview ==
 The script handles incoming data from worldScripts to coordinate mission offerings based on tokens in system descriptions. OXPs can register on startUp and the script calls back whenever the conditions are matched.
@@ Line 6: / Line 8: @@
 If OXPs have inserted data, the checks are done on shipWillExitWitchspace (early flag), shipExitedWitchspace, shipWillLaunchFromStation (early flag) and shipLaunchedFromStation.
 == Inserted object ==

@@ Line 23: / Line 23: @@
 :;exToken:String. Don't handle if token found. E.g. "Navy".
 :;gal:Array. galaxyNumber. E.g. [1,4].
-:;gov:Array. system.government. E.g. [2,3,4]
+:;gov:Array. system.government. E.g. [2,3,4].
-:;ID:Array. system.ID. E.g. [2,45,127,234]
+:;ID:Array. system.ID. E.g. [2,45,127,234].
 :;mutalEx:Number. Mute group. Default 0.
 :;seeds:Array. Scrambled IDs.
@@ Line 30: / Line 30: @@
 == Callback ==
-If the conditions are matched the script calls the specified function. The OXP can do further checks there and should return true or false. If it returns true and mutalEx was specified no callback for a OXP with the same group is processed.
+If the conditions are matched the script calls the specified function with the token as argument. The OXP can do further checks there and should return true or false. If it returns true and mutalEx was specified no callback for a OXP with the same group is processed.
 Additionally the script sets a property '''runningMission''' to true to give other OXPs a clue about it. If this property gets set to true by other OXPs no further checks are processed.

← Older revision		Revision as of 20:53, 15 March 2012
Line 5:		Line 5:
	worldScripts.Cabal_Common_MissionHandling.mPool.push(a);}}		worldScripts.Cabal_Common_MissionHandling.mPool.push(a);}}

		+	If OXPs have inserted data, the checks are done on shipWillExitWitchspace (early flag), shipExitedWitchspace, shipWillLaunchFromStation (early flag) and shipLaunchedFromStation.
		+
		+
		+	== Inserted object ==
		+	The array must hold two entries.
		+	:;token:String. Main condition to start further checks.
		+	:;actions:Object. Contains the conditions and handling functionality.
		+
		+
		+	'''Required actions properties:'''
		+	:;name:String. Script name.
		+	:;func:String. Functionname for callback.
		+
		+	'''Optional actions properties:'''
		+	:;chance:Number. Compared against Math.random(), so should be in range 0...1.
		+	:;early:Boolean. Process on shipWillLaunchFromStation and shipWillExitWitchspace. Otherwise on shipLaunchedFromStation and shipExitedWitchspace.
		+	:;exToken:String. Don't handle if token found. E.g. "Navy".
		+	:;gal:Array. galaxyNumber. E.g. [1,4].
		+	:;gov:Array. system.government. E.g. [2,3,4]
		+	:;ID:Array. system.ID. E.g. [2,45,127,234]
		+	:;mutalEx:Number. Mute group. Default 0.
		+	:;seeds:Array. Scrambled IDs.
		+
		+
		+	== Callback ==
		+	If the conditions are matched the script calls the specified function. The OXP can do further checks there and should return true or false. If it returns true and mutalEx was specified no callback for a OXP with the same group is processed.
		+
		+	Additionally the script sets a property '''runningMission''' to true to give other OXPs a clue about it. If this property gets set to true by other OXPs no further checks are processed.
		+
		+
		+	== Properties ==
		+	:;runningMission:Boolean. If set no further checks are processed. Reset on '''startUp''' and '''shipWillExitWitchspace'''.
		+	:;binSearch:Object. Search tree that holds the inserted data.

	[[Category:OXPDoc]]		[[Category:OXPDoc]]

@@ Line 4: / Line 4: @@
 The script handles incoming data from worldScripts to coordinate mission offerings based on tokens in system descriptions. OXPs can register on startUp and the script calls back whenever the conditions are matched.
-{{CodeEx|codeex=var a = ["boring",{chance:0.1,gov:[1],name:"myOXP",func:"callback"}];
+  var a = ["boring",{chance:0.1,gov:[1],name:"myOXP",func:"callback"}];
-worldScripts.Cabal_Common_MissionHandling.mPool.push(a);}}
+  worldScripts.Cabal_Common_MissionHandling.mPool.push(a);
 If OXPs have inserted data, the checks are done on shipWillExitWitchspace (early flag), shipExitedWitchspace, shipWillLaunchFromStation (early flag) and shipLaunchedFromStation.
 == Inserted object ==