GetWorldList
Script function

world.GetWorldList

DOC_scripting Read about scripting

Type

Method

Summary

Gets the list of open worlds - returning their world names

Prototype

VARIANT GetWorldList();

DOC_data_types View list of 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.



See Also ...

Topics

DOC_scripting Scripting
DOC_world World functions

Functions

FNC_GetWorld GetWorld (Gets an object reference to the named world)
FNC_GetWorldById GetWorldById (Gets an object reference to the world given its unique ID)
FNC_GetWorldIdList GetWorldIdList (Gets the list of open worlds - returning their world IDs)
FNC_Open Open (Opens a named document)
FNC_OpenBrowser OpenBrowser (Opens a supplied URL in your default web browser)

(Help topic: function=GetWorldList)

DOC_contents Documentation contents page