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

MUSHclient scripting

Description of MUSHclient world function: world.ArrayExportKeys


Name ArrayExportKeys
Type Method
Summary Exports keys from an array into a single string
Prototype VARIANT ArrayExportKeys(BSTR Name, BSTR Delimiter);

View list of data type meanings

Description

Exports keys from the nominated array.

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

dispel magic,dragonskin,farsight,galvanic whip

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 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 want the key values as well as the names, use ArrayExport.


Note: Available in version 3.46 onwards.


VBscript example
Note ArrayExportKeys ("spells", ",")
Lua example
Note (ArrayExportKeys ("spells", ","))
Lua notes
The delimiter is optional, and defaults to the "," character.
Returns If successful, the return value is a string containing the keys 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 was not a single character, or was the backslash character
Introduced in version 3.46

See also ...

Function Description
ArrayExport Exports values from an array into a single string
ArrayGet Gets the value of an array item
ArrayImport Imports values into an array from a single string
ArrayListKeys Gets the list of all the keys in an array
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]