GetDefaultValue
Script function

world.GetDefaultValue

DOC_scripting Read about scripting

Type

Method

Summary

Gets the default value of a named world option

Prototype

VARIANT GetDefaultValue(BSTR OptionName);

DOC_data_types 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.

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

DOC_options Option setting and retrieval

Functions

FNC_GetAlphaOption GetAlphaOption (Gets the value of an alphanumeric configuration option)
FNC_GetAlphaOptionList GetAlphaOptionList (Gets the list of world alphanumeric options)
FNC_GetCurrentValue GetCurrentValue (Gets the current value of a named world option)
FNC_GetLoadedValue GetLoadedValue (Gets value of a named world option, as loaded from the world file)
FNC_GetOption GetOption (Gets value of a named world option)
FNC_GetOptionList GetOptionList (Gets the list of world options)
FNC_SetAlphaOption SetAlphaOption (Sets value of a named world alphanumeric option)
FNC_SetInputFont SetInputFont (Sets the font for the input window)
FNC_SetOption SetOption (Sets value of a named world option)
FNC_SetOutputFont SetOutputFont (Sets the font for the output window.)

(Help topic: function=GetDefaultValue)

DOC_contents Documentation contents page