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

MUSHclient scripting

Description of MUSHclient world function: world.GetWorldList

Name GetWorldList
Type Method
Summary Gets the list of open worlds - returning their world names
Prototype VARIANT GetWorldList();

View list of data type meanings


Returns a variant array which is a list of all open worlds.

If more than one world has the same name you may get duplicates - to be able to refer to each world uniquely, use GetWorldIdList.

VBscript example
for each name in world.GetWorldList
  world.note name
Jscript example
worldlist = new VBArray(world.GetworldList()).toArray();

if (worldlist)  // if not empty
 for (i = 0; i < worldlist.length; i++)
   world.note(worldlist [i]);
PerlScript example
foreach $item (Win32::OLE::in ($world->GetWorldList))
Python example
worldlist = world.GetworldList
if (worldlist ):
  for w in worldlist : world.Note (w)
Lua example
for k, v in pairs (GetWorldList()) do 
  Note (v) 
Lua notes
See the description for GetWorld for more discussion about using "world" variables in Lua.
Returns If there are no worlds then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the worlds. Use "ubound" to find the number of worlds in the list. You can then use "GetWorld" to return a reference to that world.

See also ...

Function Description
GetWorld Gets an object reference to the named world
GetWorldById Gets an object reference to the world given its unique ID
GetWorldIdList Gets the list of open worlds - returning their world IDs

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


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.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]