world.ArrayClear

MUSHclient script function (Method) — introduced in version 3.46

Clears an array

Prototype

long ArrayClear(BSTR Name);

Data type meanings

Description

This removes all values from the array, effectively making it empty.

VBscript example

ArrayClear "spells"

Lua example

ArrayClear "spells"

Return value

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

Return code meanings

Related topic

Arrays

See also