Revision as of 07:12, 18 February 2014

Config scope

Used to get access to server variables from config file.

Visibility: Global.

List of functions

GetFlag
Arguments	Returns	Example
string: name	bool - whether the flag is set or not.	var a = config.GetFlag("some_var");
Description
Returns a boolean server flag value by name. Basically used to read server config options.

GetSetting
Arguments	Returns	Example
string: name	object - a particular value of config.	var a = config.GetSetting("some_var");
Description
Returns a server variable value by name. Basically used to read server config options from script. Standard return types are string, int, float, boolean.

Wait
Arguments	Returns	Example
int: time_ms	void	config.Wait(1000); //wait for 1 second
Description
Makes main thread to wait for specified time in milliseconds.

@@ Line 2: / Line 2: @@
 [[Category:VoidExpanse/api_scopes]]
 </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.
@@ Line 10: / Line 9: @@
 == 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.
 }}