Skip to main content

Time

The time interface

Time.wait(0.7)

Properties​

elapsed​

</>
Time.elapsed: number

Get the elapsed seconds since game start

Functions​

wait​

</>
Time.wait(
duration: number--

time to wait (s)

) → ()

Waits the specified amount of time in seconds

yield​

</>
Time.yield() → ()

Yields the current thread

For use when script is temporarily done processing

Show raw api
{
    "functions": [
        {
            "name": "wait",
            "desc": "Waits the specified amount of time in seconds",
            "params": [
                {
                    "name": "duration",
                    "desc": "time to wait (s)",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 24,
                "path": "../../res/data/script/lib/system/time.lua"
            }
        },
        {
            "name": "yield",
            "desc": "Yields the current thread\n\nFor use when script is temporarily done processing",
            "params": [],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 33,
                "path": "../../res/data/script/lib/system/time.lua"
            }
        }
    ],
    "properties": [
        {
            "name": "elapsed",
            "desc": "Get the elapsed seconds since game start",
            "lua_type": "number",
            "source": {
                "line": 18,
                "path": "../../res/data/script/lib/system/time.lua"
            }
        }
    ],
    "types": [],
    "name": "Time",
    "desc": "The time interface\n\n```lua\nTime.wait(0.7)\n```",
    "source": {
        "line": 9,
        "path": "../../res/data/script/lib/system/time.lua"
    }
}