Script function
world.ArrayDeleteKey
Read about scripting
Type
Method
Summary
Deletes a key/value pair from an array
Prototype
long ArrayDeleteKey(BSTR Name, BSTR Key);
View list of 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.
Available in MUSHclient version 3.46 onwards.
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
View list of return code meanings
See Also ...
Topics
Arrays
Plugins
Scripting
Variables
Functions
(ArrayClear) Clears an array
(ArrayCount) Returns the number of arrays
(ArrayCreate) Creates an array
(ArrayDelete) Deletes 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=ArrayDeleteKey)