Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetTimerList

Name GetTimerList
Type Method
Summary Gets the list of timers
Prototype VARIANT GetTimerList();

View list of data type meanings
Description

Returns an array of all the named timers currently defined. You can then use GetTimer or GetTimerInfo for more details about each one.

Note - from version 3.40 onwards GetTimerList returns all timers, even unlabelled ones. The unlabelled timers will have assigned an "internal" label (like "*timer42") that can be used in GetTimerInfo, and similar routines.
VBscript example 
dim timerList

timerList = world.GetTimerList

If Not IsEmpty (timerList) then

   For Each t In timerList
     world.Note t 
   next

End If
Jscript example 
timerlist = new VBArray(world.GetTimerList()).toArray();

if (timerlist)  // if not empty
 for (i = 0; i < timerlist.length; i++)
   world.note(timerlist [i]);
PerlScript example 
foreach $item (Win32::OLE::in ($world->GetTimerList))
 {
 $world->note($item);
 }
Python example 
timerlist = world.GetTimerList
if (timerlist):
  for t in timerlist : world.Note (t)
Lua example 
tl = GetTimerList ()
if tl then
  for k, v in ipairs (tl) do 
    Note (v) 
  end  -- for
end -- if we have any timers
Lua notes 
Lua returns nil where applicable instead of an "empty variant".
Returns If there are no timers (with names) then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the timers. Use "ubound" to find the number of timers in the list.

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