Skip to main content

System

The system interface

Properties​

debug​

</>
System.debug: bool

Get the system debug flag

arcade​

</>
System.arcade: bool

Get the system arcade flag

demo​

</>
System.demo: bool

Get the system demo flag

Functions​

save​

</>
System.save(
options: table--

settings

) → ()

Saves the game state to the current slot

Options

Name Type Default Description
slot number - Override save slot
pos bool true Save current player position

load​

</>
System.load(
options: table--

settings

) → ()

Loads the game state from the current slot

Options

Name Type Default Description
slot number - Override save slot

exit​

</>
System.exit() → ()

Exit the game

Show raw api
{
    "functions": [
        {
            "name": "save",
            "desc": "Saves the game state to the current slot\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| slot            | number      |       - | Override save slot             |\n| pos             | bool        |    true | Save current player position   |",
            "params": [
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 39,
                "path": "../../res/data/script/lib/system/system.lua"
            }
        },
        {
            "name": "load",
            "desc": "Loads the game state from the current slot\n\n### Options\n| Name            | Type        | Default | Description                    |\n|-----------------|-------------|---------|--------------------------------|\n| slot            | number      |       - | Override save slot             |",
            "params": [
                {
                    "name": "options",
                    "desc": "settings",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 52,
                "path": "../../res/data/script/lib/system/system.lua"
            }
        },
        {
            "name": "exit",
            "desc": "Exit the game",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 59,
                "path": "../../res/data/script/lib/system/system.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "debug",
            "desc": "Get the system debug flag",
            "lua_type": "bool",
            "source": {
                "line": 13,
                "path": "../../res/data/script/lib/system/system.lua"
            }
        },
        {
            "name": "arcade",
            "desc": "Get the system arcade flag",
            "lua_type": "bool",
            "source": {
                "line": 20,
                "path": "../../res/data/script/lib/system/system.lua"
            }
        },
        {
            "name": "demo",
            "desc": "Get the system demo flag",
            "lua_type": "bool",
            "source": {
                "line": 27,
                "path": "../../res/data/script/lib/system/system.lua"
            }
        }
    ],
    "types": [],
    "name": "System",
    "desc": "The system interface",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/system/system.lua"
    }
}