world.IsTrigger

MUSHclient script function (Method)

Tests to see if a trigger exists

Prototype

long IsTrigger(BSTR TriggerName);

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)

Return code meanings

Related topic

Triggers

See also

FunctionDescription
AddTriggerAdds a trigger
DeleteTriggerDeletes a trigger
EnableTriggerEnables or disables a trigger
GetTriggerGets details about a named trigger
GetTriggerInfoGets details about a named trigger
GetTriggerListGets the list of triggers