Skip to main content

AnimationModel

Base AnimationModel class

Properties​

onUpdated​

Signal
</>
AnimationModel.onUpdated: Signal

Fires when this AnimationModel is updated from it's ModelAnimationPlayer.

model​

</>
AnimationModel.model: Model

defaultCFrame​

</>
AnimationModel.defaultCFrame: CFrame

Functions​

new​

Constructor
</>
AnimationModel.new(model: Instance?) → AnimationModel

Constructor

Destroy​

Deconstructor
</>
AnimationModel:Destroy() → ()

Deconstructor

setInDefaultPosition​

</>
AnimationModel:setInDefaultPosition() → ()

Sets this model in it's default position This is the position used when it is not updating

update​

</>
AnimationModel: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": "Constructor",
            "params": [
                {
                    "name": "model",
                    "desc": "",
                    "lua_type": "Instance?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationModel"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 36,
                "path": "src/shared/animationModel/AnimationModel.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "Deconstructor",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 68,
                "path": "src/shared/animationModel/AnimationModel.lua"
            }
        },
        {
            "name": "setInDefaultPosition",
            "desc": "Sets this model in it's default position\nThis is the position used when it is not updating",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 79,
                "path": "src/shared/animationModel/AnimationModel.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": 88,
                "path": "src/shared/animationModel/AnimationModel.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "onUpdated",
            "desc": "Fires when this AnimationModel is updated from it's ModelAnimationPlayer.",
            "lua_type": "Signal",
            "tags": [
                "Signal"
            ],
            "source": {
                "line": 23,
                "path": "src/shared/animationModel/AnimationModel.lua"
            }
        },
        {
            "name": "model",
            "desc": "",
            "lua_type": "Model",
            "source": {
                "line": 26,
                "path": "src/shared/animationModel/AnimationModel.lua"
            }
        },
        {
            "name": "defaultCFrame",
            "desc": "",
            "lua_type": "CFrame",
            "source": {
                "line": 29,
                "path": "src/shared/animationModel/AnimationModel.lua"
            }
        }
    ],
    "types": [],
    "name": "AnimationModel",
    "desc": "Base AnimationModel class",
    "source": {
        "line": 18,
        "path": "src/shared/animationModel/AnimationModel.lua"
    }
}