[Home] [Downloads] [Search] [Help/forum]

GetPluginTriggerInfo

Script function

world.GetPluginTriggerInfo

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

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)


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


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

Aliases
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Plugins
Regular Expressions
Timers
Triggers

Functions

(AddTrigger) Adds a trigger
(AddTriggerEx) Adds a trigger - extended arguments
(DeleteTemporaryTriggers) Deletes all temporary triggers
(DeleteTrigger) Deletes a trigger
(DeleteTriggerGroup) Deletes a group of triggers
(EnableTrigger) Enables or disables a trigger
(EnableTriggerGroup) Enables/disables a group of triggers
(GetPluginTriggerList) Gets the list of triggers in a specified plugin
(GetTrigger) Gets details about a named trigger
(GetTriggerInfo) Gets details about a named trigger
(GetTriggerList) Gets the list of triggers
(GetTriggerOption) Gets the value of a named trigger option
(GetTriggerWildcard) Returns the contents of the specified wildcard for the named trigger
(IsTrigger) Tests to see if a trigger exists
(SetTriggerOption) Sets the value of a named trigger option
(StopEvaluatingTriggers) Stops trigger evaluation

(Help topic: function=GetPluginTriggerInfo)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]