Module oc_wasm_futures::sleep

Allows the caller to wait for an amount of time, measured either in computer uptime or in-game real time.

Sleep functions can be distinguished based on which measurement of time they use. In this axis, two measurements are available: uptime and world time. Uptime measures the time the computer has been in a loaded chunk since it was last booted; it passes only while the game is running (i.e. not paused or shut down) and the computer is in a loaded chunk. World time, in contrast, still only passes while the game is running (i.e. not paused or shut down), but it still passes even if the chunk containing the computer is unloaded; world time is therefore synchronized to the world’s day/night cycle.

Sleep functions can also be distinguished based on whether they accept a duration (a time period relative to the moment when they are called) or a deadline (a point in time at which the sleep will end).

Sleeping based on uptime is more efficient than sleeping based on world time. Therefore, if either is acceptable for your application, prefer uptime.

Structs

• UntilNextTimeslice
  A future that completes on the next timeslice.
• UntilSignal
  A future that completes when a signal is in the signal queue.
• UntilUptime
  A future that completes at a particular computer uptime.

Functions

• check_for_wakeups
  Wakes up any sleeps that are now finished.
• for_uptime
  Sleeps for a number of seconds of computer uptime.
• register_next_timeslice_wakeup
  Registers a waker to be called at the next timeslice.
• shortest_requested
  Returns the shortest sleep time currently requested, in ticks of computer uptime.
• until_next_timeslice
  Waits until the next timeslice.
• until_signal
  Sleeps until a signal is in the signal queue.
• until_uptime
  Sleeps until a deadline measured in seconds of computer uptime.