Skip to main content

JumpButtonUtils

Utility functions to deal with Roblox's mobile jump button and its position

Functions​

getJumpButtonPositionAndSize​

</>
JumpButtonUtils.getJumpButtonPositionAndSize(screenGuiAbsSize: Vector2) → (
Vector2,--

Position

number--

Width

)

Computes the jump button's position and size based upon Roblox's logic.

Show raw api
{
    "functions": [
        {
            "name": "getJumpButtonPositionAndSize",
            "desc": "Computes the jump button's position and size based upon Roblox's logic.",
            "params": [
                {
                    "name": "screenGuiAbsSize",
                    "desc": "",
                    "lua_type": "Vector2"
                }
            ],
            "returns": [
                {
                    "desc": "Position",
                    "lua_type": "Vector2"
                },
                {
                    "desc": "Width",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 14,
                "path": "src/jumpbuttonutils/src/Client/JumpButtonUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "JumpButtonUtils",
    "desc": "Utility functions to deal with Roblox's mobile jump button and its position",
    "source": {
        "line": 5,
        "path": "src/jumpbuttonutils/src/Client/JumpButtonUtils.lua"
    }
}