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

ArrayClear

Script function

world.ArrayClear

Read about scripting

Type

Method

Summary

Clears an array

Prototype

long ArrayClear(BSTR Name);

View list of data type meanings

Description

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


Available in MUSHclient version 3.46 onwards.



VBscript example

ArrayClear "spells"


Lua example

ArrayClear "spells"


Return value

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

View list of return code meanings

See Also ...

Topics

Arrays
Plugins
Scripting
Variables

Functions

(ArrayCount) Returns the number of arrays
(ArrayCreate) Creates an array
(ArrayDelete) Deletes an array
(ArrayDeleteKey) Deletes a key/value pair from 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=ArrayClear)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]