Script function

world.ArrayGet

Type

Method

Summary

Gets the value of an array item

Prototype

VARIANT ArrayGet(BSTR Name, BSTR Key);

Description

This retrieves the value for a specified key, for a specified array.

Available in MUSHclient version 3.46 onwards.

VBscript example

Note ArrayGet ("spells", "galvanic whip")

Lua example

Note (ArrayGet ("spells", "galvanic whip"))

Lua notes

Lua returns nil where applicable instead of an "empty variant".

Return value

The value for the specified key for the specified array.

However if any of the following conditions is met, an "empty" variant is returned:

* Bad array name
* Bad key name
* Array does not exist
* Key does not exist

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
(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
(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=ArrayGet)