Skip to main content

ModelAnimationPlayer_Server

This item only works when running on the server. Server

Handles syncing of Model and Model updates for AnimationPlayer.

NOTE

Model updating is disabled for server as server is not meant to update model positions.

This means signals associated with updating a model such as onModelPreUpdated and onModelUpdated will not be fired. It also means the AnimationModel.onUpdated Signal with not be fired.

Types​

BindToAnimationPlayerType​

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

ModelAnimationPlayerSyncState​

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

Properties​

serverData​

</>
ModelAnimationPlayer_Server.serverData: Folder

Functions​

new​

Constructor
</>
ModelAnimationPlayer_Server.new(
animationPlayer: AnimationPlayer_Server,
getTrack: (trackName: string) → CFrameTrack
) → ModelAnimationPlayer_Server

Constructor

Destroy​

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

update​

</>
ModelAnimationPlayer_Server:update(stepped: number) → ()

Updates this AnimationPlayer

ready​

</>
ModelAnimationPlayer_Server:ready() → ()

Sets AnimationPlayer as Ready

unready​

</>
ModelAnimationPlayer_Server:unready() → ()

Sets AnimationPlayer as NOT ready

syncTime​

</>
ModelAnimationPlayer_Server:syncTime() → ()

Manually syncs current time for all clients

setName​

override
</>
ModelAnimationPlayer_Server:setName(name: string) → ()

setModel​

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

Sets the Model

bindToAnimationPlayer​

</>
ModelAnimationPlayer_Server:bindToAnimationPlayer(
modelAnimPlayer: ModelAnimationPlayer_Server,
offset: number?
) → ()

Binds an AnimationPlayer to this one such that this will update after. Will be affected by both time and state changes that the other animation player has.

bindToAnimationPlayerTime​

</>
ModelAnimationPlayer_Server:bindToAnimationPlayerTime(
modelAnimPlayer: ModelAnimationPlayer_Server,
offset: number?
) → ()

Binds an AnimationPlayer to this one such that this will update after. Only binds to time, not state.

unbindFromAnimationPlayer​

</>
ModelAnimationPlayer_Server:unbindFromAnimationPlayer() → ()

Unbinds current bound animation player

setUpdateInterval​

</>
ModelAnimationPlayer_Server:setUpdateInterval(newInterval: number) → ()

setCanUpdateModel​

</>
ModelAnimationPlayer_Server:setCanUpdateModel(newValue: boolean) → ()
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor\n\t",
            "params": [
                {
                    "name": "animationPlayer",
                    "desc": "",
                    "lua_type": "AnimationPlayer_Server"
                },
                {
                    "name": "getTrack",
                    "desc": "",
                    "lua_type": "(trackName: string) -> CFrameTrack"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Server"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 75,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 137,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "_getState",
            "desc": "Returns current state of this AnimationPlayer to be synced\n\t",
            "params": [
                {
                    "name": "updateState",
                    "desc": "",
                    "lua_type": "table"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 186,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates this AnimationPlayer\n\t",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 211,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Sets AnimationPlayer as Ready\n\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 237,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "unready",
            "desc": "Sets AnimationPlayer as NOT ready\n\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 248,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "syncTime",
            "desc": "Manually syncs current time for all clients\n\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 259,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setName",
            "desc": "\t",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 267,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setModel",
            "desc": "Sets the Model\n\t",
            "params": [
                {
                    "name": "newModel",
                    "desc": "",
                    "lua_type": "Instance"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 277,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "bindToAnimationPlayer",
            "desc": "Binds an AnimationPlayer to this one such that this will update after.\nWill be affected by both time and state changes that the other animation player has.\n\t",
            "params": [
                {
                    "name": "modelAnimPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Server"
                },
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 312,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "bindToAnimationPlayerTime",
            "desc": "Binds an AnimationPlayer to this one such that this will update after.\nOnly binds to time, not state.\n\t",
            "params": [
                {
                    "name": "modelAnimPlayer",
                    "desc": "",
                    "lua_type": "ModelAnimationPlayer_Server"
                },
                {
                    "name": "offset",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 325,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "unbindFromAnimationPlayer",
            "desc": "Unbinds current bound animation player",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 335,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setUpdateInterval",
            "desc": "",
            "params": [
                {
                    "name": "newInterval",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 345,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        },
        {
            "name": "setCanUpdateModel",
            "desc": "",
            "params": [
                {
                    "name": "newValue",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 354,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "serverData",
            "desc": "\t",
            "lua_type": "Folder",
            "source": {
                "line": 63,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        }
    ],
    "types": [
        {
            "name": "BindToAnimationPlayerType",
            "desc": "\t",
            "fields": [
                {
                    "name": "None",
                    "lua_type": "0",
                    "desc": ""
                },
                {
                    "name": "State",
                    "lua_type": "1",
                    "desc": ""
                },
                {
                    "name": "Time",
                    "lua_type": "2",
                    "desc": ""
                }
            ],
            "tags": [
                "enum"
            ],
            "source": {
                "line": 36,
                "path": "src/server/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": 166,
                "path": "src/server/ModelAnimationPlayer.lua"
            }
        }
    ],
    "name": "ModelAnimationPlayer_Server",
    "desc": "Handles syncing of Model and Model updates for AnimationPlayer.\n\n#### NOTE\n\nModel updating is disabled for server as server is not meant to update model positions.\n\nThis means signals associated with updating a model such as `onModelPreUpdated` and `onModelUpdated` will not be fired.\nIt also means the `AnimationModel.onUpdated` Signal with not be fired.\n\n\t",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 58,
        "path": "src/server/ModelAnimationPlayer.lua"
    }
}