Script function
world.ArrayCreate
Read about scripting
Type
Method
Summary
Creates an array
Prototype
long ArrayCreate(BSTR Name);
View list of data type meanings
Description
This creates an array for use by scripting. The array name may consist of any characters (except the "null" character, hex 00), and is case-sensitive.
The array must be created before it is used.
Available in MUSHclient version 3.46 onwards.
VBscript example
ArrayCreate "spells"
Lua example
ArrayCreate "spells"
Return value
eBadArrayName: Name cannot be empty
eArrayAlreadyExists: Array already exists
eOK: Created 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
(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
(ArraySet) Sets the value of an array item
(ArraySize) Returns the number of elements in a specified array
(Help topic: function=ArrayCreate)