Revision as of 02:19, 13 February 2014

Config scope

Used to get access to server variables from config file.

Visibility: Globall.

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 7: / Line 7: @@
 {{Scripting_api|GetFlag|
-* String: name|
+* string: name|
-Boolean - whether the flag is set or not.|
+bool - whether the flag is set or not.|
 <nowiki>var a = config.GetFlag("some_var");</nowiki> |
 Returns a boolean server flag value by name. Basically used to read server config options.
 }}
-{{Scripting_api|GetValue|
+{{Scripting_api|GetSetting|
-* String: name|
+* string: name|
-Mixed - a particular value of config.|
+object - a particular value of config.|
-<nowiki>var a = config.GetValue("some_var");</nowiki>|
+<nowiki>var a = config.GetSetting("some_var");</nowiki>|
-Returns a server variable value by name. Basically used to read server config options. Standard return types are string, integer, float, etc.
+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 |
+<nowiki>config.Wait(1000); //wait for 1 second</nowiki>|
+Makes main thread to wait for specified time in milliseconds.
 }}