Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ArrayDelete

Name ArrayDelete
Type Method
Summary Deletes an array
Prototype long ArrayDelete(BSTR Name);

View list of 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.

Note: Available in version 3.46 onwards.
VBscript example 
ArrayDelete "spells"
Lua example 
ArrayDelete "spells"
Returns eBadArrayName: Name cannot be empty
eArrayDoesNotExist: Array does not exist
eOK: Deleted OK

View list of return code meanings
Introduced in version 3.46

See also ...

Function Description
ArrayClear Clears an array
ArrayCreate Creates an array
ArrayDeleteKey Deletes a key/value pair from an array

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home