MUSHclient scripting

Description of MUSHclient world function: world.GetGlobalOption

Name	GetGlobalOption
Type	Method
Summary	Gets the value of a global configuration option
Prototype	`VARIANT GetGlobalOption(BSTR OptionName);` View list of data type meanings
Description	Gets the value of an alphanumeric global option. These are global options that are not tied to a particular world. You can use GetGlobalOptionList to get a list of the names of all possible options. The option name is not case-sensitive. String option are returned as type BSTR (string), other options (booleans, numbers) are returned as type I4 (long). Non-existant options are returned as type EMPTY (empty). Note: Available in version 4.18 onwards.
VBscript example	`world.Note world.GetGlobalOption ("DefaultLogFileDirectory")`
Jscript example	`/world.Note (world.GetGlobalOption ("DefaultLogFileDirectory"));`
PerlScript example	`/$world->Note ($world->GetGlobalOption ("DefaultLogFileDirectory"));`
Python example	`world.Note(world.GetGlobalOption ("DefaultLogFileDirectory"))`
Lua example	`Note (GetGlobalOption ("DefaultLogFileDirectory"))`
Returns	`The value of the requested option, or an "empty" variant if the option does not exist.`
Introduced in version	4.18

See also ...

Function	Description
GetGlobalOptionList	Gets the list of global options
GetInfo	Gets information about the current world

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.