VoidExpanse/scope-config - Revision history

Damonwall at 03:58, 5 July 2014

2014-07-05T03:58:42Z

← Older revision		Revision as of 03:58, 5 July 2014
Line 8:		Line 8:

	== List of functions ==		== List of functions ==

	~~{{Scripting_api\|GetFlag\|~~
	* string: name\|
	~~bool - whether the flag is set or not.\|~~
	~~<pre style="margin:0px">var a = config.GetFlag("some_var");</pre> \|~~
	~~Returns a boolean server flag value by name. Basically used to read server config options.~~
	}}

	{{Scripting_api\|GetSetting\|		{{Scripting_api\|GetSetting\|
	* string: name\|		* string: name\|
	~~object~~ - a particular value of config.\|		string- a particular value of config.\|
	<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|		<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|
	Returns a server variable value by name. Basically used to read server config options from script~~. Standard return types are string, int, float, boolean~~.		Returns a server variable value by name. Basically used to read server config options from script.
	}}		}}

Atomic-admin at 09:57, 18 February 2014

2014-02-18T09:57:47Z

← Older revision		Revision as of 09:57, 18 February 2014
Line 21:		Line 21:
	<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|		<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|
	Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.		Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.
	}}

	~~{{Scripting_api\|Wait\|~~
	* int: time_ms\|
	~~void \|~~
	~~<pre style="margin:0px">config.Wait(1000); //wait for 1 second</pre>\|~~
	~~Makes main thread to wait for specified time in milliseconds.~~
	}}		}}

Damonwall: Undo revision 111 by Damonwall (talk)

2014-02-18T07:12:44Z

Undo revision 111 by Damonwall (talk)

← Older revision		Revision as of 07:12, 18 February 2014
Line 2:		Line 2:
	[[Category:VoidExpanse/api_scopes]]		[[Category:VoidExpanse/api_scopes]]
	</noinclude>		</noinclude>
	= ~~Timer~~ scope =		= Config scope =
	Used to ~~create and manage timers - delayed events. Timers only works inside it's script, but~~		Used to get access to server variables from config file.
	~~they're persistent through savegames~~.

	'''Visibility:''' Global.		'''Visibility:''' Global.
Line 10:		Line 9:
	== List of functions ==		== List of functions ==

	{{Scripting_api\|~~SetTimer~~\|		{{Scripting_api\|GetFlag\|
	* double: time_in_seconds		* string: name\|
	* string: ~~function_name~~		bool - whether the flag is set or not.\|
	* object: args		<pre style="margin:0px">var a = config.GetFlag("some_var");</pre> \|
	* int: loops (0 - infinite)\|		Returns a boolean server flag value by name. Basically used to read server config options.
	~~int~~ - ~~ID of created timer~~\|
	<pre style="margin:0px">var ~~timer~~ = ~~timer~~.~~SetTimer~~(5, "~~SomeFunction~~"~~, {what_to_say: "hello"}, 1~~);
	~~function SomeFunction( args )~~
	{
	~~console.Print("I was told to say " + args.what_to_say);~~
	}
	</pre> \|
	~~Creates~~ a ~~timed event, which will be executed after "time_in_seconds" interval~~. ~~Can be infinite loop~~.
	}}		}}

			{{Scripting_api\|GetSetting\|
			* string: name\|
			object - a particular value of config.\|
			<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|
			Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.
			}}

	{{Scripting_api\|~~ClearTimer~~\|		{{Scripting_api\|Wait\|
	* int: ~~timer_id~~\|		* int: time_ms\|
	void\|		void \|
	<pre style="margin:0px">~~timer~~.~~ClearTimer~~(5);</pre> \|		<pre style="margin:0px">config.Wait(1000); //wait for 1 second</pre>\|
	~~Removes timer with~~ specified ID.		Makes main thread to wait for specified time in milliseconds.
	}}		}}

Damonwall at 07:11, 18 February 2014

2014-02-18T07:11:24Z

← Older revision		Revision as of 07:11, 18 February 2014
Line 2:		Line 2:
	[[Category:VoidExpanse/api_scopes]]		[[Category:VoidExpanse/api_scopes]]
	</noinclude>		</noinclude>
	= ~~Config~~ scope =		= Timer scope =
	Used to ~~get access to server variables from config file~~.		Used to create and manage timers - delayed events. Timers only works inside it's script, but
			they're persistent through savegames.

	'''Visibility:''' Global.		'''Visibility:''' Global.
