pause function

Member of

<clock>

Syntax

clock.name.pause()

Return Type

none

Parameters

None.

Remarks

The pause function pauses a clock in timer or stopwatch mode. This is useful for introducing breaks for tasks in order to rest or read further instructions. To restart the clock, use the start function. The function has no effect if a clock is in clock mode.

Typically, a close will automatically start when it is presented. If pause() is called on the clock prior to it being presented, however, the clock will not automatically start until the start() function is called. Calling pause() on a timer that is already paused has no effect.

Examples

The following resets the time of a stopwatch:

<trial myTrial>
/ onTrialEnd= [clock.timespent.pause();]
</trial>

The following resets the time of a timer:

<trial myTrial>
/ onTrialEnd= [clock.timeremaining.pause();]
</trial>