world.SetAlphaOption

MUSHclient script function (Method) — introduced in version 3.22

Sets value of a named world alphanumeric option

Prototype

long SetAlphaOption(BSTR OptionName, BSTR Value);

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

Return code meanings

Related topic

Option setting and retrieval

See also