[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.IsTrigger


Name IsTrigger
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"))
Returns 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 ...

Function Description
AddTrigger Adds a trigger
DeleteTrigger Deletes a trigger
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

Search for script function

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.

Search for:   

Leave blank to show all functions.


Return codes

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

You can view a list of the return codes


Function prototypes

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

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]