ArrayGetFirstKey
Script function

world.ArrayGetFirstKey

DOC_scripting Read about scripting

Type

Method

Summary

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

Prototype

VARIANT ArrayGetFirstKey(BSTR Name);

DOC_data_types 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

DOC_Arrays Arrays
DOC_plugins Plugins
DOC_scripting Scripting
DOC_variables Variables

Functions

FNC_ArrayClear ArrayClear (Clears an array)
FNC_ArrayCount ArrayCount (Returns the number of arrays)
FNC_ArrayCreate ArrayCreate (Creates an array)
FNC_ArrayDelete ArrayDelete (Deletes an array)
FNC_ArrayDeleteKey ArrayDeleteKey (Deletes a key/value pair from an array)
FNC_ArrayExists ArrayExists (Tests to see if the specified array exists)
FNC_ArrayExport ArrayExport (Exports values from an array into a single string)
FNC_ArrayExportKeys ArrayExportKeys (Exports keys from an array into a single string)
FNC_ArrayGet ArrayGet (Gets the value of an array item)
FNC_ArrayGetLastKey ArrayGetLastKey (Gets the key of the last element in the array (if any))
FNC_ArrayImport ArrayImport (Imports values into an array from a single string)
FNC_ArrayKeyExists ArrayKeyExists (Tests to see if the specified array key exists)
FNC_ArrayListAll ArrayListAll (Gets the list of arrays)
FNC_ArrayListKeys ArrayListKeys (Gets the list of all the keys in an array)
FNC_ArrayListValues ArrayListValues (Gets the list of all the values in an array)
FNC_ArraySet ArraySet (Sets the value of an array item)
FNC_ArraySize ArraySize (Returns the number of elements in a specified array)

(Help topic: function=ArrayGetFirstKey)

DOC_contents Documentation contents page