OXPConfig Doc - Revision history

Svengali: added note about v3

2015-05-26T15:12:29Z

added note about v3

Svengali: formatting

2013-09-15T23:45:42Z

formatting

Svengali: added screenID

2013-02-19T12:34:53Z

added screenID

Svengali: pfuuh - some more infos.

2013-02-04T13:39:22Z

pfuuh - some more infos.

Show changes

GGShinobi: /* oxpcSettings */ typo

2013-02-03T19:25:34Z

‎oxpcSettings: typo

Svengali: /* How to join */

2013-02-02T14:15:32Z

‎How to join

Svengali: added DynamicNotify

2013-01-31T22:00:13Z

added DynamicNotify

Svengali at 01:24, 30 January 2013

2013-01-30T01:24:03Z

Svengali: bah - more doc

2013-01-30T01:09:38Z

bah - more doc

Svengali at 10:40, 29 January 2013

2013-01-29T10:40:49Z

@@ Line 1: / Line 1: @@
 == Overview ==
 [[OXPConfig]] is more or less only a Interface to give OXPs the possibility to let users change, load and store settings in the game. It does it only for OXPs which are including the necessary data (and if the OXP is in the database for performance reasons). This way it's still up to the OXPers to decide if they want user settings or not. In most cases it's really easy to implement the data and usually only needs a few lines of code.
@@ Line 16: / Line 18: @@
 == How to join ==
