Description of MUSHclient world function: world.GetCurrentValue
Name | GetCurrentValue |
---|---|
Type | Method |
Summary | Gets the current value of a named world option |
Prototype | VARIANT GetCurrentValue(BSTR OptionName);
|
Description | Gets the current value of a MUSHclient <world> option, that is, the value it currently has. Note: Available in version 3.23 onwards. |
VBscript example |
|
Jscript example |
|
PerlScript example |
|
Python example |
|
Lua example |
|
Returns | The value of the requested option, or a NULL variant if the option does not exist, or is not permitted to be read. |
Introduced in version | 3.23 |
See also ...
Function | Description |
---|---|
GetDefaultValue | Gets the default value of a named world option |
GetLoadedValue | Gets value of a named world option, as loaded from the world file |
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.
You can view a list of the return codes
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
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.