MUSHclient documentation: ArrayListValues

ArrayListValues

ArrayListValues
Script function world.ArrayListValues Read about scripting Type Method Summary Gets the list of all the values in an array Prototype `VARIANT ArrayListValues(BSTR Name);` View list of 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).` 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) ArrayListAll (Gets the list of arrays) ArrayListKeys (Gets the list of all the keys in an array) ArraySet (Sets the value of an array item) ArraySize (Returns the number of elements in a specified array) (Help topic: function=ArrayListValues) Documentation contents page

Script function

world.ArrayListValues

Read about scripting

Type

Method

Summary

Gets the list of all the values in an array

Prototype

VARIANT ArrayListValues(BSTR Name);

View list of 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).

See Also ...

Topics

Arrays

Plugins

Scripting