Object MethodDate and Time

Stopwatch:stop()

Stops the stopwatch; the elapsed time is kept and start() continues from it.

Documented for app version 1.0.51Updated:

Detailed Explanation

This section explains when to use the API, how to call it, and which structures it works best with in production flow.

How To Call It

This is an object method: call it with a colon on a Stopwatch object created with Stopwatch() (watch:<method>(...)). The global Stopwatch table does not have this method.

When To Use It

For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement.

Parameters and Return

Takes no arguments. Returns nothing.

Best Combined With

A strong combination is to measure with Stopwatch, log with DateTime, and compare durations with TimeSpan.

Example Usage

The snippet below is a starter pattern that can be applied directly in runtime flow.

local watch = Stopwatch()
watch:start()
watch:stop()

Copyable Progressive Examples

From foundation to combined usage, each level is provided as a separate code block so you can copy the level you need and adapt it directly.

Foundation

Shows the shortest direct way to call the API.

Foundation
local watch = Stopwatch()
watch:start()
watch:stop()

Simple

Wraps the base call with minimal flow control.

Simple
local stepOk = true
local watch = Stopwatch()
watch:start()
watch:stop()
if stepOk then
  wait(200)
end

Practical Flow

A practical pattern for real macros with pcall, logging, and guards.

Practical Flow
local ok, err = pcall(function()
  local watch = Stopwatch()
  watch:start()
  watch:stop()
end)

if not ok then
  print("API step failed: Stopwatch:stop: " .. tostring(err))
  requestStop()
end

Detailed

This level packages the API into a reusable helper with error reporting.

Detailed
-- For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement.
local function run_stop_step()
  local watch = Stopwatch()
  watch:start()
  watch:stop()
end

local ok, err = pcall(run_stop_step)
if not ok then
  toast("Step failed")
  print(err)
end

Combined

Combines the API with related structures to form a more realistic workflow.

Combined
local watch = Stopwatch()
watch:start()
watch:stop()
print("Elapsed ms: " .. tostring(watch:elapsedMs()))