Clock

The clock the stub world runs on. "real" leaves std_polyfills alone; "virtual" swaps task and datetime on the shared table so one virtual second takes VIRTUAL_TIME_SCALE real seconds.

Summary

Properties

Clock.mode :: stringClock.originalTask :: anyClock.originalDatetime :: anyClock.polyfills :: anyClock.startClock :: numberClock.startUnixTimestampMillis :: number

Methods

Clock:now() → numberClock:wait(seconds: number?) → numberClock:waitFor(predicate: () -> any, seconds: number) → booleanClock:install()Clock:uninstall()

Functions

Clock.new(mode: "real" | "virtual"?, polyfills: any?) → Clock

Properties

mode

Clock.mode  :: string

---

Whether the clock runs at real speed or 100x.

originalTask

Clock.originalTask  :: any

---

The task table captured before the virtual clock was installed.

originalDatetime

Clock.originalDatetime  :: any

---

The datetime table captured before the virtual clock was installed.

polyfills

Clock.polyfills  :: any

---

The std_polyfills table this clock swaps.

startClock

Clock.startClock  :: number

---

os.clock() when the clock was made.

startUnixTimestampMillis

Clock.startUnixTimestampMillis  :: number

---

The unix timestamp in milliseconds when the clock was made.

Methods

now

Clock : now ( )  -> number

Seconds since the clock was made, real or virtual by mode.

Returns

number

wait

Clock : wait ( seconds )  -> number

Sleeps seconds of the clock's time and returns the time that passed on this clock, like task.wait: at least seconds, and more when the scheduler was late.

Parameters

seconds: number?

Returns

number

waitFor

Clock : waitFor ( predicate ,  seconds )  -> boolean

Polls predicate every quarter second of the clock's time until it returns a truthy value or seconds of the clock's time pass. Returns whether the predicate turned truthy in time.

Parameters

predicate: () -> any
seconds: number

Returns

boolean

install

Clock : install ( )  -> ()

Swaps std_polyfills.task and std_polyfills.datetime for this clock. A real clock does nothing.

uninstall

Clock : uninstall ( )  -> ()

Puts the real task and datetime back. Safe to call twice.

Functions

new

Clock . new ( mode ,  polyfills )  -> Clock

Makes a clock. "real" is the default.

Parameters

mode: "real" | "virtual"?
polyfills: any?

Returns

Clock