world.GetPluginTriggerList

MUSHclient script function (Method) — introduced in version 3.23

Gets the list of triggers in a specified plugin

Prototype

VARIANT GetPluginTriggerList(BSTR PluginID);

Data type meanings

Description

Returns an array of all the named triggers currently defined for the nominated plugin. You can then use GetPluginTriggerInfo to find out more details about each one.

If you want to find the list of triggers in the current plugin, use "GetTriggerList".

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

trList = world.GetPluginTriggerList ("")

VBscript example

dim trList

trList = world.GetPluginTriggerList ("982581e59ab42844527eec80")

If Not IsEmpty (trList) Then
  for each t in trList
    world.note t
  next
End If

Jscript example

triggerlist = new VBArray(world.GetPluginTriggerList("982581e59ab42844527eec80")).toArray();

if (triggerlist)  // if not empty
 for (i = 0; i < triggerlist.length; i++)
   world.note(triggerlist [i]);

PerlScript example

foreach $item (Win32::OLE::in ($world->GetPluginTriggerList ("982581e59ab42844527eec80")))
 {
 $world->note($item);
 }

Python example

triggerlist = world.GetPluginTriggerList("982581e59ab42844527eec80")
if (triggerlist ):
  for t in triggerlist : world.Note (t)

Lua example

for k, v in pairs (GetPluginTriggerList ("982581e59ab42844527eec80")) do 
  Note (v) 
end

Return value

If there are no triggers (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 triggers in the specified plugin. Use "ubound" to find the number of triggers in the list. You can then use "GetPluginTrigger" to find details about each trigger.

Related topic

Triggers

See also