SetOption
Script function

world.SetOption

DOC_scripting Read about scripting

Type

Method

Summary

Sets value of a named world option

Prototype

long SetOption(BSTR OptionName, long Value);

DOC_data_types View list of data type meanings

Description

Sets 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.

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

For boolean options, Lua expects a numeric argument (as some options are numbers), so you need to use 0 for false, and 1 for true, rather than the words 'false' and 'true'.


Return value

eUnknownOption - option name not recognised
eOptionOutOfRange - option value out of range
eOK - set OK


DOC_errors View list of return code meanings

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_GetOption GetOption (Gets value of a named world option)
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_SetOutputFont SetOutputFont (Sets the font for the output window.)

(Help topic: function=SetOption)

DOC_contents Documentation contents page