world.SetOption

MUSHclient script function (Method)

Sets value of a named world option

Prototype

long SetOption(BSTR OptionName, long Value);

Data type meanings

Description

Sets value of a world option. Many options are booleans (true or false).

For boolean options the supplied value may be:

1 for true
0 for false

Also if you are using Lua you can supply simply true or false.

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

Use SetAlphaOption to set alphanumeric options.

VBscript example

world.setoption "show_italic", 1

Jscript example

world.setoption ("show_italic", 1);

PerlScript example

$world->setoption ("show_italic", 1);

Python example

world.setoption ("show_italic", 1)

Lua example

SetOption ("show_italic", 1)

Lua notes

You can use true, false or nil for boolean options.

Return value

eUnknownOption - option name not recognised
eOptionOutOfRange - option value out of range
ePluginCannotSetOption: The option is marked as non-settable (in a plugin or not)
eOK - set OK

Return code meanings

Related topic

Option setting and retrieval

See also