Skip to main content

ModelAnimationPlayer_Client

This item only works when running on the client. Client

Types​

BindToAnimationPlayerType​

enum
</>
interface BindToAnimationPlayerType {
None: 0
State: 1
Time: 2
}

Sets how this ModelAnimationPlayer binds to another ModelAnimationPlayer. Used by the server to sync the current BindToAnimationPlayer state.

ModelAnimationPlayerSyncState​

</>
interface ModelAnimationPlayerSyncState {
hasBoundToAnimationPlayer: boolean
hasSetUpdateInterval: boolean
hasSetCanUpdateModel: boolean
bindToAnimationPlayerType: BindToAnimationPlayerType
boundAnimationPlayerName: string?
boundAnimationPlayerOffset: number
updateInterval: number
canUpdateModel: boolean
}

Functions​

new​

Constructor
</>
ModelAnimationPlayer_Client.new(
serverData: Folder,
animationPlayer: AnimationPlayer_Client,
getTrack: (trackName: string) → CFrameTrack,
getAnimationPlayer: (animationPlayerName: string) → ModelAnimationPlayer_Client
) → ModelAnimationPlayer_Client

Constructor

Destroy​

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

ready​

</>
ModelAnimationPlayer_Client:ready() → ()

Sets AnimationPlayer as ready to receive updates

unready​

</>
ModelAnimationPlayer_Client:unready() → ()

Sets AnimationPlayer as NOT ready to receive updates

update​

override
</>
ModelAnimationPlayer_Client:update(stepped: number) → ()

Updates this ModelAnimationPlayer_Client

getCanUpdateModel​

</>
ModelAnimationPlayer_Client:getCanUpdateModel() → ()

Returns true if ModelAnimationPlayer can update model. If overrideServerCanUpdateModel is false, returns serverCanUpdateModel, otherwise returns canUpdateModel

setModel​

</>
ModelAnimationPlayer_Client:setModel(newModel: Instance) → ()

Sets the Model

setBindToAnimationPlayerTypeWithName​

</>
ModelAnimationPlayer_Client:setBindToAnimationPlayerTypeWithName(
bindToAnimationPlayerType: BindToAnimationPlayerType,
animationPlayerName: string,
offset: number?
) → ()

Binds to an AnimationPlayer using it's name and a type

setOverrideServerBindToAnimationPlayer​

</>
ModelAnimationPlayer_Client:setOverrideServerBindToAnimationPlayer(
overrideServer: boolean,
forceReset: boolean?
) → ()

Sets the whether server's BindToAnimationPlayer should be overridden

bindToAnimationPlayerWithName​

</>
ModelAnimationPlayer_Client:bindToAnimationPlayerWithName(
animationPlayerName: string,
offset: number
) → ()

Binds to an AnimationPlayer using it's name

bindToAnimationPlayerTimeWithName​

</>
ModelAnimationPlayer_Client:bindToAnimationPlayerTimeWithName(
animationPlayerName: string,
offset: number?
) → ()

Binds to an AnimationPlayer's time using it's name

setUpdateInterval​

</>
ModelAnimationPlayer_Client:setUpdateInterval(
newInterval: number,--

0 = "Don't use update interval"

overrideServer: boolean?
) → ()

Sets updateInterval If overrideServer is true, then overrides server's canUpdateModel

setOverrideServerUpdateInterval​

</>
ModelAnimationPlayer_Client:setOverrideServerUpdateInterval(overrideServer: boolean) → ()

Sets whether client should override

setOverrideServerCanUpdateModel​

</>
ModelAnimationPlayer_Client:setOverrideServerCanUpdateModel(overrideServer: boolean) → ()

