world.ArrayGetFirstKey

MUSHclient script function (Method) — introduced in version 3.46

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

Prototype

VARIANT ArrayGetFirstKey(BSTR Name);

Data type meanings

Description

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

The first element is the one with the lowest key, not the one that was inserted first.

You could use this to implement a queue (to pull out the first entry in the queue).

VBscript example

Note ArrayGetFirstKey ("spells")

Lua example

Note (ArrayGetFirstKey ("spells"))

Lua notes

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

Return value

The value of the first 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