Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.ArrayCreate


Name ArrayCreate
Type Method
Summary Creates an array
Prototype long ArrayCreate(BSTR Name);
Description

This creates an array for use by scripting. The array name may consist of any characters (except the "null" character, hex 00), and is case-sensitive.

The array must be created before it is used.


Note: Available in version 3.46 onwards.


VBscript example
ArrayCreate "spells"
Lua example
ArrayCreate "spells"
Returns eBadArrayName: Name cannot be empty
eArrayAlreadyExists: Array already exists
eOK: Created OK
Introduced in version 3.46

See also ...

Function Description
ArrayClear Clears an array
ArrayDelete Deletes an array
ArrayListAll Gets the list of arrays

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.