Sets whether client can override server's CanUpdateModel value

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "serverData",
                    "desc": "",
                    "lua_type": "Folder"
                },
                {
                    "name": "animationPlayer",
                    "desc": "",
                    "lua_type": "AnimationPlayer_Client"
                },
                {
                    "name": "getTrack",
                    "desc": "",
                    "lua_type": "(trackName: string) -> CFrameTrack"
                },
                {
                    "name": "getAnimationPlayer",
                    "desc": "",
                    "lua_type": "(animationPlayerName: string) -> ModelAnimationPlayer_Client"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Client"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 48,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 120,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Sets AnimationPlayer as ready to receive updates",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 138,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "unready",
            "desc": "Sets AnimationPlayer as NOT ready to receive updates",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 144,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates this ModelAnimationPlayer_Client",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 177,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "getCanUpdateModel",
            "desc": "Returns true if ModelAnimationPlayer can update model.\nIf `overrideServerCanUpdateModel` is false, returns\n`serverCanUpdateModel`, otherwise returns `canUpdateModel`",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 222,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "_doUpdateModel",
            "desc": "Updates model",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 232,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setModel",
            "desc": "Sets the Model",
            "params": [
                {
                    "name": "newModel",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 257,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setBindToAnimationPlayerTypeWithName",
            "desc": "Binds to an AnimationPlayer using it's name and a type",
            "params": [
                {
                    "name": "bindToAnimationPlayerType",
                    "desc": "",
                    "lua_type": "BindToAnimationPlayerType"
                },
                {
                    "name": "animationPlayerName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 294,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setOverrideServerBindToAnimationPlayer",
            "desc": "Sets the whether server's BindToAnimationPlayer should be overridden",
            "params": [
                {
                    "name": "overrideServer",
                    "desc": "",
                    "lua_type": "boolean"
                },
                {
                    "name": "forceReset",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 311,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "bindToAnimationPlayerWithName",
            "desc": "Binds to an AnimationPlayer using it's name",
            "params": [
                {
                    "name": "animationPlayerName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 339,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "bindToAnimationPlayerTimeWithName",
            "desc": "Binds to an AnimationPlayer's time using it's name",
            "params": [
                {
                    "name": "animationPlayerName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 354,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setUpdateInterval",
            "desc": "Sets updateInterval\nIf overrideServer is true, then overrides server's canUpdateModel",
            "params": [
                {
                    "name": "newInterval",
                    "desc": "0 = \"Don't use update interval\"",
                    "lua_type": "number"
                },
                {
                    "name": "overrideServer",
                    "desc": "",
                    "lua_type": "boolean?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 370,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setOverrideServerUpdateInterval",
            "desc": "Sets whether client should override",
            "params": [
                {
                    "name": "overrideServer",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 385,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setOverrideServerCanUpdateModel",
            "desc": "Sets whether client can override server's CanUpdateModel value",
            "params": [
                {
                    "name": "overrideServer",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 393,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "BindToAnimationPlayerType",
            "desc": "Sets how this ModelAnimationPlayer binds to another ModelAnimationPlayer.\nUsed by the server to sync the current BindToAnimationPlayer state.",
            "fields": [
                {
                    "name": "None",
                    "lua_type": "0",
                    "desc": ""
                },
                {
                    "name": "State",
                    "lua_type": "1",
                    "desc": ""
                },
                {
                    "name": "Time",
                    "lua_type": "2",
                    "desc": ""
                }
            ],
            "tags": [
                "enum"
            ],
            "source": {
                "line": 25,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "ModelAnimationPlayerSyncState",
            "desc": "",
            "fields": [
                {
                    "name": "hasBoundToAnimationPlayer",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "hasSetUpdateInterval",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "hasSetCanUpdateModel",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "bindToAnimationPlayerType",
                    "lua_type": "BindToAnimationPlayerType",
                    "desc": ""
                },
                {
                    "name": "boundAnimationPlayerName",
                    "lua_type": "string?",
                    "desc": ""
                },
                {
                    "name": "boundAnimationPlayerOffset",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "updateInterval",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "canUpdateModel",
                    "lua_type": "boolean",
                    "desc": ""
                }
            ],
            "source": {
                "line": 159,
                "path": "src/shared/client/ModelAnimationPlayer.lua"
            }
        }
    ],
    "name": "ModelAnimationPlayer_Client",
    "desc": "",
    "realm": [
        "Client"
    ],
    "source": {
        "line": 36,
        "path": "src/shared/client/ModelAnimationPlayer.lua"
    }
}