[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.ArrayDeleteKey


Name ArrayDeleteKey
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.


Note: Available in version 3.46 onwards.


VBscript example
ArrayDeleteKey "spells", "farsight"
Lua example
ArrayDeleteKey ("spells", "farsight")
Returns 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

Introduced in version 3.46

See also ...

Function Description
ArrayClear Clears an array
ArrayCreate Creates an array
ArrayDelete Deletes an array
ArrayGet Gets the value of an array item
ArraySet Sets the value of an array item

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]