Skip to main content

AnimationPlayer_Client

Client implementation of AnimationPlayer

Types​

AnimationPlayerUpdateState​

</>
interface AnimationPlayerUpdateState {
wasAnimationChanged: boolean
currentAnimationName: string | nil
syncTime: boolean
SYNC_ALL: boolean
}

Extends TimeUpdateData

AnimationPlayerUpdateState​

</>
interface AnimationPlayerUpdateState {
currentAnimationName: string | nil
}

Extends TimeUpdateState

ServerUpdateState​

</>
interface ServerUpdateState {
isLooped: boolean?
timeScale: number?
updateDirection: boolean?
wasAnimationChanged: boolean
animationName: string | nil
}

Properties​

syncUpdateListener​

</>
AnimationPlayer_Client.syncUpdateListener: SyncUpdateListener

animationUpdater​

</>
AnimationPlayer_Client.animationUpdater: ClientAnimationUpdater

Functions​

new​

Constructor
</>
AnimationPlayer_Client.new(
remoteEvent: RemoteEvent,
timeUpdater: TimeUpdater,
getAnimation: (animationName: string) → Animation?
) → AnimationPlayer_Client

Constructor

ready​

</>
AnimationPlayer_Client:ready() → ()

Notifies server this player is ready and subscribes to updates

unready​

</>
AnimationPlayer_Client:unready() → ()

Unsubscribes from server updates

update​

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

Updates current animation Overrides AnimationPlayer:update()

setIsLooped​

</>
AnimationPlayer_Client:setIsLooped(_value: boolean) → ()

Errors

TypeDescription
Cannot call from Client!

setTimeScale​

</>
AnimationPlayer_Client:setTimeScale(_value: number) → ()

Errors

TypeDescription
Cannot call from Client!

setUpdateDirection​

</>
AnimationPlayer_Client:setUpdateDirection(_value: boolean) → ()

Errors

TypeDescription
Cannot call from Client!
Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "remoteEvent",
                    "desc": "",
                    "lua_type": "RemoteEvent"
                },
                {
                    "name": "timeUpdater",
                    "desc": "",
                    "lua_type": "TimeUpdater"
                },
                {
                    "name": "getAnimation",
                    "desc": "",
                    "lua_type": "(animationName: string) -> Animation?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationPlayer_Client"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 38,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "ready",
            "desc": "Notifies server this player is ready and subscribes to updates",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 72,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "unready",
            "desc": "Unsubscribes from server updates",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 77,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates current animation\nOverrides AnimationPlayer:update()",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 89,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "_reduceServerUpdateState",
            "desc": "",
            "params": [
                {
                    "name": "serverStates",
                    "desc": "",
                    "lua_type": "{AnimationPlayerServerState}"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ServerUpdateState"
                },
                {
                    "desc": "",
                    "lua_type": "{AnimationPlayerServerSyncData}"
                },
                {
                    "desc": "",
                    "lua_type": "ReachedAnimationLengthType"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 221,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "_syncState",
            "desc": "",
            "params": [
                {
                    "name": "newState",
                    "desc": "",
                    "lua_type": "ServerUpdateState"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 358,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "_addSync",
            "desc": "",
            "params": [
                {
                    "name": "currentSyncState",
                    "desc": "",
                    "lua_type": "AnimationPlayerUpdateState"
                },
                {
                    "name": "newSyncState",
                    "desc": "",
                    "lua_type": "AnimationPlayerUpdateState"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 389,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "_syncTime",
            "desc": "",
            "params": [
                {
                    "name": "currentClientSyncState",
                    "desc": "",
                    "lua_type": "AnimationPlayerUpdateState"
                },
                {
                    "name": "serverTimeSyncStates",
                    "desc": "",
                    "lua_type": "{AnimationPlayerUpdateState}"
                }
            ],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 465,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "_getCurrentClientState",
            "desc": "",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationPlayerUpdateState"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 497,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "_updateServerSync",
            "desc": "Updates syncing from server",
            "params": [],
            "returns": [],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 508,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "setIsLooped",
            "desc": "",
            "params": [
                {
                    "name": "_value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "Cannot call from Client!",
                    "desc": ""
                }
            ],
            "source": {
                "line": 530,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "setTimeScale",
            "desc": "",
            "params": [
                {
                    "name": "_value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "Cannot call from Client!",
                    "desc": ""
                }
            ],
            "source": {
                "line": 535,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "setUpdateDirection",
            "desc": "",
            "params": [
                {
                    "name": "_value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "method",
            "errors": [
                {
                    "lua_type": "Cannot call from Client!",
                    "desc": ""
                }
            ],
            "source": {
                "line": 540,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "syncUpdateListener",
            "desc": "",
            "lua_type": "SyncUpdateListener",
            "source": {
                "line": 24,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "animationUpdater",
            "desc": "",
            "lua_type": "ClientAnimationUpdater",
            "source": {
                "line": 27,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        }
    ],
    "types": [
        {
            "name": "AnimationPlayerUpdateState",
            "desc": "Extends [TimeUpdateData](/api/TimeUpdater#TimeUpdateData)",
            "fields": [
                {
                    "name": "wasAnimationChanged",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "currentAnimationName",
                    "lua_type": "string | nil",
                    "desc": ""
                },
                {
                    "name": "syncTime",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "SYNC_ALL",
                    "lua_type": "boolean",
                    "desc": ""
                }
            ],
            "source": {
                "line": 149,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "AnimationPlayerUpdateState",
            "desc": "Extends [TimeUpdateState](/api/TimeUpdater#TimeUpdateState)",
            "fields": [
                {
                    "name": "currentAnimationName",
                    "lua_type": "string | nil",
                    "desc": ""
                }
            ],
            "source": {
                "line": 172,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        },
        {
            "name": "ServerUpdateState",
            "desc": "",
            "fields": [
                {
                    "name": "state",
                    "lua_type": "AnimationStateData?",
                    "desc": ""
                },
                {
                    "name": "isLooped",
                    "lua_type": "boolean?",
                    "desc": ""
                },
                {
                    "name": "timeScale",
                    "lua_type": "number?",
                    "desc": ""
                },
                {
                    "name": "updateDirection",
                    "lua_type": "boolean?",
                    "desc": ""
                },
                {
                    "name": "wasAnimationChanged",
                    "lua_type": "boolean",
                    "desc": ""
                },
                {
                    "name": "animationName",
                    "lua_type": "string | nil",
                    "desc": ""
                }
            ],
            "source": {
                "line": 194,
                "path": "src/shared/client/AnimationPlayer.lua"
            }
        }
    ],
    "name": "AnimationPlayer_Client",
    "desc": "Client implementation of AnimationPlayer",
    "source": {
        "line": 21,
        "path": "src/shared/client/AnimationPlayer.lua"
    }
}