world.StopEvaluatingTriggers

MUSHclient script function (Method) — introduced in version 4.89

Stops trigger evaluation

Prototype

void StopEvaluatingTriggers(BOOL AllPlugins);

Data type meanings

Description

Call this function from a trigger script to stop trigger evaluation. This would have to be called from "send to script" (not send-to-script-after-omit), nor from a trigger script file, in order to be effective.

This causes trigger evaluation to stop, for the current line, and the current plugin. If not in a plugin, then all triggers in the "main" world trigger list stop being evaluated.

If the argument is true, then no further trigger evaluation takes place, in any further plugins.

Note that since calling a trigger script (script name in Script box) is done after all triggers are evaluated for that plugin, doing this inside a script file will be too late (for the current plugin). It has to be done in send-to-script.

Lua example

StopEvaluatingTriggers (true)

Return value

None.

Related topic

Triggers

See also

FunctionDescription
AddTriggerAdds a trigger
GetTriggerInfoGets details about a named trigger
GetTriggerOptionGets the value of a named trigger option