Script function

world.GetAlphaOption

Type

Method

Summary

Gets the value of an alphanumeric configuration option

Prototype

VARIANT GetAlphaOption(BSTR OptionName);

Description

Gets the value of an alphanumeric world option (text option), such as player name, MUD name etc.

You can use GetAlphaOptionList to get a list of the names of all possible options.

Available in MUSHclient version 3.22 onwards.

VBscript example

world.note world.getalphaoption ("player")

Jscript example

/world.note(world.getalphaoption ("player"));

PerlScript example

/$world->note ($world->getalphaoption ("player"));

Python example

world.note(world.getalphaoption ("player"))

Lua example

Note (GetAlphaOption("player"))

Return value

The value of the requested option, or an "empty" variant if the option does not exist.

See Also ...

Topic

Option setting and retrieval

Functions

(GetAlphaOptionList) Gets the list of world alphanumeric options
(GetCurrentValue) Gets the current value of a named world option
(GetDefaultValue) Gets the default value of a named world option
(GetGlobalOption) Gets the value of a global configuration option
(GetGlobalOptionList) Gets the list of global options
(GetInfo) Gets information about the current world
(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=GetAlphaOption)