world.ArrayExport

MUSHclient script function (Method) — introduced in version 3.46

Exports values from an array into a single string

Prototype

VARIANT ArrayExport(BSTR Name, BSTR Delimiter);

Data type meanings

Description

Exports key/value pairs from the nominated array.

They keys and values will be separated by the specified delimiter, for example:

dispel magic,15,dragonskin,45,farsight,15,galvanic whip,30

The first word is the key (eg. dispel magic) the second word is the value (eg. 15) and so on, until the list of keys/values is exhausted.

The list may be the empty string, which indicates that the array had no values.

You specify the delimiter (eg. a comma) so that you can use different delimiters if you want to. The delimiter must be a single character (eg. ",") other than the backslash character. If the keys, or the values, contain the delimiter they will be "escaped", for example if the delimiter is a comma then any commas will be exported as backslash-comma. (ie. "," becomes ","). Also, any backslashes are exported as double-backslashes. (eg. "" becomes "").

If you just want the key names and not the values, use ArrayExportKeys.

VBscript example

SetVariable "spells", ArrayExport ("spells", ",")

Lua example

SetVariable ("spells", ArrayExport ("spells", ","))

Lua notes

The delimiter is optional, and defaults to the "," character.

Return value

If successful, the return value is a string containing the key/value pairs for the specified array, separated by the delimiter.

If not successful, the return value is a number (type 'long') with one of the following error codes in it:

eBadArrayName: Name cannot be empty
eArrayDoesNotExist: Array does not exist
eBadDelimiter: The delimiter is not a single character, or is the backslash character

Related topic

Arrays

See also