Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.EnableTrigger

Name EnableTrigger
Type Method
Summary Enables or disables a trigger
Prototype long EnableTrigger(BSTR TriggerName, BOOL Enabled);

View list of data type meanings
Description

Enables or disables the named trigger. An enabled trigger is "active", otherwise it is ignored when processing incoming text from the MUD.
VBscript example 
world.EnableTrigger "monster", TRUE  ' enable trigger
world.EnableTrigger "monster", FALSE  ' disable trigger
Jscript example 
world.EnableTrigger("monster", true);  # enable trigger
world.EnableTrigger("monster", false);  # disable trigger
Python example 
world.EnableTrigger("monster", True)  # enable trigger
world.EnableTrigger("monster", False)  # disable trigger
Lua example 
EnableTrigger("monster", true)  -- enable trigger
EnableTrigger("monster", false)  -- disable trigger
Lua notes 
The enabled flag is optional, and defaults to true.
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
GetTrigger Gets details about a named 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

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home