VoidExpanse/scripting api - Revision history

Ai enabled: /* Scopes */

2015-04-20T08:29:27Z

Scopes

← Older revision		Revision as of 08:29, 20 April 2015
Line 48:		Line 48:
	* [[VoidExpanse/scope-script]] (available: global)		* [[VoidExpanse/scope-script]] (available: global)
	* [[VoidExpanse/scope-actions]] (available: global)		* [[VoidExpanse/scope-actions]] (available: global)
			* [[VoidExpanse/scope-items]] (available: global)
	* [[VoidExpanse/scope-server]] (available: global)		* [[VoidExpanse/scope-server]] (available: global)
	* [[VoidExpanse/scope-generator]] (available: global)		* [[VoidExpanse/scope-generator]] (available: global)

Ai enabled: /* Global scripts (called in the world dynamically) */

2015-04-20T08:08:18Z

Global scripts (called in the world dynamically)

← Older revision		Revision as of 08:08, 20 April 2015
Line 21:		Line 21:
	{{Main\|VoidExpanse/Global_scripts\|Global scripts}}		{{Main\|VoidExpanse/Global_scripts\|Global scripts}}
	Global scripts are executed continuously during gameplay. For each event there could be many bound scripts. Also it is possible to create custom actions and subscribe to them.		Global scripts are executed continuously during gameplay. For each event there could be many bound scripts. Also it is possible to create custom actions and subscribe to them.
			Please note: OnInit() method is executed only for Global and Internal scripts.

	=== Object scripts ===		=== Object scripts ===

Atomic-admin at 07:45, 6 January 2015

2015-01-06T07:45:16Z

← Older revision		Revision as of 07:45, 6 January 2015
Line 76:		Line 76:
	Consumables can be programmed with standard xml-values, but, in order to implement something		Consumables can be programmed with standard xml-values, but, in order to implement something
	special, one can use special techniques described in this article.		special, one can use special techniques described in this article.

			{{Modding}}

Tjmonk15: Grammar, punctuation, phrasing edits.

2014-07-25T03:27:02Z

Grammar, punctuation, phrasing edits.

Ixby: /* Scripting overview */

2014-05-21T12:28:42Z

Scripting overview

← Older revision		Revision as of 12:28, 21 May 2014
Line 25:		Line 25:
	{{Main\|VoidExpanse/Object_scripts\|Object scripts}}		{{Main\|VoidExpanse/Object_scripts\|Object scripts}}
	Object scripts are scripts attached to a particular game object. When that object starts an action, if script has an appropriate handler for this action it will be executed.		Object scripts are scripts attached to a particular game object. When that object starts an action, if script has an appropriate handler for this action it will be executed.

			=== Events ===
			[[VoidExpanse/events\|List of Events]]

Damonwall at 03:39, 25 March 2014

2014-03-25T03:39:34Z

Show changes

Damonwall: Undo revision 136 by Damonwall (talk)

2014-03-25T03:37:15Z

Undo revision 136 by Damonwall (talk)

← Older revision		Revision as of 03:37, 25 March 2014
Line 66:		Line 66:
	====Loading game====		====Loading game====
	When server starts, you can create a new game, or load an existing one.		When server starts, you can create a new game, or load an existing one.
	To load an existing game, use command:		To load an existing game, use command
	<pre>-load [slot_number]</pre>		<pre>-load [slot_number]</pre>, for example, <pre>-load 0</pre>.
	You can use the same command not only when server starts, but even during the game, just type in console:		You can use the same command not only when server starts, but even during the game, just type in console:
	<pre>load 0</pre>		<pre>load 0</pre>, and game from specified slot will be loaded.

Damonwall: /* Loading game */

2014-03-25T03:29:32Z

Loading game

← Older revision		Revision as of 03:29, 25 March 2014
Line 66:		Line 66:
	====Loading game====		====Loading game====
	When server starts, you can create a new game, or load an existing one.		When server starts, you can create a new game, or load an existing one.
	To load an existing game, use command		To load an existing game, use command:
	<pre>-load [slot_number]</pre>~~, for example, <pre>-load 0</pre>.~~		<pre>-load [slot_number]</pre>
	You can use the same command not only when server starts, but even during the game, just type in console:		You can use the same command not only when server starts, but even during the game, just type in console:
	<pre>load 0</pre>~~, and game from specified slot will be loaded.~~		<pre>load 0</pre>

Damonwall at 03:28, 25 March 2014

2014-03-25T03:28:43Z

