ArrayGetFirstKey
Script function world.ArrayGetFirstKey Read about scripting Type Method Summary Gets the key of the first element in the array (if any) Prototype `VARIANT ArrayGetFirstKey(BSTR Name);` View list of 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. 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
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) ArrayExists (Tests to see if the specified array exists) 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) 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=ArrayGetFirstKey) Documentation contents page