world.ArrayGetLastKey

MUSHclient script function (Method) — introduced in version 3.46

Gets the key of the last element in the array (if any)

Prototype

VARIANT ArrayGetLastKey(BSTR Name);

Data type meanings

Description

This retrieves the key of the last element in a specified array. You can then use ArrayGet to get the value associated with that key.

You could use this to implement a stack (to pull out the last entry in the stack).

VBscript example

Note ArrayGetLastKey ("spells")

Lua example

Note (ArrayGetLastKey ("spells"))

Lua notes

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

Return value

The value of the last key for the specified array.

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

* Bad array name
* Array does not exist
* Array is empty

Related topic

Arrays

See also

FunctionDescription
ArrayClearClears an array
ArrayCreateCreates an array
ArrayDeleteKeyDeletes a key/value pair from an array
ArrayGetGets the value of an array item
ArrayGetFirstKeyGets the key of the first 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