AuxTimerPaused

A function added by the ShowOff NVSE Plugin version 1.55.

Description

Returns 1 if the specified Auxiliary Timer on the specified form is currently paused, 0 otherwise. Afterwards, if setPaused is specified, will set if the timer is paused or not.

If the timer does not exist, returns -1.

If no owner form for the AuxTimer is specified, PlayerRef will be used.

Syntax

[help]

(wasPaused:bool) ownerRefr.AuxTimerPaused timerName:string setPaused:int{-1} owner:baseForm

Example

RaulRef.AuxTimerPaused "someTimerName"

Will return either 1 or 0, depending on if the private-permanent AuxTimer belonging to RaulRef is paused.

AuxTimerStop "*_someTimerName" 1

Will pause the temporary-public AuxTimer belonging (implicitly) to PlayerRef.

See Also

• AuxTimerStart
• AuxTimerStop
• AuxTimerTimeElapsed
• AuxTimerTimeToCountdown
• AuxTimerTimeLeft