Script function

world.SetOption

Type

Method

Summary

Sets value of a named world option

Prototype

long SetOption(BSTR OptionName, long Value);

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

See Also ...

Topic

Option setting and retrieval

Functions

(GetAlphaOption) Gets the value of an alphanumeric configuration option
(GetAlphaOptionList) Gets the list of world alphanumeric options
(GetCurrentValue) Gets the current value of a named world option
(GetDefaultValue) Gets the default value of a named world option
(GetGlobalOption) Gets the value of a global configuration option
(GetGlobalOptionList) Gets the list of global options
(GetLoadedValue) Gets value of a named world option, as loaded from the world file
(GetOption) Gets value of a named world option
(GetOptionList) Gets the list of world options
(SetAlphaOption) Sets value of a named world alphanumeric option
(SetInputFont) Sets the font for the input window
(SetOutputFont) Sets the font for the output window.

(Help topic: function=SetOption)