world.GetAlphaOption

MUSHclient script function (Method) — introduced in version 3.22

Gets the value of an alphanumeric configuration option

Prototype

VARIANT GetAlphaOption(BSTR OptionName);

Data type meanings

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.

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.

Related topic

Option setting and retrieval

See also