Skip to main content

InputObjectUtils

Provides utility functions involving input objects

Functions​

isMouseUserInputType​

</>
InputObjectUtils.isMouseUserInputType(userInputType: UserInputType) → boolean

Returns whether a user input type involves the mouse.

isMouseButtonInputType​

</>
InputObjectUtils.isMouseButtonInputType(userInputType: UserInputType) → boolean

Returns whether a user input type is a mouse button specifically.

isSameInputObject​

</>
InputObjectUtils.isSameInputObject(
inputObject: InputObject,
otherInputObject: InputObject
) → boolean

Compares the two input objects and determines if they are the same thing. For example, a finger being dragged across a screen, or a mouse input being used as a cursor.

Show raw api
{
    "functions": [
        {
            "name": "isMouseUserInputType",
            "desc": "Returns whether a user input type involves the mouse.",
            "params": [
                {
                    "name": "userInputType",
                    "desc": "",
                    "lua_type": "UserInputType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 28,
                "path": "src/inputobjectutils/src/Client/InputObjectUtils.lua"
            }
        },
        {
            "name": "isMouseButtonInputType",
            "desc": "Returns whether a user input type is a mouse button specifically.",
            "params": [
                {
                    "name": "userInputType",
                    "desc": "",
                    "lua_type": "UserInputType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 40,
                "path": "src/inputobjectutils/src/Client/InputObjectUtils.lua"
            }
        },
        {
            "name": "isSameInputObject",
            "desc": "Compares the two input objects and determines if they are the same thing. For example,\na finger being dragged across a screen, or a mouse input being used as a cursor.",
            "params": [
                {
                    "name": "inputObject",
                    "desc": "",
                    "lua_type": "InputObject"
                },
                {
                    "name": "otherInputObject",
                    "desc": "",
                    "lua_type": "InputObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "src/inputobjectutils/src/Client/InputObjectUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InputObjectUtils",
    "desc": "Provides utility functions involving input objects",
    "source": {
        "line": 5,
        "path": "src/inputobjectutils/src/Client/InputObjectUtils.lua"
    }
}