AuxTimerTimeElapsed

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.55.

Description

Returns the amount of time passed since the specified Auxiliary Timer started. If the timer does not exist or was fully stopped before this is called, returns -1.

Does NOT account for time elapsed while the timer is paused, if it becomes paused by AuxTimerPaused.

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

Syntax

[help]
(timeElapsed:float) ownerRefr.AuxTimerTimeElapsed timerName:string unused:int{-1} owner:baseForm

Example

RaulRef.AuxTimerTimeElapsed "someTimerName"

Will return the amount of time passed since the private-permanent AuxTimer belonging to RaulRef was started, assuming it is still running.

See Also