Script function
world.ArraySet
Read about scripting
Type
Method
Summary
Sets the value of an array item
Prototype
long ArraySet(BSTR Name, BSTR Key, BSTR Value);
View list of data type meanings
Description
This sets the value for a specified key, for a specified array.
Available in MUSHclient version 3.46 onwards.
VBscript example
ArraySet "spells", "dragonskin", "45"
Lua example
ArraySet ("spells", "dragonskin", "45")
Return value
eBadArrayName: Name cannot be empty
eBadKeyName: Key cannot be empty
eArrayDoesNotExist: Array does not exist
eSetReplacingExistingValue: Value set, however it overwrote an existing value
eOK: Set OK
View list of return code meanings
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
(ArrayListValues) Gets the list of all the values in an array
(ArraySize) Returns the number of elements in a specified array
(Help topic: function=ArraySet)