← Older revision		Revision as of 03:28, 25 March 2014
Line 22:		Line 22:
	=== Launch ===		=== Launch ===

	~~'''~~Windows~~'''~~		====Windows====
	Launch AtomicTorch.SpaceRPG.Server.RuntimeWin.exe from ./Server/ folder.		Launch AtomicTorch.SpaceRPG.Server.RuntimeWin.exe from ./Server/ folder.

	~~'''~~Other system with Mono~~'''~~		====Other system with Mono====
	Launch AtomicTorch.SpaceRPG.Server.RuntimeWin.exe from ./Server/Mono folder with mono,		Launch AtomicTorch.SpaceRPG.Server.RuntimeWin.exe from ./Server/Mono folder with mono,
	like this:		like this:
Line 46:		Line 46:
	'''Create a new game'''		'''Create a new game'''
	When server starts, you can create a new game, or load an existing one.		When server starts, you can create a new game, or load an existing one.
	To create a new game, type		To create a new game, type to create a new server^
	<pre>-new [seed_key]</pre>		<pre>-new [seed_key]</pre>
	~~to create a new server.~~		Seed_key is a word, which is used like seed value for random-based generation, like "voidexpance" or "hellyeah", which will affect world generation on server.
	Seed_key is a word, like "voidexpance" or "hellyeah", which will affect world generation on server.
	For example, if you type		For example, if you type
	<pre>-new myworld</pre>		<pre>-new myworld</pre>
Line 59:		Line 58:


	~~'''~~Saving game~~'''~~		====Saving game====
	In multiplayer mode, server automatically saves game every time interval, specified in SettingsServer.xml (autosave_delay parameter).		In multiplayer mode, server automatically saves game every time interval, specified in SettingsServer.xml (autosave_delay parameter).
	You can save server game with console command ''savegame''.		You can save server game with console command ''savegame''.
Line 65:		Line 64:
	<pre>savegame 5 ServerNameWord</pre> - will save you game to slot 5 under the name "ServerNameWord".		<pre>savegame 5 ServerNameWord</pre> - will save you game to slot 5 under the name "ServerNameWord".

	~~'''~~Loading game~~'''~~		====Loading game====
	When server starts, you can create a new game, or load an existing one.		When server starts, you can create a new game, or load an existing one.
	To load an existing game, use command		To load an existing game, use command

Damonwall at 03:25, 25 March 2014

2014-03-25T03:25:40Z

Show changes

← Older revision		Revision as of 03:27, 25 July 2014
Line 2:		Line 2:

	== Basic concepts ==		== Basic concepts ==
	Scripting is done via actions that custom scripts can subscribe to. There are number of actions that are called by ~~server~~ automatically, plus users can create their own actions and call them when needed. This also makes possible for users to create scripting frameworks for others to use.		Scripting is done via actions that custom scripts can subscribe to. There are a number of actions that are called by servers automatically, plus users can create their own actions and call them when needed. This also makes it possible for users to create scripting frameworks/libraries for others to use.
	Each action has one argument (ΓÇ£argsΓÇ¥) that is a JavaScript object containing several ~~variables inside~~ depending on ~~a particular~~ action. In some actions this ΓÇ£argsΓÇ¥ object can be empty. But either way it allows for unified format for all actions within the scripting system.		Each action has one argument (ΓÇ£argsΓÇ¥) that is a JavaScript object containing several properties depending on which action is being called. In some actions this ΓÇ£argsΓÇ¥ object can be empty. But either way, it allows for a unified format for all actions within the scripting system.

	=== Scripting naming convention ===		=== Scripting naming convention ===
	* String IDΓÇÖs in mods can only contain alphanumeric characters and underscores. Any other characters are illegal.		* String IDΓÇÖs in mods can only contain alphanumeric characters and underscores. Any other characters are illegal.
	* ~~Using~~ underscore for variables and properties.		* Use underscore for variables and properties.
	* ~~Using~~ CamelCase for functions and methods.		* Use CamelCase for functions and methods.
	* zxc_q - ΓÇ£qΓÇ¥ in the variable always represents ΓÇ£quantityΓÇ¥ or ΓÇ£number of ...ΓÇ¥.		* zxc_q - ΓÇ£qΓÇ¥ in the variable always represents ΓÇ£quantityΓÇ¥ or ΓÇ£number of ...ΓÇ¥.
	* zxc_id - ΓÇ£idΓÇ¥ always means either string id from XML file if it is of the type of string, or if it is uint then it is entity (instance) id of some object.		* zxc_id - ΓÇ£idΓÇ¥ always means either a string id from a XML file if it is of the type of string, or if it is a uint then it is an entity (instance) id of some object.
	* zxc_req - ΓÇ£reqΓÇ¥ always means ΓÇ£requirementsΓÇ¥.		* zxc_req - ΓÇ£reqΓÇ¥ always means ΓÇ£requirementsΓÇ¥.
	* All mods should prefix their variables, functions, classes, storage keys ~~and all the rest~~ with a key for isolation from other mods, example of such prefix would be ΓÇ£prf_ΓÇ¥ -> ΓÇ£prf_some_variableΓÇ¥, ΓÇ£prf_SomeFunctionΓÇ¥.		* All mods should prefix their variables, functions, classes, storage keys, etc with a key for isolation from other mods. An example of such a prefix would be ΓÇ£prf_ΓÇ¥ -> ΓÇ£prf_some_variableΓÇ¥, ΓÇ£prf_SomeFunctionΓÇ¥.

	=== Internal scripts (Overridable) ===		=== Internal scripts (Overridable) ===
	{{Main\|VoidExpanse/Internal_scripts\|Internal scripts}}		{{Main\|VoidExpanse/Internal_scripts\|Internal scripts}}
	These scripts are called ~~usually~~ once and only in a particular situation. Each of these script files must exist in only one instance. If a new script is added the previous one will be overridden. Each of the script files must implement only one script action. Usually players should not modify these scripts unless they want to completely re-implement some game feature.		These scripts are usually only called once and only in a particular situation. Each of these script files must exist in only one instance. If a new script is added the previous one will be overridden. Each of the script files must implement only one script action. Usually players should not modify these scripts unless they want to completely re-implement some game feature.

	=== Global scripts (called in the world dynamically) ===		=== Global scripts (called in the world dynamically) ===
