world.ArrayDelete

MUSHclient script function (Method) — introduced in version 3.46

Deletes an array

Prototype

long ArrayDelete(BSTR Name);

Data type meanings

Description

This deletes a previously-created arrays. All values are discarded. Arrays are automatically deleted when the world is closed, or the plugin closed if the array is in a plugin.

VBscript example

ArrayDelete "spells"

Lua example

ArrayDelete "spells"

Return value

eBadArrayName: Name cannot be empty
eArrayDoesNotExist: Array does not exist
eOK: Deleted OK

Return code meanings

Related topic

Arrays

See also

FunctionDescription
ArrayClearClears an array
ArrayCreateCreates an array
ArrayDeleteKeyDeletes a key/value pair from an array