world.DeleteTrigger

MUSHclient script function (Method)

Deletes a trigger

Prototype

long DeleteTrigger(BSTR TriggerName);

Data type meanings

Description

Deletes the named trigger from the list of triggers.

WARNING - if the trigger is executing a script it cannot be deleted. For example, a trigger cannot delete itself.

If you need to delete a trigger from within itself use DoAfterSpecial to delete it after a short delay. You might also want to use EnableTrigger to disable it first.

VBscript example

world.DeleteTrigger "my_trigger"

Jscript example

world.DeleteTrigger("my_trigger");

PerlScript example

$world->DeleteTrigger("my_trigger");

Python example

world.DeleteTrigger("my_trigger")

Lua example

DeleteTrigger("my_trigger")

Return value

eInvalidObjectLabel: The trigger name is not valid
eTriggerNotFound: The named trigger does not exist
eItemInUse: The trigger is currently executing a script
eOK: deleted OK

Return code meanings

Related topic

Triggers

See also