Name GetPluginTriggerInfo
Type Method
Summary Gets details about a named trigger for a specified plugin
Prototype VARIANT GetPluginTriggerInfo(BSTR PluginID, BSTR TriggerName, short InfoType);
Description Gets details about the specified trigger for the specified plugin.

You can obtain various "types" of information about the trigger by specifying an "InfoType". The possible InfoTypes are described under GetTriggerInfo.

If the named trigger does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the InfoType given is out of range, NULL is returned. If the plugin does not exist, NULL is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

If you want to find the value of a trigger in the current plugin, use "GetTriggerInfo".

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

world.Note world.GetPluginTriggerInfo ("", "my_trigger", 1)

Note: Available in MUSHclient version 3.23 onwards.
VBscript example
world.note world.GetPluginTriggerInfo ("c8efc9f9e1edd118c6f2dbf5", "monster", 2)
Jscript example
/world.note(world.GetPluginTriggerInfo ("c8efc9f9e1edd118c6f2dbf5", "monster", 2));
PerlScript example
/$world->note ($world->GetPluginTriggerInfo ("c8efc9f9e1edd118c6f2dbf5", "monster", 2));
Returns The specified information about the trigger, as described above.
An EMPTY variant, if the trigger does not exist.
A NULL variant if the trigger name is invalid.
A NULL variant if the InfoType is not a valid type.
A NULL variant if the plugin is not installed.

See also ...