Description of MUSHclient world function: world.GetAlphaOptionList
Name | GetAlphaOptionList |
---|---|
Type | Method |
Summary | Gets the list of world alphanumeric options |
Prototype | VARIANT GetAlphaOptionList();
|
Description | Returns a variant array which is a list of all options that you can get with GetAlphaOption or set with SetAlphaOption. Note: Available in version 3.22 onwards. |
VBscript example |
|
Jscript example |
|
PerlScript example |
|
Python example |
|
Lua example |
|
Returns | It returns a variant array containing the names of all the options. Use "ubound" to find the number of options in the list. You can then use "GetAlphaOption" to return the value for that particular option, or "SetAlphaOption" to set that option value. |
Introduced in version | 3.22 |
See also ...
Function | Description |
---|---|
GetAlphaOption | Gets the value of an alphanumeric configuration option |
GetInfo | Gets information about the current world |
GetOption | Gets value of a named world option |
GetOptionList | Gets the list of world options |
SetAlphaOption | Sets value of a named world alphanumeric option |
SetOption | Sets value of a named world option |
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.
You can 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).
You can view a list of the data types used in function prototypes
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.