Skip to main content

ControllableTimeUpdater

A controllable TimeUpdater. Able to be rewinded and have it's speed changed.

Properties​

speed​

</>
ControllableTimeUpdater.speed: number

The current speed of time 1.0 for "normal" speed

isForwards​

</>
ControllableTimeUpdater.isForwards: boolean

If false, will flip the sign of speed

Functions​

new​

Constructor
</>
ControllableTimeUpdater.new() → ControllableTimeUpdater

Constructor. Creates a new ControllableTimeUpdater

updateTime​

</>
ControllableTimeUpdater:updateTime(
previousTime: number,
stepped: number,--

Delta time between updates

_previousState: TimeUpdater.UpdateData
) → number--

New updated time

Updates currentTime

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Constructor.\nCreates a new ControllableTimeUpdater",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "ControllableTimeUpdater"
                }
            ],
            "function_type": "static",
            "tags": [
                "Constructor"
            ],
            "source": {
                "line": 26,
                "path": "src/shared/animationPlayer/timeUpdater/ControllableTimeUpdater.lua"
            }
        },
        {
            "name": "updateTime",
            "desc": "Updates currentTime",
            "params": [
                {
                    "name": "previousTime",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "stepped",
                    "desc": "Delta time between updates",
                    "lua_type": "number"
                },
                {
                    "name": "_previousState",
                    "desc": "",
                    "lua_type": "TimeUpdater.UpdateData"
                }
            ],
            "returns": [
                {
                    "desc": "New updated time",
                    "lua_type": "number"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 40,
                "path": "src/shared/animationPlayer/timeUpdater/ControllableTimeUpdater.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "speed",
            "desc": "The current speed of time\n1.0 for \"normal\" speed",
            "lua_type": "number",
            "source": {
                "line": 13,
                "path": "src/shared/animationPlayer/timeUpdater/ControllableTimeUpdater.lua"
            }
        },
        {
            "name": "isForwards",
            "desc": "If false, will flip the sign of speed",
            "lua_type": "boolean",
            "source": {
                "line": 17,
                "path": "src/shared/animationPlayer/timeUpdater/ControllableTimeUpdater.lua"
            }
        }
    ],
    "types": [],
    "name": "ControllableTimeUpdater",
    "desc": "A controllable TimeUpdater. Able to be rewinded and have it's speed changed.",
    "source": {
        "line": 8,
        "path": "src/shared/animationPlayer/timeUpdater/ControllableTimeUpdater.lua"
    }
}