-If any of your worldScripts should be included in the database send a pm with infos to Svengali or post your request in the [http://aegidian.org/bb/viewtopic.php?f=4&t=4908 OXPConfig] thread:
+If any of your worldScripts should be included in the database send a pm with infos to Lone_Wolf or post your request in the [http://aegidian.org/bb/viewtopic.php?f=4&t=4908 OXPConfig] thread:
 * name of worldScript
 * display name, can be different from the scriptname.

@@ Line 11: / Line 11: @@
-Missionscreens in <tt>OXPConfig.js</tt> are using the screenID (v2.3.2+)
+Missionscreens in <tt>OXPConfig.js</tt> are using the screenID {{AV|2.3.2}}
 {{CodeEx|codeex="OXPConfig"}}
@@ Line 163: / Line 163: @@
 === oxpcSettings example ===
 Example declaration:
-{{CodeEx|codeex=this.oxpcSettings = {
+  this.oxpcSettings = {
-:Info: {Name:"myOXP", Notify:true, InfoB:"Funny things can be configured.", InfoS:"Short explanation."},
+    Info: {Name:"myOXP", Notify:true, InfoB:"Funny things can be configured.", InfoS:"Short explanation."},
-:Bool0: {Name:"logging", Def:false, Desc:"Logging functions."},
+    Bool0: {Name:"logging", Def:false, Desc:"Logging functions."},
-:SInt0: {Name:"sliderA", Def:0x2, Max:0xa, Desc:"Chance."},
+    SInt0: {Name:"sliderA", Def:0x2, Max:0xa, Desc:"Chance."},
-:SInt1: {Name:"sliderB", Def:0x5, Max:0xff, Desc:"OptionB."}
+    SInt1: {Name:"sliderB", Def:0x5, Max:0xff, Desc:"OptionB."}
-};
+  };
 == Other checked properties ==
@@ Line 180: / Line 180: @@
 It declares a array with 20 elements in the format [ [[c0-color1],[c0-color2]], ... ] and a missionVariable <tt>.genericUserColors</tt>. OXPs can get a instance of this array
-{{CodeEx|codeex=this.myColors = worldScripts.OXPConfig.genericUserColors;}}
+  this.myColors = worldScripts.OXPConfig.genericUserColors;
 A simple example could look like:
-{{CodeEx|codeex=this.startUp = function(){
+  this.startUp = function(){
-:this.myColor = [ ["grayColor","greenColor"] ];
+    this.myColor = [ ["grayColor","greenColor"] ];
-:if(worldScripts.OXPConfig) this.grabArrayDelayed = true;
+    if(worldScripts.OXPConfig) this.grabArrayDelayed = true;
-:else if(missionVariables.genericUserColors) this.myColor = JSON.parse(missionVariables.genericUserColors);
+    else if(missionVariables.genericUserColors) this.myColor = JSON.parse(missionVariables.genericUserColors);
-};
+  };
+  this.shipWillLaunchFromStation = function(){
-this.shipWillLaunchFromStation = function()
+    if(this.grabArrayDelayed){
+      this.myColor = worldScripts.OXPConfig.genericUserColors;
-:if(this.grabArrayDelayed){
+      delete this.grabArrayDelayed;
-::this.myColor = worldScripts.OXPConfig.genericUserColors;
-::delete this.grabArrayDelayed;
+  };
-:}
+  this.shipTargetAcquired = function(newTarget){
-};
+    if(!newTarget) return;
+    newTarget.scannerDisplayColor1 = this.myColor[0][0];
-this.shipTargetAcquired = function(newTarget)
+    newTarget.scannerDisplayColor2 = this.myColor[0][1];
+  };
 The example defines a default array which is used if neither array, nor the related mV is available. Then it checks if OXPConfig is installed - if so it delays the access (here <tt>.shipWillLaunchFromStation</tt>) to avoid loading order stuff without the need of a timer and grabs the reference. If a user changes the settings through OXPConfigs GUI the references will be automagically updated as well without any callback/registering or constant checking (associative array). If no OXPConfig is installed (= array unavailable), it tries to get the data from the mV.

← Older revision		Revision as of 12:34, 19 February 2013
Line 9:		Line 9:

	* List of supported [[:Category:OXPConfig-compatible OXPs\|OXPConfig-compatible OXPs]] - currently {{PAGESINCATEGORY:OXPConfig-compatible OXPs}}.		* List of supported [[:Category:OXPConfig-compatible OXPs\|OXPConfig-compatible OXPs]] - currently {{PAGESINCATEGORY:OXPConfig-compatible OXPs}}.
		+
		+
		+	Missionscreens in <tt>OXPConfig.js</tt> are using the screenID (v2.3.2+)
		+	{{CodeEx\|codeex="OXPConfig"}}

@@ Line 89: / Line 89: @@
 :;Info.EarlyCall:Boolean. Flag if <tt>.startUp</tt> should be called by OXPConfig.  Optional, defaults to false. If this flag should be used it is strongly recommended to use the schemata PhantorGorth has developed. See [[Handling_OXP_Dependencies_with_JavaScript]]. But keep in mind that this will raise the time OXPConfigs <tt>.startUp</tt> takes.
 :;Info.EarlySet:Boolean. Flag if settings should be applied in OXPConfigs <tt>.startUp</tt> or later.  Optional, defaults to false. If this flag is used, please keep in mind that this will raise the time OXPConfigs <tt>.startUp</tt> takes.
-:;Info.Notify:Boolean. Flag if OXP should be notified about applied or changed settings. The notification is sent if stored settings are loaded, default settings are loaded by the user, the player exits OXPConfig or switches to the OXP list  Optional, defaults to false. If this flag is used, please keep in mind that this will raise the processing-time of OXPConfig. See [[#oxpcNotifyOnChange()|oxpcNotifyOnChange()]].
+:;Info.Notify:Boolean. Flag if OXP should be notified about applied or changed settings. The notification is sent if stored settings are loaded, default settings are loaded by the user, the player exits OXPConfig or switches to the OXP list. Optional, defaults to false. If this flag is used, please keep in mind that this will raise the processing-time of OXPConfig. See [[#oxpcNotifyOnChange()|oxpcNotifyOnChange()]].
 :;Info.DynamicNotify:Boolean. Flag if OXP should be notified about every change of settings by the user. Useful for updating of descriptions based on current settings. Optional, defaults to false. See [[#oxpcNotifyOnChange()|oxpcNotifyOnChange()]].
 :;Info.LeaveData:Boolean. Flag if OXPConfig should not delete <tt>.oxpcSettings</tt> after gathering the infos. Setting this flag is recommended for OXPs which are changing their settings (e.g. descriptions or <tt>.Hide</tt> flags) to keep the reference alive. Optional, defaults to false.
@@ Line 129: / Line 129: @@
+}
 }}
 == Other checked properties ==

← Older revision		Revision as of 14:15, 2 February 2013
Line 19:		Line 19:
	The script will get an ID (stored in OXPConfig) that is internally used to relate saved settings to specific OXPs.		The script will get an ID (stored in OXPConfig) that is internally used to relate saved settings to specific OXPs.

		+
		+	A test OXP is available to demonstrate usage of <tt>.Hide</tt> and <tt>.DynamicNotify</tt> flags:
		+	* [https://www.box.com/s/6zcqt48f8dq5p86pdz67 OXPConfig_Test.zip] (1.49 KB)

	== Properties ==		== Properties ==

@@ Line 38: / Line 38: @@
 === oxpcNotifyOnChange() ===
 {{CodeEx|codeex=this.oxpcNotifyOnChange = function(n)}}
-The callback is sent if <tt>.Notify</tt> is set and stored settings are loaded, default settings are loaded by the user, the player exits OXPConfig or switches to the OXP list. See [[#oxpcSettings|oxpcSettings]].
+The callback is sent if <tt>.Notify</tt> is set and stored settings are loaded, default settings are loaded by the user, the player exits OXPConfig or switches to the OXP list. It is also sent if <tt>.DynamicNotify</tt> is set. See [[#oxpcSettings|oxpcSettings]].
 '''Parameters'''
@@ Line 86: / Line 86: @@
 :;Info.EarlyCall:Boolean. Flag if <tt>.startUp</tt> should be called by OXPConfig.  Optional, defaults to false. If this flag should be used it is strongly recommended to use the schemata PhantorGorth has developed. See [[Handling_OXP_Dependencies_with_JavaScript]]. But keep in mind that this will raise the time OXPConfigs <tt>.startUp</tt> takes.
 :;Info.EarlySet:Boolean. Flag if settings should be applied in OXPConfigs <tt>.startUp</tt> or later.  Optional, defaults to false. If this flag is used, please keep in mind that this will raise the time OXPConfigs <tt>.startUp</tt> takes.
-:;Info.Notify:Boolean. Flag if OXP should be notified about applied or changed settings.  Optional, defaults to false. If this flag is used, please keep in mind that this will raise the processing-time of OXPConfig. See [[#oxpcNotifyOnChange()|oxpcNotifyOnChange()]].
+:;Info.Notify:Boolean. Flag if OXP should be notified about applied or changed settings. The notification is sent if stored settings are loaded, default settings are loaded by the user, the player exits OXPConfig or switches to the OXP list  Optional, defaults to false. If this flag is used, please keep in mind that this will raise the processing-time of OXPConfig. See [[#oxpcNotifyOnChange()|oxpcNotifyOnChange()]].
 :;Info.LeaveData:Boolean. Flag if OXPConfig should not delete <tt>.oxpcSettings</tt> after gathering the infos. Setting this flag is recommended for OXPs which are changing their settings (e.g. descriptions or <tt>.Hide</tt> flags) to keep the reference alive. Optional, defaults to false.
 :;Info.InfoB:String. Additional text for the boolean screen. Max 240 chars.

@@ Line 77: / Line 77: @@
 == Objects ==
 === oxpcSettings ===
-This object holds the settings for an OXP.  OXPConfig deletes this object after gathering the infos if <tt>oxpcSettings.Info.LeaveData</tt> flag is not true.
+This object holds the settings for an OXP. OXPConfig deletes this object after gathering the infos if <tt>oxpcSettings.Info.LeaveData</tt> flag is not true. Make sure the object is extensible and not sealed or frozen, otherwise it will be rejected.
 '''oxpcSettings'''