[This is preliminary documentation and is subject to change.]
[Missing <summary> documentation for "T:fCraft.WorldManager"]
Assembly: fCraft (in fCraft.dll) Version: 0.6.2.4 (0.6.2.4)
Syntax
| C# |
public static class WorldManager
Members
| All Members | Fields | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| AccessSecurityXmlTagName | ||
| AddWorld(Player, String, Map, Boolean) | ||
| BuildSecurityXmlTagName | ||
| CountLoadedWorlds()()()() | ||
| CountLoadedWorlds(Player) | ||
| EnvironmentXmlTagName | ||
| FindMapFile(Player, String) | ||
| 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()()()() | ||
| ListLoadedWorlds(Player) | ||
| 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 (cancellable). | |
| RankMainXmlTagName | ||
| RemoveWorld(World) | ||
| 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. | |
| UpdateWorldList()()()() | ||
| WorldCreated | Occurs after a new world is created/added. | |
| WorldCreating | Occurs before a new world is created/added (cancellable). | |
| Worlds |