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

MUSHclient scripting

Description of MUSHclient world function: world.GetPluginTimerList


Name GetPluginTimerList
Type Method
Summary Gets the list of timers in a specified plugin
Prototype VARIANT GetPluginTimerList(BSTR PluginID);

View list of data type meanings

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 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);
 }
Python example
timerlist = world.GetPluginTimerList("982581e59ab42844527eec80")
if (timerlist):
  for t in timerlist : world.Note (t)
Lua example
for k, v in pairs (GetPluginTimerList ("982581e59ab42844527eec80")) do 
  Note (v) 
end
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.
Introduced in version 3.23

See also ...

Function Description
AddTimer Adds a timer
DeleteTimer Deletes a timer
EnableTimer Enables or disables an timer
GetPluginTimerInfo Gets details about a named timer for a specified plugin
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

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]