Skip to main content

RiggedAnimationModel

Extends AnimationModel Implementation of an Animation rig for Roblox Animations

Functions​

new​

Constructor
</>
RiggedAnimationModel.new(
model: Model,
useJoints: boolean?
) → RiggedAnimationModel

getDataFromInstance​

</>
RiggedAnimationModel.getDataFromInstance(model: Model) → Result<RiggedAnimationModelData,string>

Types

​

interface RiggedAnimationModelData {
useJoints: boolean
}

Extracts data from an Instance

create​

</>
RiggedAnimationModel.create(model: Model) → Result

Creates a RiggedAnimationModel with the given Instance. Returns a Result.

getJointMap​

</>
RiggedAnimationModel.getJointMap(model: Model) → JointNodeMap

Types

​

interface JointNode {
joint: Motor6D
subJoints: {[string]: JointNode}
}

​

type JointNodeMap = {[string]: JointNode}

Returns a map of the joints for this Model. This is the current rig of the Model.

setRig​

</>
RiggedAnimationModel:setRig(rigCFrames: RobloxAnimationCFrameTrack.JointDataMap) → ()

Sets the current joint positions of this Model's rig

update​

</>
RiggedAnimationModel:update(
position: number,
modelDirection: Direction,
currentTrack: CFrameTrack?
) → ()

Updates the current position of this model in the workspace. Fires the onUpdated Signal.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                },
                {
                    "name": "useJoints",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RiggedAnimationModel"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 33,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "getDataFromInstance",
            "desc": "Extracts data from an Instance",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result<RiggedAnimationModelData, string>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 57,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "create",
            "desc": "Creates a RiggedAnimationModel with the given Instance.\nReturns a Result.",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 103,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "getJointMap",
            "desc": "Returns a map of the joints for this Model.\nThis is the current rig of the Model.",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Model"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "JointNodeMap"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 129,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "_setData",
            "desc": "Sets the data of this RiggedAnimationModel",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "RiggedAnimationModelData"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 204,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "setRig",
            "desc": "Sets the current joint positions of this Model's rig",
            "params": [
                {
                    "name": "rigCFrames",
                    "desc": "",
                    "lua_type": "RobloxAnimationCFrameTrack.JointDataMap"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 212,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates the current position of this model in the workspace.\nFires the `onUpdated` Signal.",
            "params": [
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "modelDirection",
                    "desc": "",
                    "lua_type": "Direction"
                },
                {
                    "name": "currentTrack",
                    "desc": "",
                    "lua_type": "CFrameTrack?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 252,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "JointNode",
            "desc": "",
            "fields": [
                {
                    "name": "joint",
                    "lua_type": "Motor6D",
                    "desc": ""
                },
                {
                    "name": "subJoints",
                    "lua_type": "{[string]: JointNode}",
                    "desc": ""
                }
            ],
            "source": {
                "line": 13,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "JointNodeMap",
            "desc": "",
            "lua_type": "{[string]: JointNode}",
            "source": {
                "line": 20,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        },
        {
            "name": "RiggedAnimationModelData",
            "desc": "",
            "fields": [
                {
                    "name": "useJoints",
                    "lua_type": "boolean",
                    "desc": ""
                }
            ],
            "source": {
                "line": 49,
                "path": "src/shared/animationModel/RiggedModel.lua"
            }
        }
    ],
    "name": "RiggedAnimationModel",
    "desc": "Extends [AnimationModel](/api/AnimationModel)\nImplementation of an Animation rig for Roblox Animations",
    "source": {
        "line": 25,
        "path": "src/shared/animationModel/RiggedModel.lua"
    }
}