MUSHclient scripting

Description of MUSHclient world function: world.DeleteTrigger

Name	DeleteTrigger
Type	Method
Summary	Deletes a trigger
Prototype	`long DeleteTrigger(BSTR TriggerName);` View list of 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")`
Returns	`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` View list of return code meanings

See also ...

Function	Description
AddTrigger	Adds a trigger
DeleteTriggerGroup	Deletes a group of triggers
DoAfterSpecial	Adds a one-shot, temporary, timer to carry out some special action
EnableTrigger	Enables or disables 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

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.

Leave blank to show all functions.

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

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

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