Skip to main content

AnimationPromiseUtils

Functions​

promiseFinished​

</>
AnimationPromiseUtils.promiseFinished(
animationTrack: AnimationTrack,
endMarkerName: string | nil
) → Promise

Promises that the track is finished

promiseLoaded​

</>
AnimationPromiseUtils.promiseLoaded(animationTrack: AnimationTrack) → Promise

Promises that the track has been loaded

promiseKeyframeReached​

</>
AnimationPromiseUtils.promiseKeyframeReached(
animationTrack: AnimationTrack,
keyframeName: string
) → Promise

Promises that the track reached a keyframe or is finished

Show raw api
{
    "functions": [
        {
            "name": "promiseFinished",
            "desc": "Promises that the track is finished",
            "params": [
                {
                    "name": "animationTrack",
                    "desc": "",
                    "lua_type": "AnimationTrack"
                },
                {
                    "name": "endMarkerName",
                    "desc": "",
                    "lua_type": "string | nil"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 21,
                "path": "src/animations/src/Shared/AnimationPromiseUtils.lua"
            }
        },
        {
            "name": "promiseLoaded",
            "desc": "Promises that the track has been loaded",
            "params": [
                {
                    "name": "animationTrack",
                    "desc": "",
                    "lua_type": "AnimationTrack"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 55,
                "path": "src/animations/src/Shared/AnimationPromiseUtils.lua"
            }
        },
        {
            "name": "promiseKeyframeReached",
            "desc": "Promises that the track reached a keyframe or is finished",
            "params": [
                {
                    "name": "animationTrack",
                    "desc": "",
                    "lua_type": "AnimationTrack"
                },
                {
                    "name": "keyframeName",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 100,
                "path": "src/animations/src/Shared/AnimationPromiseUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "AnimationPromiseUtils",
    "desc": "",
    "source": {
        "line": 4,
        "path": "src/animations/src/Shared/AnimationPromiseUtils.lua"
    }
}