world.ArrayListValues

MUSHclient script function (Method) — introduced in version 3.46

Gets the list of all the values in an array

Prototype

VARIANT ArrayListValues(BSTR Name);

Data type meanings

Description

Returns an array of all the values in the nominated array. That is, the values for each entry but not the keys.

You can also use ArrayListKeys if you want to find the keys instead.

VBscript example

dim valList

valList = ArrayListValues ("spells")

If Not IsEmpty (valList) Then
  
  For Each v In valList 
    world.note v 
  Next

End If

Lua example

for k, v in pairs (ArrayListValues ("spells")) do 
  Note (v) 
end

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

Return value

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 all of the values in this array.

Use "lbound" and "ubound" to find the bounds of the array of values (ie. the number of values in the list).

Related topic

Arrays

See also