Misc plists - Revision history

Hiran: /* Structure */

2021-04-30T23:01:46Z

‎Structure

Milo: added section for whitelist.plist

2020-06-20T19:40:20Z

added section for whitelist.plist

Phkb: /* worldScripts.plist */

2018-03-27T02:47:14Z

‎worldScripts.plist

Phkb: /* illegal_goods.plist */

2018-03-27T02:46:20Z

‎illegal_goods.plist

Cim: /* Use */ Warn against too-large arrays

2013-11-30T16:47:43Z

‎Use: Warn against too-large arrays

Cim: Note 1.79 revision to pirate victim roles

2013-10-05T21:25:12Z

Note 1.79 revision to pirate victim roles

GGShinobi: /* Use */ link to example for generating unique names

2013-01-29T12:55:43Z

‎Use: link to example for generating unique names

GGShinobi: subsection "See also" with link to "OXP Howto", because directory structure is well explained there and it also has further info

2013-01-14T18:55:57Z

subsection "See also" with link to "OXP Howto", because directory structure is well explained there and it also has further info

GGShinobi: /* Structure */ typo

2013-01-14T18:51:13Z

‎Structure: typo

Cim: /* Structure */ 1.77 notes, and cleanup

2012-06-20T21:58:56Z

‎Structure: 1.77 notes, and cleanup

@@ Line 6: / Line 6: @@
 Example of a line segment:
  (W1, X1, Y1,    W2, X2, Y2)
 All coordinates must lie between -1 and +1, while the widths are between 0 and 1
@@ Line 15: / Line 15: @@
  	(0.25, -0.75, 0.0,		0.75, -0.50, 0.0)
  );
