| Name | GetDefaultValue |
|---|---|
| Type | Method |
| Summary | Gets the default value of a named world option |
| Prototype | VARIANT GetDefaultValue(BSTR OptionName); |
| Description | Gets the default value of a MUSHclient <world> option, as it would be directly after creating a new world. You can use GetOptionList, and GetAlphaOptionList, to get a list of the names of all possible options. The return type is Variant, so the returned value will be the appropriate type for the data (ie. string or number (long)). If the option name is not known, or is not allowed to be retrieved, a NULL variant is returned. Note: Available in MUSHclient version 3.23 onwards. |
| VBscript example | |
| Jscript example | |
| PerlScript example | |
| Returns | The value of the requested option, or a NULL variant if the option does not exist, or is not permitted to be read. |
See also ...