world.ArrayGet

MUSHclient script function (Method) — introduced in version 3.46

Gets the value of an array item

Prototype

VARIANT ArrayGet(BSTR Name, BSTR Key);

Data type meanings

Description

This retrieves the value for a specified key, for a specified array.

VBscript example

Note ArrayGet ("spells", "galvanic whip")

Lua example

Note (ArrayGet ("spells", "galvanic whip"))

Lua notes

Lua returns nil where applicable instead of an "empty variant".

Return value

The value for the specified key for the specified array.

However if any of the following conditions is met, an "empty" variant is returned:

* Bad array name
* Bad key name
* Array does not exist
* Key does not exist

Related topic

Arrays

See also

FunctionDescription
ArrayClearClears an array
ArrayCreateCreates an array
ArrayDeleteKeyDeletes a key/value pair from an array
ArrayGetFirstKeyGets the key of the first element in the array (if any)
ArrayGetLastKeyGets the key of the last element in the array (if any)
ArrayKeyExistsTests to see if the specified array key exists
ArrayListKeysGets the list of all the keys in an array