MUSHclient scripting

Description of MUSHclient world function: world.ResetTimer

Name	ResetTimer
Type	Method
Summary	Resets a named timer
Prototype	`long ResetTimer(BSTR TimerName);` View list of 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")`
Returns	`eInvalidObjectLabel: The timer name is not valid eTimerNotFound: The timer does not exist eOK: reset OK` View list of return code meanings

See also ...

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.