Start Timer

Description

Starts a named timer that can be used to control the flow through a Task System. The Timer Expired Transition and the timerExpired function can be used to evaluate whether the timer has expired.

Signature

action/start_timer

Required Parameters

timer

Example

MyTimer

Name for the timer

duration

Example

1.0

Duration

Optional Parameters

duration_units

Options
us
ms
s
Default

us

Duration units

timebase

If set to the name of a timebase, the expiration time will be measured relative to that timebase. If omitted, the current time will be used as the timebase.

Placement

Allowed at top level:

No

Allowed parent:

Block, Conditionally Execute Actions (if), List, Protocol, Render Actions, Repeat Actions (while), Schedule Actions, Task System State, Trial, Unconditionally Execute Actions (else), Variable