timer

Creates a new high-resolution stopwatch. The timer starts in a paused state — call start() to begin measuring. Backed by std::time::Instant for sub-millisecond accuracy.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
// ... do work ...
let ms = t.elapsed_ms()
print("Elapsed: {ms} ms")

Begins timing. If the timer is already running this is a no-op, so it is safe to call multiple times.

use plugin timer::{Timer}

let t = Timer.new()
t.start()

Pauses the timer, accumulating elapsed time so far. Resuming later picks up from where the timer left off.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
t.pause()
let ms = t.elapsed_ms()
print("Paused at {ms} ms")

Resumes a paused timer. If the timer is already running this is a no-op.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
t.pause()
t.resume()

Returns the total accumulated time in milliseconds, including any time before the last pause.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
print(t.elapsed_ms())

Returns the total accumulated time in seconds. Equivalent to elapsed_ms() / 1000.0.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
print("{t.elapsed_secs()} seconds")

Returns true if the timer is currently accumulating time.

use plugin timer::{Timer}

let t = Timer.new()
print(t.is_running())
t.start()
print(t.is_running())

Resets the timer to zero and stops it. After reset, call start() to begin again.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
t.reset()
print(t.elapsed_ms())

Records a lap split. Returns the time elapsed since the last lap (or since start if no previous lap). Updates the internal lap reference point.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
// ... first segment ...
let lap1 = t.lap()
// ... second segment ...
let lap2 = t.lap()
print("Lap 1: {lap1} ms, Lap 2: {lap2} ms")

Stops the timer and returns the total accumulated elapsed time in milliseconds.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
let total = t.stop()
print("Total: {total} ms")

Resets and immediately restarts the timer. Returns the elapsed time from the previous run before the reset.

use plugin timer::{Timer}

let t = Timer.new()
t.start()
let previous = t.restart()
print("Previous run: {previous} ms")

Creates a countdown timer for the given duration in milliseconds. Call start() to begin and update() each frame to check for completion.

use plugin timer::{Countdown}

let cd = Countdown.new(5000.0)
cd.start()

Checks whether the countdown has reached its duration. Returns true when the countdown finishes and transitions to the finished state. Call this once per frame in a game loop.

use plugin timer::{Countdown}

let cd = Countdown.new(3000.0)
cd.start()
// in game loop:
let done = cd.update()
if done {
  print("Time is up!")
}

Returns the number of milliseconds remaining before the countdown reaches zero.

use plugin timer::{Countdown}

let cd = Countdown.new(10000.0)
cd.start()
print("Remaining: {cd.remaining_ms()} ms")

Returns true if the countdown has completed. Does not require update() to have been called.

use plugin timer::{Countdown}

let cd = Countdown.new(1000.0)
cd.start()
print(cd.is_finished())

Returns the fraction of the countdown that has elapsed, from 0.0 (just started) to 1.0 (finished). Useful for driving progress bars or animations.

use plugin timer::{Countdown}

let cd = Countdown.new(5000.0)
cd.start()
let pct = cd.progress() * 100.0
print("{pct}% complete")

Creates an interval that fires every interval_ms milliseconds. Call start() then poll tick() each frame to detect when the interval fires.

use plugin timer::{Interval}

let iv = Interval.new(500.0)
iv.start()

Returns true once each time the interval period has elapsed. Call this every frame; it advances the internal reference point so the next call measures from the last fire time.

use plugin timer::{Interval}

let iv = Interval.new(1000.0)
iv.start()
// in game loop:
if iv.tick() {
  print("One second passed")
}

Changes the interval duration while the interval may be running. The change takes effect on the next tick evaluation.

use plugin timer::{Interval}

let iv = Interval.new(1000.0)
iv.start()
iv.set_interval(250.0)