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

MUSHclient scripting

Description of MUSHclient world function: world.DeleteTimer


Name DeleteTimer
Type Method
Summary Deletes a timer
Prototype long DeleteTimer(BSTR TimerName);

View list of data type meanings

Description

Deletes the named timer from the list of timers.

WARNING - if the timer is executing a script it cannot be deleted. For example, a timer cannot delete itself.

If you need to delete a timer from within itself use DoAfterSpecial to delete it after a short delay. You might also want to use EnableTimer to disable it first.

VBscript example
world.DeleteTimer "mytimer"
Jscript example
world.DeleteTimer("mytimer");
PerlScript example
$world->DeleteTimer("mytimer");
Python example
world.DeleteTimer("mytimer")
Lua example
DeleteTimer("mytimer")
Returns eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The named timer does not exist
eItemInUse: Cannot delete trigger/alias/timer because it is executing a script
eOK: deleted OK

View list of return code meanings


See also ...

Function Description
AddTimer Adds a timer
DeleteTimerGroup Deletes a group of timers
DoAfterSpecial Adds a one-shot, temporary, timer to carry out some special action
EnableTimer Enables or disables an timer
GetTimer Gets details about a timer
GetTimerInfo Gets details about a timer
GetTimerList Gets the list of timers
IsTimer Tests to see if a timer exists
ResetTimer Resets a named timer
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]