Skip to main content

Phase

Phases represent tags that tell the scheduler when to schedule a set of systems.

Properties​

PreStartup​

</>
Phase.PreStartup: Phase

Runs before the Startup Phase.

Startup​

</>
Phase.Startup: Phase

This Phase will run once, the first time the Scheduler is ran, before any other Phases are ran.

PostStartup​

</>
Phase.PostStartup: Phase

Runs after the Startup phase.

Functions​

new​

</>
Phase.new(name: string?) → ()

Creates a new Phase, with an optional name to use for debugging. When no name is provided, the script and line number will be used.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new Phase, with an optional name to use for debugging.\nWhen no name is provided, the script and line number will be used.\r",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 16,
                "path": "src/planck/src/Phase.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "PreStartup",
            "desc": "Runs before the `Startup` Phase.\r",
            "lua_type": "Phase",
            "source": {
                "line": 27,
                "path": "src/planck/src/Phase.luau"
            }
        },
        {
            "name": "Startup",
            "desc": "This Phase will run once, the first time the Scheduler is ran,\nbefore any other Phases are ran.\r",
            "lua_type": "Phase",
            "source": {
                "line": 32,
                "path": "src/planck/src/Phase.luau"
            }
        },
        {
            "name": "PostStartup",
            "desc": "Runs after the `Startup` phase.\r",
            "lua_type": "Phase",
            "source": {
                "line": 36,
                "path": "src/planck/src/Phase.luau"
            }
        }
    ],
    "types": [],
    "name": "Phase",
    "desc": "Phases represent tags that tell the scheduler when to\nschedule a set of systems.\r",
    "source": {
        "line": 5,
        "path": "src/planck/src/Phase.luau"
    }
}