Script function
world.GetDefaultValue
Read about scripting
Type
Method
Summary
Gets the default value of a named world option
Prototype
VARIANT GetDefaultValue(BSTR OptionName);
View list of data type meanings
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.
Available in MUSHclient version 3.23 onwards.
VBscript example
world.note world.GetDefaultValue ("port")
world.note world.GetDefaultValue("player")
Jscript example
world.note (world.GetDefaultValue ("port"));
world.note (world.GetDefaultValue ("player"));
PerlScript example
$world->note ($world->GetDefaultValue ("port"));
$world->note ($world->GetDefaultValue ("player"));
Python example
world.note (world.GetDefaultValue ("port"))
world.note (world.GetDefaultValue ("player"))
Lua example
Note (GetDefaultValue ("port"))
Note (GetDefaultValue ("player"))
Return value
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 ...
Topic
Option setting and retrieval
Functions
(GetAlphaOption) Gets the value of an alphanumeric configuration option
(GetAlphaOptionList) Gets the list of world alphanumeric options
(GetCurrentValue) Gets the current value of a named world option
(GetGlobalOption) Gets the value of a global configuration option
(GetGlobalOptionList) Gets the list of global options
(GetLoadedValue) Gets value of a named world option, as loaded from the world file
(GetOption) Gets value of a named world option
(GetOptionList) Gets the list of world options
(SetAlphaOption) Sets value of a named world alphanumeric option
(SetInputFont) Sets the font for the input window
(SetOption) Sets value of a named world option
(SetOutputFont) Sets the font for the output window.
(Help topic: function=GetDefaultValue)