Script function
world.GetTrigger
Read about scripting
Type
Method
Summary
Gets details about a named trigger
Prototype
long GetTrigger(BSTR TriggerName, VARIANT* MatchText, VARIANT* ResponseText, VARIANT* Flags, VARIANT* Colour, VARIANT* Wildcard, VARIANT* SoundFileName, VARIANT* ScriptName);
View list of data type meanings
Description
Gets details about the specified trigger.
For a detailed description about the meanings of the fields, see AddTrigger.
This function does not appear to work when using Jscript or PerlScript, so if you are using those languages you should see GetTriggerInfo instead. See below for how it works with Lua.
VBscript example
dim trname
dim trmatch
dim trresponse
dim trflags
dim trcolour
dim trwildcard
dim trsoundfilename
dim trscriptname
dim iStatus
iStatus = world.gettrigger (trname, trmatch, trresponse,_
trflags, trcolour, trwildcard, trsoundfilename, trscriptname)
Jscript example
// Use GetTriggerInfo when using Jscript
PerlScript example
# Use GetTriggerInfo when using PerlScript
Python example
# Use GetTriggerInfo when using Python
Lua example
local status
local match
local response
local flags
local colour
local wildcard
local soundfilename
local scriptname
status, match, response, flags, colour, wildcard, soundfilename, scriptname =
GetTrigger ("mytrigger")
print (match, response, flags, colour, wildcard, soundfilename, scriptname)
Lua notes
Lua does not let you call by reference, however it can return multiple results.
Thus GetTrigger is implemented to return the various fields as a multiple-return result,
as shown in the example above.
Return value
eInvalidObjectLabel: The trigger name is not valid
eTriggerNotFound: The named trigger does not exist
eOK: completed OK
View list of return code meanings
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
(GetPluginTriggerInfo) Gets details about a named trigger for a specified plugin
(GetPluginTriggerList) Gets the list of triggers in a specified plugin
(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=GetTrigger)