Name GetPluginTimerList
Type Method
Summary Gets the list of timers in a specified plugin
Prototype VARIANT GetPluginTimerList(BSTR PluginID);
Description Returns an array of all the named timers currently defined for the nominated plugin. You can then use GetPluginTimerInfo to find out more details about each one.

If you want to find the list of timers in the current plugin, use "GetTimerList".

If you are writing a plugin and want to find the "global" MUSHclient timer list, use an empty plugin ID, eg.

tList = world.GetPluginTimerList ("")


Note: Available in MUSHclient version 3.23 onwards.
VBscript example
dim tList

tList = World.GetPluginTimerList ("982581e59ab42844527eec80")

If Not IsEmpty (tList) Then
  for each t in tList
    world.note t
  next
End If
Jscript example
timerlist = new VBArray(world.GetPluginTimerList("982581e59ab42844527eec80")).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->GetPluginTimerList ("982581e59ab42844527eec80")))
 {
 $world->note($item);
 }
Returns If there are no timers (with names) then the return value is empty. Use "IsEmpty" to test for this possibility.

If the nominated plugin does not exist, then the return value is NULL. Use "IsNull" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the timers in the specified plugin. Use "ubound" to find the number of timers in the list. You can then use "GetPluginTimerInfo" to find details about each timer.

See also ...