[This is preliminary documentation and is subject to change.]
The WorldManager type exposes the following methods.
Methods
| Member | Description | |
|---|---|---|
| AddWorld(Player, String, Map, Boolean) | Creates a new world and adds it to the current list of worlds being managed by WorldManager. | |
| CountLoadedWorlds()()()() | Number of all worlds that are currently loaded. | |
| CountLoadedWorlds(Player) | Number of worlds that are currently loaded and can be seen by the specified observer. | |
| FindMainWorld(Player) | ||
| FindMapFile(Player, String) | Searches for a map using the specified fileName.
Prints any errors/warnings directly to the player. | |
| FindWorldExact(String) | Finds a world by full name.
Target world is not guaranteed to have a loaded map. | |
| FindWorldOrPrintMatches(Player, String) | Tries to find a single world by full or partial name.
Returns null if zero or multiple worlds matched. | |
| FindWorlds(Player, String) | Finds all worlds that match the given name.
Autocompletes. Raises SearchingForWorld event.
Target worlds are not guaranteed to have a loaded map. | |
| FindWorldsNoEvent(String) | Finds all worlds that match the given world name.
Autocompletes. Does not raise SearchingForWorld event.
Target worlds are not guaranteed to have a loaded map. | |
| ListLoadedWorlds()()()() | List of all the worlds that are currently loaded. | |
| ListLoadedWorlds(Player) | List of worlds that are currently loaded and can be seen by the specified observer. | |
| RemoveWorld(World) | Removes the specified world from the list of worlds being managed by WorldManager. | |
| RenameWorld(World, String, Boolean, Boolean) | Changes the name of the given world. | |
| SaveWorldList()()()() | Saves the current world list to worlds.xml. Thread-safe. |