Package net.lewmc.essence.world

Class UtilWorld

java.lang.Object

net.lewmc.essence.world.UtilWorld

public class UtilWorld
extends Object

The UtilWorld class, used for world management.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UtilWorld.ESSENCE_WORLD	Essence's world data object.
static enum	UtilWorld.WORLD_STATUS	Various status codes for transmitting data about worlds.

Constructor Summary

Constructors

Constructor	Description
UtilWorld(Essence plugin)	Constructor for the class.

Method Summary

Modifier and Type	Method	Description
void	autoloadWorlds()	Autoloads worlds on startup.
UtilWorld.WORLD_STATUS	create(String name, Map<String,String> flags)	Creates a world
UtilWorld.WORLD_STATUS	delete(String name)	Deletes a world
List<UtilWorld.ESSENCE_WORLD>	list()	Returns a list of worlds (loaded and unloaded).
UtilWorld.WORLD_STATUS	load(String name)	Loads a world
UtilWorld.WORLD_STATUS	unload(String name)	Unloads a world

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UtilWorld

public UtilWorld(Essence plugin)

Constructor for the class.

Parameters:

plugin - Essence - Reference to the main plugin class.

Method Details

create

public UtilWorld.WORLD_STATUS create(String name,
 Map<String,String> flags)

Creates a world

Parameters:

name - String - the world name

flags - Map(String, String) - the flags

Returns:

WORLD_STATUS - the status

delete

public UtilWorld.WORLD_STATUS delete(String name)

Deletes a world

Parameters:

name - String - the world name

Returns:

WORLD_STATUS - the status

unload

public UtilWorld.WORLD_STATUS unload(String name)

Unloads a world

Parameters:

name - String - the world name

Returns:

WORLD_STATUS - the status

load

public UtilWorld.WORLD_STATUS load(String name)

Loads a world

Parameters:

name - String - the world name

Returns:

WORLD_STATUS - the status

list

public List<UtilWorld.ESSENCE_WORLD> list()

Returns a list of worlds (loaded and unloaded).

Returns:

List(ESSENCE_WORLD)

autoloadWorlds

public void autoloadWorlds()

Autoloads worlds on startup.