ResetTimers
Script function

world.ResetTimers

DOC_scripting Read about scripting

Type

Method

Summary

Resets all timers

Prototype

void ResetTimers();

DOC_data_types View list of data type meanings

Description

Resets all timers for the world. There is no return value.

This function will reset all periodic timers to fire from the appropriate interval from when the "ResetTimers" was done.

WARNING - timers that are not enabled will not be reset. Use EnableTimer first to make sure that timers are enabled, before resetting them, if necessary.

VBscript example

world.ResetTimers


Jscript example

world.ResetTimers();


PerlScript example

$world->ResetTimers();


Python example

world.ResetTimers


Lua example

ResetTimers()


Return value

Nothing.



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_DeleteTemporaryTimers DeleteTemporaryTimers (Deletes all temporary timers)
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_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_SetTimerOption SetTimerOption (Sets the value of a named timer option)

(Help topic: function=ResetTimers)

DOC_contents Documentation contents page