VoidExpanse/scope-config: Difference between revisions

From AtomicTorchWiki
No edit summary
No edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<noinclude>
[[Category:VoidExpanse/api_scopes]]
</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.


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


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


{{Scripting_api|GetFlag|
{{Scripting_api|GetSetting|
* String: name|
* string: name|
Boolean - whether the flag is set or not.|
string- a particular value of config.|
<nowiki>var a = config.GetFlag("some_var");</nowiki> |
<pre style="margin:0px">var a = config.GetSetting("some_var");</pre>|
Returns a boolean server flag value by name. Basically used to read server config options.
Returns a server variable value by name. Basically used to read server config options from script.
}}
 
{{Scripting_api|GetValue|
* String: name|
Mixed - a particular value of config.|
<nowiki>var a = config.GetValue("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.
}}
}}

Latest revision as of 03:58, 5 July 2014


Config scope

Used to get access to server variables from config file.

Visibility: Global.

List of functions

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.