GetTrigger
Script function

world.GetTrigger

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

DOC_data_types 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


DOC_errors View list of return code meanings

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

DOC_contents Documentation contents page