Script function
world.GetPluginTimerList
Read about scripting
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 ("")
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);
}
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
Return value
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 ...
Topics
Aliases
Arrays
Plugins
Scripting
Timers
Triggers
Variables
Functions
(AddTimer) Adds a timer
(BroadcastPlugin) Broadcasts a message to all installed plugins
(CallPlugin) Calls a routine in a plugin
(DeleteTimer) Deletes a timer
(EnablePlugin) Enables or disables the specified plugin
(EnableTimer) Enables or disables an timer
(GetPluginID) Returns the 24-character ID of the current plugin
(GetPluginInfo) Gets details about a specified plugin
(GetPluginList) Gets a list of installed plugins.
(GetPluginName) Returns the name of the current plugin
(GetPluginTimerInfo) Gets details about a named timer for a specified plugin
(GetPluginVariable) Gets the contents of a variable belonging to a plugin
(GetPluginVariableList) Gets the list of variables in a specified plugin
(GetTimer) Gets details about a timer
(GetTimerInfo) Gets details about a timer
(GetTimerList) Gets the list of timers
(IsPluginInstalled) Checks to see if a particular plugin is installed
(IsTimer) Tests to see if a timer exists
(LoadPlugin) Loads a plugin from disk
(PluginSupports) Checks if a plugin supports a particular routine
(ReloadPlugin) Reloads an installed plugin
(SaveState) Saves the state of the current plugin
(UnloadPlugin) Unloads an installed plugin
(Help topic: function=GetPluginTimerList)