world.GetDefaultValue

MUSHclient script function (Method) — introduced in version 3.23

Gets the default value of a named world option

Prototype

VARIANT GetDefaultValue(BSTR OptionName);

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.

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.

Related topic

Option setting and retrieval

See also