Line 9:		Line 10:
	== List of functions ==		== List of functions ==

	{{Scripting_api\|~~GetFlag~~\|		{{Scripting_api\|SetTimer\|
	* string: ~~name~~\|		* double: time_in_seconds
	~~bool~~ - ~~whether the flag is set or not.~~\|		* string: function_name
	<pre style="margin:0px">var a = ~~config~~.~~GetFlag~~("~~some_var~~");</pre> \|		* object: args
	~~Returns~~ a ~~boolean server flag value by name~~. ~~Basically used to read server config options~~.		* int: loops (0 - infinite)\|
			int - ID of created timer\|
			<pre style="margin:0px">var timer = timer.SetTimer(5, "SomeFunction", {what_to_say: "hello"}, 1);
			function SomeFunction( args )
			{
			console.Print("I was told to say " + args.what_to_say);
			}
			</pre> \|
			Creates a timed event, which will be executed after "time_in_seconds" interval. Can be infinite loop.
	}}		}}

	~~{{Scripting_api\|GetSetting\|~~
	* string: name\|
	~~object - a particular value of config.\|~~
	~~<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|~~
	~~Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.~~
	}}

	{{Scripting_api\|~~Wait~~\|		{{Scripting_api\|ClearTimer\|
	* int: ~~time_ms~~\|		* int: timer_id\|
	void \|		void\|
	<pre style="margin:0px">~~config~~.~~Wait~~(~~1000~~); ~~//wait for 1 second~~</pre>\|		<pre style="margin:0px">timer.ClearTimer(5);</pre> \|
	~~Makes main thread to wait for~~ specified ~~time in milliseconds~~.		Removes timer with specified ID.
	}}		}}

Damonwall: /* List of functions */

2014-02-13T03:44:50Z

List of functions

← Older revision		Revision as of 03:44, 13 February 2014
Line 12:		Line 12:
	* string: name\|		* string: name\|
	bool - whether the flag is set or not.\|		bool - whether the flag is set or not.\|
	<~~nowiki~~>var a = config.GetFlag("some_var");</~~nowiki~~> \|		<pre style="margin:0px">var a = config.GetFlag("some_var");</pre> \|
	Returns a boolean server flag value by name. Basically used to read server config options.		Returns a boolean server flag value by name. Basically used to read server config options.
	}}		}}
Line 19:		Line 19:
	* string: name\|		* string: name\|
	object - a particular value of config.\|		object - a particular value of config.\|
	<~~nowiki~~>var a = config.GetSetting("some_var");</~~nowiki~~>\|		<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>\|
	Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.		Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.
	}}		}}
Line 26:		Line 26:
	* int: time_ms\|		* int: time_ms\|
	void \|		void \|
	<~~nowiki~~>config.Wait(1000); //wait for 1 second</~~nowiki~~>\|		<pre style="margin:0px">config.Wait(1000); //wait for 1 second</pre>\|
	Makes main thread to wait for specified time in milliseconds.		Makes main thread to wait for specified time in milliseconds.
	}}		}}

Atomic-admin at 02:30, 13 February 2014

2014-02-13T02:30:40Z

← Older revision		Revision as of 02:30, 13 February 2014
Line 1:		Line 1:
	<noinclude>		<noinclude>
	[[Category:VoidExpanse/api_scopes~~\|API_scopes~~]]		[[Category:VoidExpanse/api_scopes]]
	</noinclude>		</noinclude>
	= Config scope =		= Config scope =

Atomic-admin at 02:30, 13 February 2014

2014-02-13T02:30:13Z

← Older revision		Revision as of 02:30, 13 February 2014
Line 1:		Line 1:
	<noinclude>		<noinclude>
	[[Category:VoidExpanse/api_scopes]]		[[Category:VoidExpanse/api_scopes\|API_scopes]]
	</noinclude>		</noinclude>
	= Config scope =		= Config scope =

Atomic-admin at 02:29, 13 February 2014

2014-02-13T02:29:43Z

← Older revision		Revision as of 02:29, 13 February 2014
Line 1:		Line 1:
	<noinclude>		<noinclude>
	[[Category:~~Templates~~]]		[[Category:VoidExpanse/api_scopes]]
	</noinclude>		</noinclude>
	= Config scope =		= Config scope =

Atomic-admin at 02:28, 13 February 2014

2014-02-13T02:28:59Z

← Older revision		Revision as of 02:28, 13 February 2014
Line 1:		Line 1:
			<noinclude>
			[[Category:Templates]]
			</noinclude>
	= Config scope =		= Config scope =
	Used to get access to server variables from config file.		Used to get access to server variables from config file.

Damonwall: /* Config scope */

2014-02-13T02:20:08Z

Config scope

← Older revision		Revision as of 02:20, 13 February 2014
Line 2:		Line 2:
	Used to get access to server variables from config file.		Used to get access to server variables from config file.

	'''Visibility:''' ~~Globall~~.		'''Visibility:''' Global.

	== List of functions ==		== List of functions ==