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

Register forum user name Search FAQ


Script function


Read about scripting




Gets details about a named trigger


VARIANT GetTriggerInfo(BSTR TriggerName, short InfoType);

View list of data type meanings


Gets details about the specified trigger.

You can obtain one of 38 "types" of information about the trigger by specifying an "InfoType". The possible InfoTypes are:

1: What to match on (string)
2: What to send (string)
3: Sound to play (string)
4: Script procedure name (string)
5: Omit from log (boolean)
6: Omit from output (boolean)
7: Keep evaluating (boolean)
8: Enabled (boolean)
9: Regular expression (boolean)
10: Ignore case (boolean)
11: Repeat on same line (boolean)
12: Play sound if inactive (boolean)
13: Expand variables (boolean)
14: Which wildcard to send to clipboard (short)
15: Send to - see below (short)
16: Sequence (short)
17: Match on (colour/style) (short)
18: Change to style (short)
19: Change to colour (short)
20: Invocation count (long)
21: Times matched (long)
22: Date/time trigger last matched (date)
23: 'temporary' flag (boolean)
24: Trigger was included from an include file (boolean)
25: Make wildcards lower case flag (boolean)
26: Group name (string)
27: Variable name (string)
28: User option value (long)
29: Other colour foreground colour value (long)
30: Other colour backgroundground colour value (long)
31: Number of matches to regular expression (most recent match) (long)
32: The string we matched against (last trigger text matched against) (string)
33: Executing-script flag (boolean)
34: Script is valid flag (boolean)
35: Error number from PCRE when evaluating last match (long), zero if none
36: 'one shot' flag (boolean)
37: Time taken (in seconds) to test triggers (including un-matched ones) (double)
38: Number of attempts to match this trigger (long)

101: Wildcard %1 from last time it matched
102: Wildcard %2 from last time it matched
103: Wildcard %3 from last time it matched
104: Wildcard %4 from last time it matched
105: Wildcard %5 from last time it matched
106: Wildcard %6 from last time it matched
107: Wildcard %7 from last time it matched
108: Wildcard %8 from last time it matched
109: Wildcard %9 from last time it matched
110: Wildcard %0 from last time it matched

Other wildcards can be extracted by using GetTriggerWildcard.

The word in brackets indicates the "type" of data returned.
String: a character string (eg. "north")
Boolean: TRUE or FALSE
Short: a 16-bit number
Long: a 32-bit number

The field "send to" indicates where the trigger response (item 2) gets sent:

0: World
1: Command window
2: Output window
3: Status line
4: Notepad (new)
5: Notepad (append)
6: Log File
7: Notepad (replace)
8: Command queue
9: Send To Variable
10: Execute (re-parse as command)
11: Speedwalk (send text is speedwalk, queue it)
12: Script (send to script engine)
13: Immediate (send to world in front of speedwalk queue)
14: Script - after omit (send to script engine, after omitting matching line from output)

The field "invocation count" is a count of how many times the script routine was called.
The field "times matched" is a count of how many times the trigger matched. These two would normally be the same, unless scripting was disabled, or there was an error in the script file.

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. (Use "IsEmpty" and "IsNull" to test for these possibilities).

For a detailed description about the meanings of the fields, see AddTrigger.

If GetTriggerInfo is called from within a plugin, the triggers for the current plugin are used, not the "global" MUSHclient triggers.

If you want to information about a trigger in another plugin, or the global MUSHclient triggers, use "GetPluginTriggInfo".

VBscript example

world.note world.gettriggerinfo ("monster", 2)

Jscript example

/world.note(world.gettriggerinfo ("monster", 2));

PerlScript example

/$world->note ($world->gettriggerinfo ("monster", 2));

Python example

world.note(world.gettriggerinfo ("monster", 2))

Lua example

Note (GetTriggerInfo ("monster", 2))

Lua notes

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

The "SendTo" field can be looked up using the "sendto" table in the Lua global address space, as follows:

sendto.world = 0
sendto.command = 1
sendto.output = 2
sendto.status = 3
sendto.notepad = 4
sendto.notepadappend = 5
sendto.logfile = 6
sendto.notepadreplace = 7
sendto.commandqueue = 8
sendto.variable = 9
sendto.execute = 10
sendto.speedwalk = 11
sendto.script = 12
sendto.immediate = 13
sendto.scriptafteromit = 14

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.

See Also ...


Default triggers/aliases/timers/macros/colours
Getting started
Regular Expressions


(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
(GetInfo) Gets information about the current world
(GetPluginTriggerInfo) Gets details about a named trigger for a specified plugin
(GetPluginTriggerList) Gets the list of triggers in a specified plugin
(GetTrigger) 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=GetTriggerInfo)

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.


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 HostDash]