Skip to main content

AnimationPlayer_Server

This item only works when running on the server. Server

Handles syncing of AnimationPlayer between clients

Types​

AnimationPlayerServerState​

</>
interface AnimationPlayerServerState {
currentState: AnimationState
currentTime: number
previousTime: number
currentAnimation: string?
}

Functions​

new​

</>
AnimationPlayer_Server.new(
timeUpdater: TimeUpdater,
getAnimation: function
) → AnimationPlayer_Server

Constructor

Destroy​

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

syncTime​

</>
AnimationPlayer_Server:syncTime() → ()

Manually syncs current time for all clients

update​

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

Updates Animation and syncs to clients

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor\n\t",
            "params": [
                {
                    "name": "timeUpdater",
                    "desc": "",
                    "lua_type": "TimeUpdater"
                },
                {
                    "name": "getAnimation",
                    "desc": "",
                    "lua_type": "function"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationPlayer_Server"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 41,
                "path": "src/server/AnimationPlayer.lua"
            }
        },
        {
            "name": "Destroy",
            "desc": "\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "tags": [
                "Deconstructor"
            ],
            "source": {
                "line": 61,
                "path": "src/server/AnimationPlayer.lua"
            }
        },
        {
            "name": "_getState",
            "desc": "Returns state\n\t",
            "params": [
                {
                    "name": "updateState",
                    "desc": "",
                    "lua_type": "AnimationUpdateData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "AnimationPlayerServerState"
                }
            ],
            "function_type": "method",
            "private": true,
            "source": {
                "line": 89,
                "path": "src/server/AnimationPlayer.lua"
            }
        },
        {
            "name": "syncTime",
            "desc": "Manually syncs current time for all clients\n\t",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 98,
                "path": "src/server/AnimationPlayer.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates Animation and syncs to clients\n\t",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 107,
                "path": "src/server/AnimationPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "AnimationPlayerServerState",
            "desc": "\t",
            "fields": [
                {
                    "name": "currentState",
                    "lua_type": "AnimationState",
                    "desc": ""
                },
                {
                    "name": "currentTime",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "previousTime",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "currentAnimation",
                    "lua_type": "string?",
                    "desc": ""
                }
            ],
            "source": {
                "line": 78,
                "path": "src/server/AnimationPlayer.lua"
            }
        }
    ],
    "name": "AnimationPlayer_Server",
    "desc": "Handles syncing of AnimationPlayer between clients\n\t",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 30,
        "path": "src/server/AnimationPlayer.lua"
    }
}