world.ArrayDeleteKey

MUSHclient script function (Method) — introduced in version 3.46

Deletes a key/value pair from an array

Prototype

long ArrayDeleteKey(BSTR Name, BSTR Key);

Data type meanings

Description

This deletes a key/value pair from an array. You specify which key to delete, and if it exists in the array, it is deleted.

VBscript example

ArrayDeleteKey "spells", "farsight"

Lua example

ArrayDeleteKey ("spells", "farsight")

Return value

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

Return code meanings

Related topic

Arrays

See also