AuxTimerStop

From GECK
(Redirected from AuxTimerErase)
Jump to: navigation, search


A function added by the ShowOff NVSE Plugin version 1.55.

Description

Stops and erases an Auxiliary Timer on a form. This will only fire the OnAuxTimerStop event if fireEvent is set to non-0.

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

Syntax

[help]
(success:bool) ownerRefr.AuxTimerStop timerName:string fireEvent:bool{false} owner:baseForm 

Or:

(success:bool) ownerRefr.AuxTimerErase timerName:string fireEvent:bool{false} owner:baseForm

Example

RaulRef.AuxTimerStop "someTimerName"

Will stop and erase the private-permanent AuxTimer belonging to RaulRef. If RaulRef did not have such a timer, will do nothing and return 0.

AuxTimerStop "*_someTimerName" 1

Will stop and erase the temporary-public AuxTimer belonging (implicitly) to PlayerRef. This will fire the OnAuxTimerStop event.

See Also