Script function

world.ArrayExists

Type

Method

Summary

Tests to see if the specified array exists

Prototype

boolean ArrayExists(BSTR Name);

Description

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

Available in MUSHclient version 3.46 onwards.

VBscript example

Note ArrayExists ("spells")

Lua example

Note (ArrayExists ("spells"))

Return value

TRUE if the array exists.
FALSE if it does not exist.

Note: TRUE is a non-zero value, FALSE is the value 0.

See Also ...

Topics

Arrays
Plugins
Scripting
Variables

Functions

(ArrayClear) Clears an array
(ArrayCount) Returns the number of arrays
(ArrayCreate) Creates an array
(ArrayDelete) Deletes an array
(ArrayDeleteKey) Deletes a key/value pair from an array
(ArrayExport) Exports values from an array into a single string
(ArrayExportKeys) Exports keys from an array into a single string
(ArrayGet) Gets the value of an array item
(ArrayGetFirstKey) Gets the key of the first element in the array (if any)
(ArrayGetLastKey) Gets the key of the last element in the array (if any)
(ArrayImport) Imports values into an array from a single string
(ArrayKeyExists) Tests to see if the specified array key exists
(ArrayListAll) Gets the list of arrays
(ArrayListKeys) Gets the list of all the keys in an array
(ArrayListValues) Gets the list of all the values in an array
(ArraySet) Sets the value of an array item
(ArraySize) Returns the number of elements in a specified array

(Help topic: function=ArrayExists)