GetPluginTimerList
Script function

world.GetPluginTimerList

DOC_scripting Read about scripting

Type

Method

Summary

Gets the list of timers in a specified plugin

Prototype

VARIANT GetPluginTimerList(BSTR PluginID);

DOC_data_types 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 ("")

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

DOC_aliases Aliases
DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_timers Timers
DOC_triggers Triggers
DOC_variables Variables

Functions

FNC_AddTimer AddTimer (Adds a timer)
FNC_BroadcastPlugin BroadcastPlugin (Broadcasts a message to all installed plugins)
FNC_CallPlugin CallPlugin (Calls a routine in a plugin)
FNC_DeleteTimer DeleteTimer (Deletes a timer)
FNC_EnablePlugin EnablePlugin (Enables or disables the specified plugin)
FNC_EnableTimer EnableTimer (Enables or disables an timer)
FNC_GetPluginID GetPluginID (Returns the 24-character ID of the current plugin)
FNC_GetPluginInfo GetPluginInfo (Gets details about a specified plugin)
FNC_GetPluginList GetPluginList (Gets a list of installed plugins.)
FNC_GetPluginName GetPluginName (Returns the name of the current plugin)
FNC_GetPluginTimerInfo GetPluginTimerInfo (Gets details about a named timer for a specified plugin)
FNC_GetPluginVariable GetPluginVariable (Gets the contents of a variable belonging to a plugin)
FNC_GetPluginVariableList GetPluginVariableList (Gets the list of variables in a specified plugin)
FNC_GetTimer GetTimer (Gets details about a timer)
FNC_GetTimerInfo GetTimerInfo (Gets details about a timer)
FNC_GetTimerList GetTimerList (Gets the list of timers)
FNC_IsPluginInstalled IsPluginInstalled (Checks to see if a particular plugin is installed)
FNC_IsTimer IsTimer (Tests to see if a timer exists)
FNC_LoadPlugin LoadPlugin (Loads a plugin from disk)
FNC_PluginSupports PluginSupports (Checks if a plugin supports a particular routine)
FNC_ReloadPlugin ReloadPlugin (Reloads an installed plugin)
FNC_SaveState SaveState (Saves the state of the current plugin)

(Help topic: function=GetPluginTimerList)

DOC_contents Documentation contents page