[Home] [Downloads] [Search] [Help/forum]

Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetOption

Name SetOption
Type Method
Summary Sets value of a named world option
Prototype long SetOption(BSTR OptionName, long Value);

View list of data type meanings
Description

Sets value of a world option. Many options are booleans (true or false).

For boolean options the supplied value may be:

1 for true
0 for false

Also if you are using Lua you can supply simply true or false.

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 
You can use true, false or nil for boolean options.
Returns eUnknownOption - option name not recognised
eOptionOutOfRange - option value out of range
ePluginCannotSetOption: The option is marked as non-settable (in a plugin or not)
eOK - set OK

View list of return code meanings

See also ...

Function Description
GetAlphaOption Gets the value of an alphanumeric configuration option
GetAlphaOptionList Gets the list of world alphanumeric options
GetOption Gets value of a named world option
GetOptionList Gets the list of world options
SetAlphaOption Sets value of a named world alphanumeric option

Search for script function

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.

Search for:   

Leave blank to show all functions.

Return codes

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

You can view a list of the return codes

Function prototypes

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

You can view a list of the data types used in function prototypes

View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]