Skip to main content

TimeUpdaterModule

Properties​

TimeUpdater​

</>
TimeUpdaterModule.TimeUpdater: TimeUpdater

ControllableTimeUpdater​

</>
TimeUpdaterModule.ControllableTimeUpdater: ControllableTimeUpdater

RealTimeTimeUpdater​

</>
TimeUpdaterModule.RealTimeTimeUpdater: RealTimeTimeUpdater

TimeKeeper​

</>
TimeUpdaterModule.TimeKeeper: TimeKeeper

RealTimeTimeKeeper​

</>
TimeUpdaterModule.RealTimeTimeKeeper: RealTimeTimeKeeper

AnimationState​

</>
TimeUpdaterModule.AnimationState: AnimationState

Functions​

create​

</>
TimeUpdaterModule.create(name: string) → Result

Creates a TimeUpdater from a string. Returns a Result.

Valid ModelTypes

Name ClassName
Controllable ControllableTimeUpdater
RealTime RealTimeTimeUpdater
Show raw api
{
    "functions": [
        {
            "name": "create",
            "desc": "Creates a TimeUpdater from a string.\nReturns a Result.\n#### Valid ModelTypes\n| Name | ClassName |\n| ---------- | -------- |\n| `Controllable` | [ControllableTimeUpdater](/api/ControllableTimeUpdater) |\n| `RealTime` | [RealTimeTimeUpdater](/api/RealTimeTimeUpdater) |",
            "params": [
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Result"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 54,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "TimeUpdater",
            "desc": "",
            "lua_type": "TimeUpdater",
            "source": {
                "line": 14,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        },
        {
            "name": "ControllableTimeUpdater",
            "desc": "",
            "lua_type": "ControllableTimeUpdater",
            "source": {
                "line": 18,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        },
        {
            "name": "RealTimeTimeUpdater",
            "desc": "",
            "lua_type": "RealTimeTimeUpdater",
            "source": {
                "line": 22,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        },
        {
            "name": "TimeKeeper",
            "desc": "",
            "lua_type": "TimeKeeper",
            "source": {
                "line": 26,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        },
        {
            "name": "RealTimeTimeKeeper",
            "desc": "",
            "lua_type": "RealTimeTimeKeeper",
            "source": {
                "line": 30,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        },
        {
            "name": "AnimationState",
            "desc": "",
            "lua_type": "AnimationState",
            "source": {
                "line": 34,
                "path": "src/shared/animationPlayer/timeUpdater/init.lua"
            }
        }
    ],
    "types": [],
    "name": "TimeUpdaterModule",
    "desc": "",
    "source": {
        "line": 9,
        "path": "src/shared/animationPlayer/timeUpdater/init.lua"
    }
}