[This is preliminary documentation and is subject to change.]
Manages the world list. Handles loading/unloading, renaming, map changes, and more.
Namespace: fCraftAssembly: fCraft (in fCraft.dll) Version: 0.6.3.1 (0.6.3.1)
Syntax
| C# |
public static class WorldManager
Members
| All Members | Fields  | Properties  | Methods  | Events  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| AccessSecurityXmlTagName | |
| AddWorld(Player, String, Map, Boolean) | Creates a new world and adds it to the current list of worlds being managed by WorldManager. |
| BuildSecurityXmlTagName | |
| 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. |
| EnvironmentXmlTagName | |
| 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. |
| MainWorld | Gets or sets the default main world.
That's the world that players first join upon connecting.
The map of the new main world is preloaded, and old one is unloaded, if needed. |
| MainWorldChanged | Occurs after the main world has been changed. |
| MainWorldChanging | Occurs when the main world is being changed (cancelable). |
| RankMainXmlTagName | |
| 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. |
| SearchingForWorld | Occurs when a player is searching for worlds (with autocompletion).
The list of worlds in the search results may be replaced. |
| WorldCreated | Occurs after a new world is created/added. |
| WorldCreating | Occurs before a new world is created/added (cancelable). |
| Worlds | List of worlds currently being managed by WorldManager. |
