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

MUSHclient scripting

Description of MUSHclient world function: world.ArrayListAll


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


Note: Available in 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
Returns 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.
Introduced in version 3.46

See also ...

Function Description
ArrayClear Clears an array
ArrayCreate Creates an array
ArrayDelete Deletes an array
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

[Back]

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.

[Home]


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]