SetAlphaOption
Script function

world.SetAlphaOption

DOC_scripting Read about scripting

Type

Method

Summary

Sets value of a named world alphanumeric option

Prototype

long SetAlphaOption(BSTR OptionName, BSTR Value);

DOC_data_types View list of data type meanings

Description

Sets the value of a world alphanumeric (string) option.

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

Use SetOption to set numeric and boolean options.

VBscript example

world.setalphaoption "player", "Gandalf"


Jscript example

world.setalphaoption ("player", "Gandalf");


PerlScript example

$world->setalphaoption ("player", "Gandalf");


Python example

world.setalphaoption ("player", "Gandalf")


Lua example

SetAlphaOption ("player", "Gandalf")


Return value

eUnknownOption - option name not recognised 
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_GetInfo GetInfo (Gets information about the current world)
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_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=SetAlphaOption)

DOC_contents Documentation contents page