world.GetTimerList

MUSHclient script function (Method)

Gets the list of timers

Prototype

VARIANT GetTimerList();

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

Return value

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.

Related topic

Timers

See also