Skip to main content

InputModeProcessor

Process inputs by evaluating inputModes. Helper object..

Functions​

new​

</>
InputModeProcessor.new(inputModes: {InputMode}?) → InputModeProcessor

Construtcs a new inputModeProcessor

AddInputMode​

</>
InputModeProcessor.AddInputMode(
inputMode: InputMode
) → ()

Adds an input mode to the inputModeProcessor

GetStates​

</>
InputModeProcessor.GetStates(self: InputModeProcessor) → {InputMode}

Gets all input mode inputModes being used

Evaluate​

</>
InputModeProcessor.Evaluate(
inputObject: InputObject
) → ()

Applies the inputObject as an evaluation for the inputm odes

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Construtcs a new inputModeProcessor",
            "params": [
                {
                    "name": "inputModes",
                    "desc": "",
                    "lua_type": "{ InputMode }?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InputModeProcessor"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/inputmode/src/Client/InputModeProcessor.lua"
            }
        },
        {
            "name": "AddInputMode",
            "desc": "Adds an input mode to the inputModeProcessor",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InputModeProcessor"
                },
                {
                    "name": "inputMode",
                    "desc": "",
                    "lua_type": "InputMode"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 45,
                "path": "src/inputmode/src/Client/InputModeProcessor.lua"
            }
        },
        {
            "name": "GetStates",
            "desc": "Gets all input mode inputModes being used",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InputModeProcessor"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{ InputMode }"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 53,
                "path": "src/inputmode/src/Client/InputModeProcessor.lua"
            }
        },
        {
            "name": "Evaluate",
            "desc": "Applies the inputObject as an evaluation for the inputm odes",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InputModeProcessor"
                },
                {
                    "name": "inputObject",
                    "desc": "",
                    "lua_type": "InputObject"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 61,
                "path": "src/inputmode/src/Client/InputModeProcessor.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InputModeProcessor",
    "desc": "Process inputs by evaluating inputModes. Helper object..",
    "source": {
        "line": 6,
        "path": "src/inputmode/src/Client/InputModeProcessor.lua"
    }
}