[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.ArrayGetFirstKey

Name ArrayGetFirstKey
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


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).

Note: Available in version 3.46 onwards.

VBscript example
Note ArrayGetFirstKey ("spells")
Lua example
Note (ArrayGetFirstKey ("spells"))
Lua notes
Lua returns nil where applicable instead of an "empty variant".
Returns 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
Introduced in version 3.46

See also ...

Function Description
ArrayClear Clears an array
ArrayCreate Creates an array
ArrayDeleteKey Deletes a key/value pair from an array
ArrayGet Gets the value of an array item
ArrayGetLastKey Gets the key of the last element in the array (if any)
ArrayKeyExists Tests to see if the specified array key exists
ArrayListKeys Gets the list of all the keys in an array

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]