MUSHclient scripting

Description of MUSHclient world function: world.GetAlphaOption

Name	GetAlphaOption
Type	Method
Summary	Gets the value of an alphanumeric configuration option
Prototype	`VARIANT GetAlphaOption(BSTR OptionName);` View list of 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. Note: Available in 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"))`
Returns	`The value of the requested option, or an "empty" variant if the option does not exist.`
Introduced in version	3.22

See also ...

Function	Description
GetAlphaOptionList	Gets the list of world alphanumeric options
GetInfo	Gets information about the current world
GetOption	Gets value of a named world option
GetOptionList	Gets the list of world options
SetAlphaOption	Sets value of a named world alphanumeric option
SetOption	Sets value of a named world option

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.