Skip to main content

WheelSetOffsetsUtil

Utility for modifying wheelset offsets

Functions​

getLength​

</>
WheelSetOffsetsUtil.getLength(offsets: {number}) → number

Returns the length

reverse​

</>
WheelSetOffsetsUtil.reverse(offsets: {number}) → table

Reverses the given positionOffsets but keeps the midPoint at the same position as the un-reversed version

normalize​

</>
WheelSetOffsetsUtil.normalize(offsets: {number}) → {number}

Normalizes

adjustMidPoint​

</>
WheelSetOffsetsUtil.adjustMidPoint(
offsets: {number},
alpha: number
) → {number}

Adjusts the midpoint of the offsets using the given alpha

Show raw api
{
    "functions": [
        {
            "name": "getLength",
            "desc": "Returns the length",
            "params": [
                {
                    "name": "offsets",
                    "desc": "",
                    "lua_type": "{number}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 11,
                "path": "src/shared/animationModel/trainModel/cframeTrain/wheelSetOffsetsUtil.lua"
            }
        },
        {
            "name": "reverse",
            "desc": "Reverses the given positionOffsets but keeps the midPoint at the same position as the un-reversed version",
            "params": [
                {
                    "name": "offsets",
                    "desc": "",
                    "lua_type": "{number}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 25,
                "path": "src/shared/animationModel/trainModel/cframeTrain/wheelSetOffsetsUtil.lua"
            }
        },
        {
            "name": "normalize",
            "desc": "Normalizes",
            "params": [
                {
                    "name": "offsets",
                    "desc": "",
                    "lua_type": "{number}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{number}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 49,
                "path": "src/shared/animationModel/trainModel/cframeTrain/wheelSetOffsetsUtil.lua"
            }
        },
        {
            "name": "adjustMidPoint",
            "desc": "Adjusts the midpoint of the offsets using the given alpha",
            "params": [
                {
                    "name": "offsets",
                    "desc": "",
                    "lua_type": "{number}"
                },
                {
                    "name": "alpha",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "{number}"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 70,
                "path": "src/shared/animationModel/trainModel/cframeTrain/wheelSetOffsetsUtil.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "WheelSetOffsetsUtil",
    "desc": "Utility for modifying wheelset offsets",
    "source": {
        "line": 3,
        "path": "src/shared/animationModel/trainModel/cframeTrain/wheelSetOffsetsUtil.lua"
    }
}