world.EnableTrigger

MUSHclient script function (Method)

Enables or disables a trigger

Prototype

long EnableTrigger(BSTR TriggerName, BOOL Enabled);

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.

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