Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.EnableTimer

Name EnableTimer
Type Method
Summary Enables or disables an timer
Prototype long EnableTimer(BSTR TimerName, BOOL Enabled);

View list of data type meanings
Description

Enables or disables the named timer. An enabled timer is "active", otherwise it is ignored when processing periodic events.
VBscript example 
world.EnableTimer "heartbeat", TRUE
Jscript example 
world.EnableTimer("heartbeat", true);
PerlScript example 
$world->EnableTimer("heartbeat", true);
Python example 
world.EnableTimer("heartbeat", True)
Lua example 
EnableTimer("heartbeat", true)
Lua notes 
The enabled flag is optional, and defaults to true.
Returns eInvalidObjectLabel: The timer name is not valid
eTimerNotFound: The named timer does not exist
eOK: completed OK

View list of return code meanings

See also ...

Function Description
DeleteTimer Deletes a 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]

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

Home