Skip to main content

Interface

The user interface

Interface.hud = "hidden"

Properties​

hud​

</>
Interface.hud: string

Get/Set the HUD mode

Modes

Name
enabled
disabled
hidden

mbar​

</>
Interface.mbar: bool

Get/Set the music bar visible state

critical_force​

</>
Interface.critical_force: bool

Get/Set the force flag of the critical display If true, the critical number will display even when zero

grade_visible​

</>
Interface.grade_visible: bool

Get/Set the flag for showing the grade in the HUD

Show raw api
{
    "functions": [],
    "properties": [
        {
            "name": "hud",
            "desc": "Get/Set the HUD mode\n\n### Modes\n| Name     |\n|----------|\n| enabled  |\n| disabled |\n| hidden   |",
            "lua_type": "string",
            "source": {
                "line": 24,
                "path": "../../res/data/script/lib/system/interface.lua"
            }
        },
        {
            "name": "mbar",
            "desc": "Get/Set the music bar visible state",
            "lua_type": "bool",
            "source": {
                "line": 31,
                "path": "../../res/data/script/lib/system/interface.lua"
            }
        },
        {
            "name": "critical_force",
            "desc": "Get/Set the force flag of the critical display\nIf true, the critical number will display even when zero",
            "lua_type": "bool",
            "source": {
                "line": 39,
                "path": "../../res/data/script/lib/system/interface.lua"
            }
        },
        {
            "name": "grade_visible",
            "desc": "Get/Set the flag for showing the grade in the HUD",
            "lua_type": "bool",
            "source": {
                "line": 46,
                "path": "../../res/data/script/lib/system/interface.lua"
            }
        }
    ],
    "types": [],
    "name": "Interface",
    "desc": "The user interface\n\n```lua\nInterface.hud = \"hidden\"\n```",
    "source": {
        "line": 9,
        "path": "../../res/data/script/lib/system/interface.lua"
    }
}