world.GetOptionList

MUSHclient script function (Method)

Gets the list of world options

Prototype

VARIANT GetOptionList();

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

Return value

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.

Related topic

Option setting and retrieval

See also