Skip to main content

HumanoidSpeed

This item only works when running on the server. Server

Manages speed of a humanoid

Functions​

new​

</>
HumanoidSpeed.new(
humanoid: Humanoid,
serviceBag: ServiceBag
) → HumanoidSpeed

Constructs a new HumanoidSpeed

SetDefaultSpeed​

</>
HumanoidSpeed:SetDefaultSpeed(defaultSpeed: number) → ()

Sets the default speed for the humanoid

ApplySpeedMultiplier​

</>
HumanoidSpeed:ApplySpeedMultiplier(multiplier: number) → function--

Cleanup function

Applies a speed multipler to the player's speed

ApplySpeedAdditive​

</>
HumanoidSpeed:ApplySpeedAdditive(amount: number) → function--

Cleanup function

Applies a speed additive to the player's speed

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructs a new HumanoidSpeed",
            "params": [
                {
                    "name": "humanoid",
                    "desc": "",
                    "lua_type": "Humanoid"
                },
                {
                    "name": "serviceBag",
                    "desc": "",
                    "lua_type": "ServiceBag"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "HumanoidSpeed"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "src/humanoidspeed/src/Server/HumanoidSpeed.lua"
            }
        },
        {
            "name": "SetDefaultSpeed",
            "desc": "Sets the default speed for the humanoid",
            "params": [
                {
                    "name": "defaultSpeed",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 37,
                "path": "src/humanoidspeed/src/Server/HumanoidSpeed.lua"
            }
        },
        {
            "name": "ApplySpeedMultiplier",
            "desc": "Applies a speed multipler to the player's speed",
            "params": [
                {
                    "name": "multiplier",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup function",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 46,
                "path": "src/humanoidspeed/src/Server/HumanoidSpeed.lua"
            }
        },
        {
            "name": "ApplySpeedAdditive",
            "desc": "Applies a speed additive to the player's speed",
            "params": [
                {
                    "name": "amount",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "Cleanup function",
                    "lua_type": "function"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 58,
                "path": "src/humanoidspeed/src/Server/HumanoidSpeed.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "HumanoidSpeed",
    "desc": "Manages speed of a humanoid",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 7,
        "path": "src/humanoidspeed/src/Server/HumanoidSpeed.lua"
    }
}