Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ArrayKeyExists

Name ArrayKeyExists
Type Method
Summary Tests to see if the specified array key exists
Prototype boolean ArrayKeyExists(BSTR Name, BSTR Key);

View list of data type meanings
Description

This returns TRUE (1) if the specified key in the specified array exists, and FALSE (0) if it does not.

Note: Available in version 3.46 onwards.
VBscript example 
Note ArrayKeyExists ("spells", "farsight")
Lua example 
Note (ArrayKeyExists ("spells", "farsight"))
Returns TRUE if the key in the array exists.
FALSE if it does not exist.

Note: TRUE is a non-zero value, FALSE is the value 0.
Introduced in version 3.46

See also ...

Function Description
ArrayCount Returns the number of arrays
ArrayCreate Creates an array
ArrayDelete Deletes an array
ArrayListAll Gets the list of arrays
ArrayListKeys Gets the list of all the keys in an array

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]

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

Home