[Home] [Downloads] [Search] [Help/forum]

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 ...

Function Description
AddTimer Adds a timer
DeleteTimer Deletes a timer
EnableTimer Enables or disables an timer
GetTimer Gets details about a timer
GetTimerInfo Gets details about a timer
GetTimerList Gets the list of timers
ResetTimers Resets all timers

Search for script function

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.

Search for:   

Leave blank to show all functions.


Return codes

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

You can view a list of the return codes


Function prototypes

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

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]