Upstream/Multiverse-Core
1
0
Fork 0
mirror of https://github.com/Multiverse/Multiverse-Core.git synced 2024-11-22 10:36:06 +01:00
Code Issues Projects Releases Wiki Activity

Added getWorldProperties method to WorldManager.

Browse Source
This commit is contained in:
Jeremy Wood 2012-11-09 12:52:55 -05:00
parent ea0d1c6702
commit 8c0a750d3e
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
base/src/main/java/com/onarandombox/multiverse/core/api/WorldManager.java
View File

@ -5,6 +5,8 @@ import com.onarandombox.multiverse.core.minecraft.Generator;
import com.onarandombox.multiverse.core.minecraft.WorldEnvironment;
import com.onarandombox.multiverse.core.minecraft.WorldType;
import java.io.IOException;
/**
* Multiverse 2 World Manager API
* <p>
@ -13,6 +15,17 @@ import com.onarandombox.multiverse.core.minecraft.WorldType;
*/
public interface WorldManager {
/**
* Gets an existing WorldProperties object or creates a new one based on the name.
*
* TODO explain that they should use getWorld() in general.
*
* @param worldName The name of the world to get properties for.
* @return The world properties for the given world name.
* @throws IOException In case there are any issues accessing the persistence for the world properties.
*/
WorldProperties getWorldProperties(final String worldName) throws IOException;
/**
* Add a new World to the Multiverse Setup.
*
@ -145,7 +158,7 @@ public interface WorldManager {
* @param name The name or alias of the world to get.
* @return A {@link MultiverseWorld} or null.
*/
//TODO MultiverseWorld getMVWorld(String name);
//TODO W getMVWorld(String name);
/**
* Checks to see if the given name is a valid {@link MultiverseWorld}.