Skip to main content

clientMovementInputUtil

A simple utility module which wraps PlayerModule and PlayerModule.ControlModule.

Functions​

thumbstickMoveVector​

</>
clientMovementInputUtil.thumbstickMoveVector() → Vector3

Returns the thumbstick move vector.

enableControls​

</>
clientMovementInputUtil.enableControls() → ()

Enables player controls.

disableControls​

</>
clientMovementInputUtil.disableControls() → ()

Disables player controls.

Show raw api
{
    "functions": [
        {
            "name": "thumbstickMoveVector",
            "desc": " \nReturns the thumbstick move vector.",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector3\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 19,
                "path": "src/clientMovementInputUtil/init.luau"
            }
        },
        {
            "name": "enableControls",
            "desc": " \nEnables player controls.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 27,
                "path": "src/clientMovementInputUtil/init.luau"
            }
        },
        {
            "name": "disableControls",
            "desc": " \nDisables player controls.",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 35,
                "path": "src/clientMovementInputUtil/init.luau"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "clientMovementInputUtil",
    "desc": " \n\nA simple utility module which wraps `PlayerModule` and `PlayerModule.ControlModule`.",
    "source": {
        "line": 6,
        "path": "src/clientMovementInputUtil/init.luau"
    }
}