GetPluginTriggerInfo
Script function

world.GetPluginTriggerInfo

DOC_scripting Read about scripting

Type

Method

Summary

Gets details about a named trigger for a specified plugin

Prototype

VARIANT GetPluginTriggerInfo(BSTR PluginID, BSTR TriggerName, short InfoType);

DOC_data_types View list of data type meanings

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)

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));


Python example

world.note(world.GetPluginTriggerInfo ("c8efc9f9e1edd118c6f2dbf5", "monster", 2))


Lua example

Note (GetPluginTriggerInfo ("c8efc9f9e1edd118c6f2dbf5", "monster", 2))


Lua notes

Lua returns nil where applicable instead of an "empty variant" or "null variant".


Return value

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 ...

Topics

DOC_aliases Aliases
DOC_defaults Default triggers/aliases/timers/macros/colours
DOC_starting Getting started
DOC_group Groups
DOC_plugins Plugins
DOC_regexp Regular Expressions
DOC_timers Timers
DOC_triggers Triggers

Functions

FNC_AddTrigger AddTrigger (Adds a trigger)
FNC_AddTriggerEx AddTriggerEx (Adds a trigger - extended arguments)
FNC_DeleteTemporaryTriggers DeleteTemporaryTriggers (Deletes all temporary triggers)
FNC_DeleteTrigger DeleteTrigger (Deletes a trigger)
FNC_DeleteTriggerGroup DeleteTriggerGroup (Deletes a group of triggers)
FNC_EnableTrigger EnableTrigger (Enables or disables a trigger)
FNC_EnableTriggerGroup EnableTriggerGroup (Enables/disables a group of triggers)
FNC_GetPluginTriggerList GetPluginTriggerList (Gets the list of triggers in a specified plugin)
FNC_GetTrigger GetTrigger (Gets details about a named trigger)
FNC_GetTriggerInfo GetTriggerInfo (Gets details about a named trigger)
FNC_GetTriggerList GetTriggerList (Gets the list of triggers)
FNC_GetTriggerOption GetTriggerOption (Gets the value of a named trigger option)
FNC_GetTriggerWildcard GetTriggerWildcard (Returns the contents of the specified wildcard for the named trigger)
FNC_IsTrigger IsTrigger (Tests to see if a trigger exists)
FNC_SetTriggerOption SetTriggerOption (Sets the value of a named trigger option)

(Help topic: function=GetPluginTriggerInfo)

DOC_contents Documentation contents page