-The crosshairs.plist is not intended to be changed by an OXP. For custom crosshairs it is intended to add a <code>crosshair</code> entry in the custom HUD definition itself. This will than override the default crosshairs for that HUD. (See [[hud.plist]]).
+The crosshairs.plist is not intended to be changed by an OXP. For custom crosshairs it is intended to add a <code>crosshair</code> entry in the custom HUD definition itself. This will then override the default crosshairs for that HUD. (See [[hud.plist]]).
-In 1.77 or later, custom crosshairs files may be defined. These have the same syntax as crosshairs.plist, but should have a different unique name (e.g. <code>oxpname_crosshairs1.plist</code>). These may be included by a HUD definition, or switched in and out by [[Oolite_JavaScript_Reference:_PlayerShip#crosshairs|scripting]].
+In 1.77 or later, custom crosshairs files may be defined. These have the same syntax as crosshairs.plist, but should have a different unique name (e.g. <code>oxpname_crosshairs1.plist</code>). Crosshairs may be included by a HUD definition, or switched in and out by [[Oolite_JavaScript_Reference:_PlayerShip#crosshairs|scripting]].
 =descriptions.[[plist]]=

← Older revision		Revision as of 19:40, 20 June 2020
Line 143:		Line 143:
	Its function is to attach more than one wordScript to an oxp. On startup, Oolite looks first if there is a worldScripts.plist file. When present the scripts inside are used as world scripts. These scripts can be both js script files or legacy script plist files. Even a mix is allowed. Only when the worldScripts.plist is not present, Oolite looks for a file with the name "script.js" in the Config folder. And when that is not present it looks for the file "script.plist".		Its function is to attach more than one wordScript to an oxp. On startup, Oolite looks first if there is a worldScripts.plist file. When present the scripts inside are used as world scripts. These scripts can be both js script files or legacy script plist files. Even a mix is allowed. Only when the worldScripts.plist is not present, Oolite looks for a file with the name "script.js" in the Config folder. And when that is not present it looks for the file "script.plist".

		+	=whitelist.[[plist]]=
		+
		+	==Structure==
		+	The file is organized as a dictionary of keys with the values being themselves either arrays of strings or dictionaries of key-value pairs.
		+
		+	==Use==
		+	The file is included with Oolite. OXPs are restricted from using legacy features that are not included in the whitelist. As of Oolite 1.89, the file starts with the following comment:
		+	<pre>
		+	/* Methods that may be used from old-style script actions or conditions.
		+
		+	This plist cannot be extended or overriden by OXPs.
		+
		+	action_methods Commands permitted in world scripts.
		+	ai_methods Commands permitted in AIs.
		+	ai_and_action_methods Commands permitted in world scripts and AIs.
		+	query_methods Values that may be queried in script conditions.
		+	action_method_aliases Mappings from script commands (left) to internal names (right).
		+	ai_method_aliases Mappings from AI commands (left) to internal names (right).
		+	query_method_aliases Mappings from script queries (left) to internal names (right).
		+	shader_*_binding_methods Values that may be queried through shader bindings.
		+
		+	Most other types of legacy script - ship actions, character scripts,
		+	scriptActionOnTarget: - can use both action_methods and ai_methods. The exception is
		+	systeminfo scripts, which can't use ai_methods as they aren't run with a ship target.
		+	*/
		+	</pre>

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

@@ Line 128: / Line 128: @@
 Only useful for test versions to make the user constantly aware that he is using a test version of the oxp.
-=worldScripts.[[plist]]=
+=world-scripts.[[plist]]=
 ==Structure==

@@ Line 76: / Line 76: @@
 =illegal_goods.[[plist]]=
 ==Structure==
@@ Line 88: / Line 89: @@
 ==Use==
 Better never use this as it might change the game to much.
 =pirate-victim-roles.[[plist]]=

@@ Line 45: / Line 45: @@
 == Use  ==
-Its use must be seen as a kind of variable. The key part is the variable name and the string part is the content of the variable. If you use an array of strings the variable will return a random choice of one of the strings. And this is the main use of the descriptions.plist: creation of text with variable content. See also [[string expansion]].
+Its use must be seen as a kind of variable. The key part is the variable name and the string part is the content of the variable. If you use an array of strings the variable will return a random choice of one of the strings. And this is the main use of the descriptions.plist: creation of text with variable content. See also [[string expansion]]. Note that for compatibility, the random number used to determine which choice to use from an array is only 1 byte long. Therefore if the array has more than 256 entries there will be some entries which can never be picked, and if it has a number of entries which is not a power of two the entries will not have equal chances of being picked (though if the number of entries is small, the difference in chances is not significant)
 The text itself is invoked by using the key-word between square brackets, like:

← Older revision		Revision as of 21:25, 5 October 2013
Line 91:		Line 91:

	=pirate-victim-roles.[[plist]]=		=pirate-victim-roles.[[plist]]=
		+
		+	In 1.79 this is superseded by [[role-categories.plist]] and should no longer be used for new OXPs. Existing files will continue to have the effect documented below.

	==Structure==		==Structure==

@@ Line 53: / Line 53: @@
 Whenever Oolite reads in a scriptline, missiontext or description, it first looks for something between brackets. If it finds something it looks to see if it is a mission_variable. If yes, it replaces the name of the variable with its content. Then it looks in the descriptions.plist. If it finds a key, it replaces the name with the string content. If it is an array it picks at random one of the strings.
-Be aware that Oolite reads in all descriptions.plist lines on startup in one big file. This means that you can use keywords from other OXPs or from Oolite itself. If there are some keys with duplicate names, it uses the last. This means that you must use unique keywords.
+Be aware that Oolite reads in all descriptions.plist lines on startup in one big file. This means that you can use keywords from other OXPs or from Oolite itself. If there are some keys with duplicate names, it uses the last. This means that you must use [[OXP Distribution#General|unique keywords]].
 =demoships.[[plist]]=

← Older revision		Revision as of 18:55, 14 January 2013
Line 142:		Line 142:

	[[Category:Oolite scripting]]		[[Category:Oolite scripting]]
		+
		+	=See also=
		+	* [[OXP howto]]

@@ Line 115: / Line 115: @@
 ==Structure==
-The file is organized as an array of strings. When the plist is present, the content of the strings is written to the log on start-up and thw player sees a message on the start-up screen that the oxp "foo" contains a message. This plist is introduced with Oolite version 1.74. It should be placed direct in the main directory level of the oxp, were also the 'requires.plist' is situated.
+The file is organized as an array of strings. When the plist is present, the content of the strings is written to the log on start-up and the player sees a message on the start-up screen that the oxp "foo" contains a message. This plist is introduced with Oolite version 1.74. It should be placed direct in the main directory level of the oxp, were also the 'requires.plist' is situated.
 Example OpenStep: