Search FAQ

IsTrigger

Script function

world.IsTrigger

Read about scripting

Type

Method

Summary

Tests to see if a trigger exists

Prototype

long IsTrigger(BSTR TriggerName);

View list of data type meanings

Description

Used to test if a trigger exists.

Note that this function returns 0 if the trigger *exists*.


VBscript example

world.note world.IsTrigger ("myTrigger")


Jscript example

world.note(world.IsTrigger("myTrigger"));


PerlScript example

$world->note($world->IsTrigger("myTrigger"));


Python example

world.note(world.IsTrigger("myTrigger"))


Lua example

Note(IsTrigger("myTrigger"))


Return value

eInvalidObjectLabel: The trigger name is not valid
eTriggerNotFound: The named trigger does not exist
eOK: completed OK (ie. The trigger exists)

View list of return code meanings

See Also ...

Topics

Aliases
Default triggers/aliases/timers/macros/colours
Getting started
Groups
Plugins
Regular Expressions
Timers
Triggers

Functions

(AddTrigger) Adds a trigger
(AddTriggerEx) Adds a trigger - extended arguments
(DeleteTemporaryTriggers) Deletes all temporary triggers
(DeleteTrigger) Deletes a trigger
(DeleteTriggerGroup) Deletes a group of triggers
(EnableTrigger) Enables or disables a trigger
(EnableTriggerGroup) Enables/disables a group of triggers
(GetPluginTriggerInfo) Gets details about a named trigger for a specified plugin
(GetPluginTriggerList) Gets the list of triggers in a specified plugin
(GetTrigger) Gets details about a named trigger
(GetTriggerInfo) Gets details about a named trigger
(GetTriggerList) Gets the list of triggers
(GetTriggerOption) Gets the value of a named trigger option
(GetTriggerWildcard) Returns the contents of the specified wildcard for the named trigger
(SetTriggerOption) Sets the value of a named trigger option
(StopEvaluatingTriggers) Stops trigger evaluation

(Help topic: function=IsTrigger)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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