world.GetTrigger

MUSHclient script function (Method)

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

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

Return code meanings

Related topic

Triggers

See also