Skip to main content

Globals

Globally accessible from any script

Functions​

Checkpoint​

</>
Globals.Checkpoint() → ()

Saves the game when auto-save is enabled and not in debug mode

Global​

</>
Globals.Global(
key: string,--

variable path

options: table--

settings

) → ()

Shortcut for World.var_global

Regional​

</>
Globals.Regional(
key: string,--

variable path

options: table--

settings

) → ()

Shortcut for World.var_regional

Local​

</>
Globals.Local(
key: string,--

variable path

options: table--

settings

) → ()

Shortcut for World.var_local

Show raw api
{
    "functions": [
        {
            "name": "Checkpoint",
            "desc": "Saves the game when auto-save is enabled and not in debug mode",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 29,
                "path": "../../res/data/script/lib/init.lua"
            }
        },
        {
            "name": "Global",
            "desc": "Shortcut for `World.var_global`",
            "params": [
                {
                    "name": "key",
                    "desc": "variable path",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 44,
                "path": "../../res/data/script/lib/init.lua"
            }
        },
        {
            "name": "Regional",
            "desc": "Shortcut for `World.var_regional`",
            "params": [
                {
                    "name": "key",
                    "desc": "variable path",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "../../res/data/script/lib/init.lua"
            }
        },
        {
            "name": "Local",
            "desc": "Shortcut for `World.var_local`",
            "params": [
                {
                    "name": "key",
                    "desc": "variable path",
                    "lua_type": "string"
                },
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "../../res/data/script/lib/init.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "Globals",
    "desc": "Globally accessible from any script",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/init.lua"
    }
}