Skip to main content

HumanoidUtils

General humanoid utility code.

Functions​

getHumanoid​

</>
HumanoidUtils.getHumanoid(
descendant: Instance--

Child of a humanoid model, like a limb

) → Humanoid?

Retrieves a humanoid from a descendant.

forceUnseatHumanoid​

</>
HumanoidUtils.forceUnseatHumanoid(humanoid: Humanoid) → ()

Forcefully unseats the humanoid. Useful when teleporting humanoid. Definitely a non-intuitive operation to do safely.

Show raw api
{
    "functions": [
        {
            "name": "getHumanoid",
            "desc": "Retrieves a humanoid from a descendant.",
            "params": [
                {
                    "name": "descendant",
                    "desc": "Child of a humanoid model, like a limb",
                    "lua_type": "Instance"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Humanoid?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 13,
                "path": "src/humanoidutils/src/Shared/HumanoidUtils.lua"
            }
        },
        {
            "name": "forceUnseatHumanoid",
            "desc": "Forcefully unseats the humanoid. Useful when teleporting humanoid.\nDefinitely a non-intuitive operation to do safely.",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 32,
                "path": "src/humanoidutils/src/Shared/HumanoidUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HumanoidUtils",
    "desc": "General humanoid utility code.",
    "source": {
        "line": 5,
        "path": "src/humanoidutils/src/Shared/HumanoidUtils.lua"
    }
}