Skip to main content

ControllerSystem

This item only works when running on the client. Client

Internal system for handling controllers

Types​

Controller​

</>
interface Controller {
Name: string
[any]: any
}

Properties​

Started​

This item is read only and cannot be modified. Read Only
</>
ControllerSystem.Started: boolean

Functions​

CreateController​

</>
ControllerSystem.CreateController(ControllerDef: ControllerDefinition) → Controller

Types

​

interface ControllerDefinition {
Name: string
[any]: any
}

Create a controller

GetController​

</>
ControllerSystem.GetController(Name: string) → Controller

Get a controller with the given name

GetModule​

</>
ControllerSystem.GetModule(Name: string) → Module

Get a Module with the given name

Add​

</>
ControllerSystem:Add(ControllerScript: ModuleScript) → ()

Add a controller

Exists​

</>
ControllerSystem:Exists(Name: string) → boolean

Check if a controller with the given name exists

Show raw api
{
    "functions": [
        {
            "name": "Add",
            "desc": "Add a controller",
            "params": [
                {
                    "name": "ControllerScript",
                    "desc": "",
                    "lua_type": "ModuleScript"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 47,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        },
        {
            "name": "CreateController",
            "desc": "Create a controller",
            "params": [
                {
                    "name": "ControllerDef",
                    "desc": "",
                    "lua_type": "ControllerDefinition"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Controller"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 58,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        },
        {
            "name": "Exists",
            "desc": "Check if a controller with the given name exists",
            "params": [
                {
                    "name": "Name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 76,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        },
        {
            "name": "Start",
            "desc": "Init and Start all controllers",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 88,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        },
        {
            "name": "GetController",
            "desc": "Get a controller with the given name",
            "params": [
                {
                    "name": "Name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Controller"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 141,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        },
        {
            "name": "GetModule",
            "desc": "Get a Module with the given name",
            "params": [
                {
                    "name": "Name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Module"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 151,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Started",
            "desc": "",
            "lua_type": "boolean",
            "readonly": true,
            "source": {
                "line": 24,
                "path": "Axis/Core/ControllerSystem.luau"
            }
        }
    ],
    "types": [
        {
            "name": "ControllerDefinition",
            "desc": "",
            "fields": [
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "[any]",
                    "lua_type": "any",
                    "desc": ""
                }
            ],
            "source": {
                "line": 44,
                "path": "Axis/Core/Types.luau"
            }
        },
        {
            "name": "Controller",
            "desc": "",
            "fields": [
                {
                    "name": "Name",
                    "lua_type": "string",
                    "desc": ""
                },
                {
                    "name": "[any]",
                    "lua_type": "any",
                    "desc": ""
                }
            ],
            "source": {
                "line": 55,
                "path": "Axis/Core/Types.luau"
            }
        }
    ],
    "name": "ControllerSystem",
    "desc": "Internal system for handling controllers",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 8,
        "path": "Axis/Core/ControllerSystem.luau"
    }
}