Object MethodDate and Time

Stopwatch:isRunning()

Validates a state on Stopwatch and returns boolean.

Detailed Explanation

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

What It Does

Stopwatch:isRunning performs one focused job in script flow and can be chained cleanly with other API steps. Validates a state on Stopwatch and returns boolean.

When To Use It

For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement. This API becomes most valuable in multi-step chained scenarios.

Parameters and Return

This entry does not require mandatory parameters. The return type is intended for state validation; drive the flow with if/else or guard patterns.

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.

lua

-- Stopwatch:isRunning
local result = Stopwatch:isRunning()
-- Use the result in your script flow

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

lua

-- Stopwatch:isRunning
local result = Stopwatch:isRunning()
-- Use the result in your script flow

Simple

Wraps the base call with minimal flow control.

Simple

lua

local stepOk = true
-- Stopwatch:isRunning
local result = Stopwatch:isRunning()
-- Use the result in your script flow
if stepOk then
  wait(200)
end

Practical Flow

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

Practical Flow

lua

local ok, result = pcall(function()
  -- Stopwatch:isRunning
  local result = Stopwatch:isRunning()
  -- Use the result in your script flow
end)

if not ok then
  print("API step failed: Stopwatch:isRunning")
  requestStop()
end

Detailed

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

Detailed

lua

-- For time flow, combine DateTime, TimeSpan, and Stopwatch with logging, timeout control, and performance measurement.
local function run_isrunning_step()
  -- Stopwatch:isRunning
  local result = Stopwatch:isRunning()
  -- Use the result in your script flow
end

local ok, err = pcall(run_isrunning_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

lua

local watch = Stopwatch.startNew()
-- Stopwatch:isRunning
local result = Stopwatch:isRunning()
-- Use the result in your script flow
local elapsed = watch:elapsedMilliseconds()
print("Elapsed: " .. tostring(elapsed))