Skip to main content

MousePositionUtils

Functions​

mouseUserInputObjectToMousePosition​

</>
MousePositionUtils.mouseUserInputObjectToMousePosition(inputObject: InputObject) → Vector2?

Converts an InputObject to a mouse position if it's a mouse input, otherwise returns nil.

observeMousePosition​

</>
MousePositionUtils.observeMousePosition(initialInputObject: InputObject?) → Observable.Observable<Vector2>

Observes the mouse position based on UserInputService events. Optionally takes an initial InputObject to seed the position.

queryMousePositionFromUserInputService​

</>
MousePositionUtils.queryMousePositionFromUserInputService() → Vector2

Gets the same mouse position as we'd get from :GetMouse() call, with the gui insets accounted for

Show raw api
{
    "functions": [
        {
            "name": "mouseUserInputObjectToMousePosition",
            "desc": "Converts an InputObject to a mouse position if it's a mouse input, otherwise returns nil.",
            "params": [
                {
                    "name": "inputObject",
                    "desc": "",
                    "lua_type": "InputObject"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2?\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/inputobjectutils/src/Client/MousePositionUtils.lua"
            }
        },
        {
            "name": "observeMousePosition",
            "desc": "Observes the mouse position based on UserInputService events. Optionally takes an initial InputObject to seed the position.",
            "params": [
                {
                    "name": "initialInputObject",
                    "desc": "",
                    "lua_type": "InputObject?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Vector2>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 36,
                "path": "src/inputobjectutils/src/Client/MousePositionUtils.lua"
            }
        },
        {
            "name": "queryMousePositionFromUserInputService",
            "desc": "Gets the same mouse position as we'd get from :GetMouse() call, with the gui insets accounted for",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Vector2\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 87,
                "path": "src/inputobjectutils/src/Client/MousePositionUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "MousePositionUtils",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/inputobjectutils/src/Client/MousePositionUtils.lua"
    }
}