MUSHclient scripting

Description of MUSHclient world function: world.SetAlphaOption

Name	SetAlphaOption
Type	Method
Summary	Sets value of a named world alphanumeric option
Prototype	`long SetAlphaOption(BSTR OptionName, BSTR Value);` 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. Note: Available in version 3.22 onwards.
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")`
Returns	`eUnknownOption - option name not recognised eOK - set OK` View list of return code meanings
Introduced in version	3.22

See also ...

Function	Description
GetAlphaOption	Gets the value of an alphanumeric configuration option
GetAlphaOptionList	Gets the list of world alphanumeric options
GetInfo	Gets information about the current world
GetOption	Gets value of a named world option
GetOptionList	Gets the list of world options
SetOption	Sets value of a named world option

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Many functions return a "code" which indicates the success or otherwise of the function.

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.