Skip to main content

NamedAnimationPlayer

AnimationPlayer, but currentAnimation is a string

Functions​

new​

</>
NamedAnimationPlayer.new(
animTimeUpdater: TimeUpdater.TimeUpdater,
getAnimation: (animationName: string) → Animation.Animation?
) → NamedAnimationPlayer

Constructor

update​

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

Updates Animation and syncs to clients

setAnimation​

override
</>
NamedAnimationPlayer:setAnimation(
newAnimationName: string?,
currentTime: boolean | number | nil
) → ()

Sets currentAnimation Overrides AnimationPlayer:setAnimation()

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor",
            "params": [
                {
                    "name": "animTimeUpdater",
                    "desc": "",
                    "lua_type": "TimeUpdater.TimeUpdater"
                },
                {
                    "name": "getAnimation",
                    "desc": "",
                    "lua_type": "(animationName: string) -> Animation.Animation?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "NamedAnimationPlayer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 23,
                "path": "src/shared/animationPlayer/NamedAnimationPlayer.lua"
            }
        },
        {
            "name": "update",
            "desc": "Updates Animation and syncs to clients",
            "params": [
                {
                    "name": "stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 42,
                "path": "src/shared/animationPlayer/NamedAnimationPlayer.lua"
            }
        },
        {
            "name": "setAnimation",
            "desc": "Sets currentAnimation\nOverrides AnimationPlayer:setAnimation()",
            "params": [
                {
                    "name": "newAnimationName",
                    "desc": "",
                    "lua_type": "string?"
                },
                {
                    "name": "currentTime",
                    "desc": "",
                    "lua_type": "boolean | number | nil"
                }
            ],
            "returns": [],
            "function_type": "method",
            "tags": [
                "override"
            ],
            "source": {
                "line": 53,
                "path": "src/shared/animationPlayer/NamedAnimationPlayer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "NamedAnimationPlayer",
    "desc": "AnimationPlayer, but currentAnimation is a string",
    "source": {
        "line": 14,
        "path": "src/shared/animationPlayer/NamedAnimationPlayer.lua"
    }
}