[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.GetOption

Name GetOption
Type Method
Summary Gets value of a named world option
Prototype long GetOption(BSTR OptionName);

View list of data type meanings


Gets value of a world option. Many options are booleans (true or false). The number zero represents false (option not set) and the number one represents true (option set).

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

VBscript example
world.note world.getoption ("show_italic")
Jscript example
/world.note(world.getoption ("show_italic"));
PerlScript example
/$world->note ($world->getoption ("show_italic"));
Python example
world.note(world.getoption ("show_italic"))
Lua example
Note (GetOption ("show_italic"))
Returns The value of the requested option, or -1 if the option does not exist.

See also ...

Function Description
GetAlphaOption Gets the value of an alphanumeric configuration option
GetCurrentValue Gets the current value of a named world option
GetDefaultValue Gets the default value of a named world option
GetLoadedValue Gets value of a named world option, as loaded from the world file
GetOptionList Gets the list of world options
SetOption Sets value of a named world option

Search for script function

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.

Search for:   

Leave blank to show all functions.

Return codes

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

You can view a list of the return codes

Function prototypes

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

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]