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

MUSHclient scripting

Description of MUSHclient world function: world.GetTrigger

Name GetTrigger
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


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.
Returns 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 ...

Function Description
AddTrigger Adds a trigger
DeleteTrigger Deletes a trigger
EnableTrigger Enables or disables a trigger
GetTriggerInfo Gets details about a named trigger
GetTriggerList Gets the list of triggers
IsTrigger Tests to see if a trigger exists

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


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