world.GetWorldList

MUSHclient script function (Method)

Gets the list of open worlds - returning their world names

Prototype

VARIANT GetWorldList();

Data type meanings

Description

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
next

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))
 {
 $world->note($item);
 }

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) 
end

Lua notes

See the description for GetWorld for more discussion about using "world" variables in Lua.

Return value

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.

Related topic

World functions

See also