Line 24:		Line 24:
	=== Object scripts ===		=== Object scripts ===
	{{Main\|VoidExpanse/Object_scripts\|Object scripts}}		{{Main\|VoidExpanse/Object_scripts\|Object scripts}}
	Object scripts are scripts attached to a particular game object. When that object starts an action, if script has an appropriate handler for this action it will be executed.		Object scripts are scripts attached to a particular game object. When that object starts an action, if a script has an appropriate handler for this action it will be executed.

	=== Events ===		=== Events ===
Line 33:		Line 33:

	=== Library inclusion and scopes usage ===		=== Library inclusion and scopes usage ===
	Preprocessor directive <code>include(libname.js);</code> includes a library ~~scripts~~ into a current JS instance. Library scripts also ~~can~~ include ~~each~~ other (no echo effect will appear).		Preprocessor directive <code>include(libname.js);</code> includes a library script into the current JS instance. Library scripts can also include other libraries (no echo effect will appear).

	Allows to use functions and objects of these libraries in this particular script instance.		Allows modders to use functions and objects of these libraries in this particular script instance.
	* ~~Inclusions of libraries~~ directive must be the first lines in the script file (not necessarily, but preferably - to maintain order in scripts).		* Include directive must be the first lines in the script file (not necessarily, but preferably - to maintain order in scripts).
	* All include directives must be before first function declaration.		* All include directives must be before the first function declaration in the file.

	Preprocessor directive <code>using(scopename);</code> allows to use specific scope in a specific script. Scope name must be an existing scope name (see scopes below). Except for some specific scopes (like topic or npc), which are available only in specific places, like topic scripts or AI behaviors.		Preprocessor directive <code>using(scopename);</code> allows modders to use a specific scope in a specific script. Scope name must be an existing scope name (see scopes below). Except for some specific scopes (like topic or npc), which are available only in specific places, like topic scripts or AI behaviors.

	=== Scopes ===		=== Scopes ===
Line 67:		Line 67:
	== Device scripts ==		== Device scripts ==
	{{Main\|VoidExpanse/Device_scripts\|Device scripts}}		{{Main\|VoidExpanse/Device_scripts\|Device scripts}}
	Devices uses effect scripts, which is similar to any object scripts, but uses itΓÇÖs own special system of arguments. These scripts are shared between instances of the same device type, therefore global variables in ~~this~~ scripts are denied.		Devices uses effect scripts, which is similar to any object scripts, but uses itΓÇÖs own special system of arguments. These scripts are shared between instances of the same device type, therefore global variables in these scripts are denied.

	There are four possible functions for device script.		There are four possible functions for device script.
Line 74:		Line 74:
	== Consumables scripting ==		== Consumables scripting ==
	{{Main\|VoidExpanse/Consumable_scripting\|Consumables scripting}}		{{Main\|VoidExpanse/Consumable_scripting\|Consumables scripting}}
	Consumables can be programmed with ~~standart~~ xml-values, but, in order to implement something		Consumables can be programmed with standard xml-values, but, in order to implement something
	special, one can use special techniques, described in this article.		special, one can use special techniques described in this article.