VoidExpanse/scope-config: Difference between revisions

From AtomicTorchWiki
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>
<noinclude>
[[Category:VoidExpanse/api_scopes]]
[[Category:VoidExpanse/api_scopes|API_scopes]]
</noinclude>
</noinclude>
= Config scope =
= Config scope =

Revision as of 02:30, 13 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.