world.GetOption

MUSHclient script function (Method)

Gets value of a named world option

Prototype

long GetOption(BSTR OptionName);

Data type meanings

Description

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"))

Return value

The value of the requested option, or -1 if the option does not exist.

Related topic

Option setting and retrieval

See also