world.ArrayListAll

MUSHclient script function (Method) — introduced in version 3.46

Gets the list of arrays

Prototype

VARIANT ArrayListAll();

Data type meanings

Description

Returns an array of all the arrays currently defined.

VBscript example

dim arrList

arrList = world.ArrayListAll

If Not IsEmpty (arrList) Then
  
  For Each a In arrList 
    world.note a
  Next

End If

Lua example

for k, v in pairs (ArrayListAll ()) do 
  Note (v) 
end

Return value

If there are no arrays 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 arrays.

Use "lbound" and "ubound" to find the bounds of the array of arrays (ie. the number of arrays in the list). You can then use "ArrayListKeys" to find the keys for each array.

Related topic

Arrays

See also