Skip to main content

ProgressState

Represents a single state in a Progress

Functions​

new​

</>
ProgressState:new(
init: (state: ProgressState) → (string | nil),--

init function

update: (state: ProgressState) → (string | nil),--

update function

exit: (state: ProgressState) → (string | nil)--

exit function

) → ()

Construct a new ProgressState

elementAdd​

</>
ProgressState:elementAdd(
element: table--

element object

) → ()

Adds an element to the state

elementUpdate​

</>
ProgressState:elementUpdate() → ()

Updates all elements in the state

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Construct a new ProgressState",
            "params": [
                {
                    "name": "init",
                    "desc": "init function",
                    "lua_type": "(state: ProgressState) -> (string | nil)"
                },
                {
                    "name": "update",
                    "desc": "update function",
                    "lua_type": "(state: ProgressState) -> (string | nil)"
                },
                {
                    "name": "exit",
                    "desc": "exit function",
                    "lua_type": "(state: ProgressState) -> (string | nil)"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 13,
                "path": "../../res/data/script/lib/env/progress_state.lua"
            }
        },
        {
            "name": "elementAdd",
            "desc": "Adds an element to the state",
            "params": [
                {
                    "name": "element",
                    "desc": "element object",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 27,
                "path": "../../res/data/script/lib/env/progress_state.lua"
            }
        },
        {
            "name": "elementUpdate",
            "desc": "Updates all elements in the state",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 34,
                "path": "../../res/data/script/lib/env/progress_state.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "ProgressState",
    "desc": "Represents a single state in a Progress",
    "source": {
        "line": 5,
        "path": "../../res/data/script/lib/env/progress_state.lua"
    }
}