Description of MUSHclient world function: world.ArrayExport
||Exports values from an array into a single string
VARIANT ArrayExport(BSTR Name, BSTR Delimiter);
View list of data type meanings
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.
Note: Available in version 3.46 onwards.
SetVariable "spells", ArrayExport ("spells", ",")
SetVariable ("spells", ArrayExport ("spells", ","))
The delimiter is optional, and defaults to the "," character.
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
|Introduced in version
See also ...
||Exports keys from an array into a single string
||Gets the value of an array item
||Imports values into an array from a single string
||Gets the list of all the keys in an array
||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.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise
of the function.
view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
view a list of the data types used in function prototypes
View all functions
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )