Script function
world.ArrayListAll
Read about scripting
Type
Method
Summary
Gets the list of arrays
Prototype
VARIANT ArrayListAll();
View list of data type meanings
Description
Returns an array of all the arrays currently defined.
Available in MUSHclient version 3.46 onwards.
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.
See Also ...
Topics
Arrays
Plugins
Scripting
Variables
Functions
(ArrayClear) Clears an array
(ArrayCount) Returns the number of arrays
(ArrayCreate) Creates an array
(ArrayDelete) Deletes an array
(ArrayDeleteKey) Deletes a key/value pair from an array
(ArrayExists) Tests to see if the specified array exists
(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
(ArrayGetFirstKey) Gets the key of the first element in the array (if any)
(ArrayGetLastKey) Gets the key of the last element in the array (if any)
(ArrayImport) Imports values into an array from a single string
(ArrayKeyExists) Tests to see if the specified array key exists
(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
(ArraySize) Returns the number of elements in a specified array
(Help topic: function=ArrayListAll)