world.ResetTimer

MUSHclient script function (Method)

Resets a named timer

Prototype

long ResetTimer(BSTR TimerName);

Data type meanings

Description

Resets the named timer.

Also see ResetTimers to reset all timers.

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

VBscript example

world.ResetTimer "mytimer"

Jscript example

world.ResetTimer("mytimer");

PerlScript example

$world->ResetTimer("mytimer");

Python example

world.ResetTimer("mytimer")

Lua example

ResetTimer("mytimer")

Return value

eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The timer does not exist
eOK: reset OK

Return code meanings

Related topic

Timers

See also