Skip to main content

RxHumanoidUtils

Functions

observeRunningSpeed

RxHumanoidUtils.observeRunningSpeed(humanoidHumanoid) → Observable<number>

Observes the running speed of a humanoid

TIP

When using :MoveTo this is the only way to know if the humanoid is walking at any speed

observeHumanoidStateType

RxHumanoidUtils.observeHumanoidStateType(humanoidHumanoid) → Observable.Observable<Enum.HumanoidStateType>

Observes a humanoid's HumanoidStateType

observeHumanoidStateEnabled

RxHumanoidUtils.observeHumanoidStateEnabled(
humanoidHumanoid,
stateTypeEnum.HumanoidStateType
) → Observable<boolean>

Observes whether a humanoid state type is enabled on the humanoid.

observeJumpEnabled

RxHumanoidUtils.observeJumpEnabled(humanoidHumanoid) → Observable<boolean>

Observes whether the humanoid is allowed to jump. This is true when the jumping state is enabled and the humanoid's jump strength is above zero, which is the strength Roblox reads for the humanoid's Humanoid.UseJumpPower mode.

Show raw api
{
    "functions": [
        {
            "name": "observeRunningSpeed",
            "desc": "Observes the running speed of a humanoid\n\n:::tip\nWhen using :MoveTo this is the only way to know if the humanoid is walking at any speed\n:::",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<number>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/humanoidutils/src/Shared/RxHumanoidUtils.lua"
            }
        },
        {
            "name": "observeHumanoidStateType",
            "desc": "Observes a humanoid's HumanoidStateType",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable.Observable<Enum.HumanoidStateType>\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 71,
                "path": "src/humanoidutils/src/Shared/RxHumanoidUtils.lua"
            }
        },
        {
            "name": "observeHumanoidStateEnabled",
            "desc": "Observes whether a humanoid state type is enabled on the humanoid.",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "stateType",
                    "desc": "",
                    "lua_type": "Enum.HumanoidStateType"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 103,
                "path": "src/humanoidutils/src/Shared/RxHumanoidUtils.lua"
            }
        },
        {
            "name": "observeJumpEnabled",
            "desc": "Observes whether the humanoid is allowed to jump. This is true when the jumping state is enabled\nand the humanoid's jump strength is above zero, which is the strength Roblox reads for the\nhumanoid's [Humanoid.UseJumpPower] mode.",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Observable<boolean>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 132,
                "path": "src/humanoidutils/src/Shared/RxHumanoidUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "RxHumanoidUtils",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/humanoidutils/src/Shared/RxHumanoidUtils.lua"
    }
}