DeleteTemporaryTimers
Script function

world.DeleteTemporaryTimers

DOC_scripting Read about scripting

Type

Method

Summary

Deletes all temporary timers

Prototype

long DeleteTemporaryTimers();

DOC_data_types View list of data type meanings

Description

Deletes all timers marked as "temporary".

The intention here is to provide a quick way of restoring the world to how it would be after loading (since temporary timers are not loaded from the world file).

You might also use this if a runaway script created too many temporary timers with "DoAfter" or similar.

VBscript example

world.DeleteTemporaryTimers


Jscript example

world.DeleteTemporaryTimers ();


PerlScript example

$world->DeleteTemporaryTimers ();


Python example

world.DeleteTemporaryTimers


Lua example

DeleteTemporaryTimers ()


Return value

Returns a count of the number of timers deleted.



See Also ...

Topics

DOC_aliases Aliases
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_plugins Plugins
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddTimer AddTimer (Adds a timer)
FNC_DeleteTemporaryAliases DeleteTemporaryAliases (Deletes all temporary aliases)
FNC_DeleteTemporaryTriggers DeleteTemporaryTriggers (Deletes all temporary triggers)
FNC_DeleteTimer DeleteTimer (Deletes a timer)
FNC_DeleteTimerGroup DeleteTimerGroup (Deletes a group of timers)
FNC_DoAfter DoAfter (Adds a one-shot, temporary timer - simplified interface)
FNC_DoAfterNote DoAfterNote (Adds a one-shot, temporary note timer - simplified interface)
FNC_DoAfterSpecial DoAfterSpecial (Adds a one-shot, temporary, timer to carry out some special action)
FNC_DoAfterSpeedWalk DoAfterSpeedWalk (Adds a one-shot, temporary speedwalk timer - simplified interface)
FNC_EnableTimer EnableTimer (Enables or disables an timer)
FNC_EnableTimerGroup EnableTimerGroup (Enables/disables a group of timers)
FNC_GetTimer GetTimer (Gets details about a timer)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTimerList GetTimerList (Gets the list of timers)
FNC_GetTimerOption GetTimerOption (Gets the value of a named timer option)
FNC_IsTimer IsTimer (Tests to see if a timer exists)
FNC_ResetTimer ResetTimer (Resets a named timer)
FNC_ResetTimers ResetTimers (Resets all timers)
FNC_SetTimerOption SetTimerOption (Sets the value of a named timer option)

(Help topic: function=DeleteTemporaryTimers)

DOC_contents Documentation contents page