world.ArrayCreate

MUSHclient script function (Method) — introduced in version 3.46

Creates an array

Prototype

long ArrayCreate(BSTR Name);

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.

VBscript example

ArrayCreate "spells"

Lua example

ArrayCreate "spells"

Return value

eBadArrayName: Name cannot be empty
eArrayAlreadyExists: Array already exists
eOK: Created OK

Return code meanings

Related topic

Arrays

See also

FunctionDescription
ArrayClearClears an array
ArrayDeleteDeletes an array
ArrayListAllGets the list of arrays