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

Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetOptionList

Name GetOptionList
Type Method
Summary Gets the list of world options
Prototype VARIANT GetOptionList();

View list of data type meanings
Description

Returns a variant array which is a list of all options that you can get with GetOption or set with SetOption.

The examples show extracting all option names, and their values.

The option names should be reasonably self-explanatory.
VBscript example 
For Each opt In world.GetOptionList
    world.note opt + " = " + cstr (world.GetOption ( opt ))
Next
Jscript example 
optionlist = new VBArray(world.GetOptionList()).toArray();

 for (i = 0; i < optionlist .length; i++)
   world.note(optionlist [i] + " = " + world.GetOption (optionlist [i] ));
PerlScript example 
foreach $item (Win32::OLE::in ($world->GetOptionList))
 {
 $world->note($item . " = " . $world->GetOption($item));
 }
Python example 
for opt in world.GetOptionList: world.Note (opt)
Lua example 
for k, v in pairs (GetOptionList()) do 
  Note (v, " = ", GetOption (v)) 
end
Returns It returns a variant array containing the names of all the options. Use "ubound" to find the number of options in the list. You can then use "GetOption" to return the value for that particular option, or "SetOption" to set that option value.

See also ...

Function Description
GetAlphaOption Gets the value of an alphanumeric configuration option
GetAlphaOptionList Gets the list of world alphanumeric options
GetGlobalOptionList Gets the list of global options
GetOption Gets value of a named world option
SetAlphaOption Sets value of a named world alphanumeric option
SetOption Sets value of a named world 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]