Script function

world.GetOption

Type

Method

Summary

Gets value of a named world option

Prototype

long GetOption(BSTR OptionName);

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.

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
(GetOptionList) Gets the list of world options
(SetAlphaOption) Sets value of a named world alphanumeric option
(SetInputFont) Sets the font for the input window
(SetOption) Sets value of a named world option
(SetOutputFont) Sets the font for the output window.

(Help topic: function=GetOption)