AuxTimerTimeLeft

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.55.

Description

Returns the time left for an Auxiliary Timer before it stops on its own. If the timer doesn't exist or was fully stopped before this is called, returns -1.

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

Syntax

[help]
(timeLeft:float) ownerRefr.AuxTimerTimeLeft timerName:string owner:baseForm

Example

RaulRef.AuxTimerTimeLeft "someTimerName"

Returns the amount of time left for the private-permanent AuxTimer belonging to RaulRef, assuming such a timer is still running.

See Also