GetOption
Script function

world.GetOption

DOC_scripting Read about scripting

Type

Method

Summary

Gets value of a named world option

Prototype

long GetOption(BSTR OptionName);

DOC_data_types View list of 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.



See Also ...

Topic

DOC_options Option setting and retrieval

Functions

FNC_GetAlphaOption GetAlphaOption (Gets the value of an alphanumeric configuration option)
FNC_GetAlphaOptionList GetAlphaOptionList (Gets the list of world alphanumeric options)
FNC_GetCurrentValue GetCurrentValue (Gets the current value of a named world option)
FNC_GetDefaultValue GetDefaultValue (Gets the default value of a named world option)
FNC_GetLoadedValue GetLoadedValue (Gets value of a named world option, as loaded from the world file)
FNC_GetOptionList GetOptionList (Gets the list of world options)
FNC_SetAlphaOption SetAlphaOption (Sets value of a named world alphanumeric option)
FNC_SetInputFont SetInputFont (Sets the font for the input window)
FNC_SetOption SetOption (Sets value of a named world option)
FNC_SetOutputFont SetOutputFont (Sets the font for the output window.)

(Help topic: function=GetOption)

DOC_contents Documentation contents page