Skip to main content

Pipeline

Pipelines represent a set of ordered Phases. Systems cannot be assigned to Pipelines themselves, but rather to Phases within those Pipelines.

Properties​

Startup​

</>
Pipeline.Startup: Pipeline

A Pipeline containing the PreStartup, Startup, and PostStartup phases.

Functions​

new​

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

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

insert​

</>
Pipeline:insert(phase: Phase) → Pipeline

Adds a Phase to the Pipeline, ordering it implicitly.

insertAfter​

</>
Pipeline:insertAfter(
phase: Phase,
after: Phase
) → Pipeline

Adds a Phase to the Pipeline after another Phase, ordering it explicitly.

insertBefore​

</>
Pipeline:insertBefore(
phase: Phase,
before: Phase
) → Pipeline

Adds a Phase to the Pipeline before another Phase, ordering it explicitly.

Show raw api
{
    "functions": [
        {
            "name": "insert",
            "desc": "Adds a Phase to the Pipeline, ordering it implicitly.\r",
            "params": [
                {
                    "name": "phase",
                    "desc": "",
                    "lua_type": "Phase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Pipeline"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 23,
                "path": "src/Pipeline.luau"
            }
        },
        {
            "name": "insertAfter",
            "desc": "Adds a Phase to the Pipeline after another Phase, ordering it explicitly.\r",
            "params": [
                {
                    "name": "phase",
                    "desc": "",
                    "lua_type": "Phase"
                },
                {
                    "name": "after",
                    "desc": "",
                    "lua_type": "Phase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Pipeline"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 35,
                "path": "src/Pipeline.luau"
            }
        },
        {
            "name": "insertBefore",
            "desc": "Adds a Phase to the Pipeline before another Phase, ordering it explicitly.\r",
            "params": [
                {
                    "name": "phase",
                    "desc": "",
                    "lua_type": "Phase"
                },
                {
                    "name": "before",
                    "desc": "",
                    "lua_type": "Phase"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Pipeline"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 53,
                "path": "src/Pipeline.luau"
            }
        },
        {
            "name": "new",
            "desc": "Creates a new Pipeline, 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": 68,
                "path": "src/Pipeline.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Startup",
            "desc": "A Pipeline containing the `PreStartup`, `Startup`, and `PostStartup` phases.\r",
            "lua_type": "Pipeline",
            "source": {
                "line": 81,
                "path": "src/Pipeline.luau"
            }
        }
    ],
    "types": [],
    "name": "Pipeline",
    "desc": "Pipelines represent a set of ordered Phases. Systems cannot be\nassigned to Pipelines themselves, but rather to Phases within\nthose Pipelines.\r",
    "source": {
        "line": 10,
        "path": "src/Pipeline.luau"
    }
}