Skip to main content

IKUtils

Utilties for IK system

Functions​

getDampenedAngleClamp​

</>
IKUtils.getDampenedAngleClamp(
maxAngle: number,--

The maximum angle allowed

dampenAreaAngle: number,--

The area over which to dampen

dampenAreaFactor: number?--

The factor to use for dampening. Defaults to dampenAreaAngle.

) → (number) → number--

A function that takes an angle and returns a dampened angle

Returns a function that dampens angles approaching maxAngle.

Show raw api
{
    "functions": [
        {
            "name": "getDampenedAngleClamp",
            "desc": "Returns a function that dampens angles approaching maxAngle.",
            "params": [
                {
                    "name": "maxAngle",
                    "desc": "The maximum angle allowed",
                    "lua_type": "number"
                },
                {
                    "name": "dampenAreaAngle",
                    "desc": "The area over which to dampen",
                    "lua_type": "number"
                },
                {
                    "name": "dampenAreaFactor",
                    "desc": "The factor to use for dampening. Defaults to dampenAreaAngle.",
                    "lua_type": "number?"
                }
            ],
            "returns": [
                {
                    "desc": "A function that takes an angle and returns a dampened angle",
                    "lua_type": "(number) -> number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 17,
                "path": "src/ik/src/Shared/IKUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "IKUtils",
    "desc": "Utilties for IK system",
    "source": {
        "line": 6,
        "path": "src/ik/src/Shared/IKUtils.lua"
    }
}