Skip to main content

RealTimeTimeKeeper

Updates in real time See TimeKeeper

Properties​

globalTick​

This item is read only and cannot be modified. Read OnlyStatic
</>
RealTimeTimeKeeper.globalTick: number

globalTickUpdateConnection​

This item is read only and cannot be modified. Read OnlyStatic
</>
RealTimeTimeKeeper.globalTickUpdateConnection: RBXScriptConnection

startTime​

This item is read only and cannot be modified. Read Only
</>
RealTimeTimeKeeper.startTime: number

The tick at which this started

Functions​

new​

Constructor
</>
RealTimeTimeKeeper.new() → RealTimeTimeKeeper

Constructor. Creates a new RealTimeTimeKeeper

setCurrentTime​

</>
RealTimeTimeKeeper:setCurrentTime(newCurrentTime: number) → ()

Internally sets the startTime such that the newCurrentTime is synced

updateTime​

</>
RealTimeTimeKeeper:updateTime(_stepped: number) → number--

New updated time

Updates the time

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor.\nCreates a new RealTimeTimeKeeper",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RealTimeTimeKeeper"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 47,
                "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
            }
        },
        {
            "name": "setCurrentTime",
            "desc": "Internally sets the startTime such that the newCurrentTime is synced",
            "params": [
                {
                    "name": "newCurrentTime",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 65,
                "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
            }
        },
        {
            "name": "updateTime",
            "desc": "Updates the time",
            "params": [
                {
                    "name": "_stepped",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "New updated time",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 74,
                "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "globalTick",
            "desc": "",
            "lua_type": "number",
            "tags": [
                "Static"
            ],
            "readonly": true,
            "source": {
                "line": 24,
                "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
            }
        },
        {
            "name": "globalTickUpdateConnection",
            "desc": "",
            "lua_type": "RBXScriptConnection",
            "tags": [
                "Static"
            ],
            "readonly": true,
            "source": {
                "line": 29,
                "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
            }
        },
        {
            "name": "startTime",
            "desc": "The tick at which this started",
            "lua_type": "number",
            "readonly": true,
            "source": {
                "line": 34,
                "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
            }
        }
    ],
    "types": [],
    "name": "RealTimeTimeKeeper",
    "desc": "Updates in real time\nSee TimeKeeper",
    "source": {
        "line": 19,
        "path": "src/shared/animationPlayer/timeUpdater/RealTimeTimeKeeper.lua"
    }
}