AuxTimerTimeToCountdown

From GECK
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.55.

Description

Returns the original amount of time that the Auxiliary Timer was ordered to start counting down. 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]
(timeToCountdown:float) ownerRefr.AuxTimerTimeToCountdown timerName:string owner:baseForm

Example

RaulRef.AuxTimerTimeToCountdown "someTimerName"

Will return the original amount of time that the the private-permanent AuxTimer belonging to RaulRef was ordered to count down from, assuming such a timer is still running.

See Also