Latest revision as of 03:58, 5 July 2014

Config scope

Used to get access to server variables from config file.

Visibility: Global.

GetSetting
Arguments	Returns	Example
string: name	string- 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.

@@ Line 1: / Line 1: @@
-{{Scripting_api|GetFlag|
+<noinclude>
-* String: name|
+[[Category:VoidExpanse/api_scopes]]
-Boolean - whether the flag is set or not.|
+</noinclude>
-var a = config.GetFlag("some_var");|
+= Config scope =
-Returns a boolean server flag value by name. Basically used to read server config options.
+Used to get access to server variables from config file.
-}}
-{{Scripting_api|GetValue|
+'''Visibility:''' Global.
-* String: name|
-Mixed - a particular value of config.|
+== List of functions ==
-var a = config.GetValue("some_var");|
-Returns a server variable value by name. Basically used to read server config options. Standard return types are string, integer, float, etc.
+{{Scripting_api|GetSetting|
+* string: name|
+string- 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.
 }}