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

MUSHclient scripting

Description of MUSHclient world function: world.ArrayListKeys

Name ArrayListKeys
Type Method
Summary Gets the list of all the keys in an array
Prototype VARIANT ArrayListKeys(BSTR Name);

View list of data type meanings


Returns an array of all the keys in the nominated array. You could use this to then examine the value for each key (using ArrayGet).

You can also use ArrayListValues if all you are interested in is the values but not the keys they belong to.

Note: Available in version 3.46 onwards.

VBscript example
dim keyList

keyList = ArrayListKeys ("spells")

If Not IsEmpty (keyList) Then
  For Each k In keyList 
    world.note k & " = " & ArrayGet ("spells", k)

End If
Lua example
for k, v in pairs (ArrayListKeys ("spells")) do 
  Note (v) 

-- alternative - show keys and values:

table.foreach (ArrayList ("spells"), print)

-- show a particular value:

spells = ArrayList ("spells")
print (spells.dragonskin)
Lua notes
If the array does not exist, or is empty, Lua returns nil.

There is an extension for Lua only - ArrayList - which returns both keys and values.

See above example. The key of the table is the array key, the value is the array value.
Returns If there are no elements in the nominated array then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the keys in this array.

Use "lbound" and "ubound" to find the bounds of the array of keys (ie. the number of keys in the list). You can then use "ArrayGet" to find the values for each key.
Introduced in version 3.46

See also ...

Function Description
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
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

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]