net.minecraftforge.common

Class DimensionManager

java.lang.Object

net.minecraftforge.common.DimensionManager

public class DimensionManager
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DimensionManager.SavedEntry

Constructor Summary

Constructors

Constructor and Description
DimensionManager()

Method Summary

Modifier and Type	Method and Description
static IRegistry<DimensionType>	getRegistry() Deprecated.
static WorldServer	getWorld(MinecraftServer server, DimensionType dim, boolean resetUnloadDelay, boolean forceLoad) Retrieves the world from the server allowing for null return, and optionally resetting it's unload timer.
static WorldServer	initWorld(MinecraftServer server, DimensionType dim)
static boolean	keepLoaded(DimensionType dim) Determines if the dimension will stay loaded in memory even if all chunks are unloaded.
static boolean	keepLoaded(DimensionType dim, boolean value) Configures if the dimension will stay loaded in memory even if all chunks are unloaded.
static void	readRegistry(NBTTagCompound data)
static DimensionType	registerDimension(ResourceLocation name, ModDimension type, PacketBuffer data) Registers a real unique dimension, Should be called on server init, or when the dimension is created.
static DimensionType	registerDimensionInternal(int id, ResourceLocation name, ModDimension type, PacketBuffer data)
static void	unloadWorld(WorldServer world) Queues a dimension to unload, if it can be unloaded.
static void	unloadWorlds(MinecraftServer server, boolean checkLeaks)
static void	unregisterDimension(int id)
static void	writeRegistry(NBTTagCompound data)

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionManager

public DimensionManager()

Method Detail

registerDimension

public static DimensionType registerDimension(ResourceLocation name,
                                              ModDimension type,
                                              PacketBuffer data)

Registers a real unique dimension, Should be called on server init, or when the dimension is created. On the client, the list will be reset/reloaded every time a InternalServer is refreshed. Forge will save this data and keep track of registered values, syncing automatically from the remote server.

Parameters:

name - Registry name for this new dimension.

type - Dimension Type.

data - Configuration data for this dimension, passed into

keepLoaded

public static boolean keepLoaded(DimensionType dim,
                                 boolean value)

Configures if the dimension will stay loaded in memory even if all chunks are unloaded.

Parameters:

dim - The dimension

value - True to keep loaded, false to allow unloading

Returns:

The old value for this dimension.

keepLoaded

public static boolean keepLoaded(DimensionType dim)

Determines if the dimension will stay loaded in memory even if all chunks are unloaded.

Parameters:

dim - The dimension

Returns:

True if the dimension will stay loaded with no chunks loaded.

getWorld

@Nullable
public static WorldServer getWorld(MinecraftServer server,
                                             DimensionType dim,
                                             boolean resetUnloadDelay,
                                             boolean forceLoad)

Retrieves the world from the server allowing for null return, and optionally resetting it's unload timer.

Parameters:

server - The server that controlls this world.

dim - Dimension to load.

resetUnloadDelay - True to reset the unload timer, which is a delay that is used to prevent constant world loading/unloading cycle.

forceLoad - True to attempt to load the dimension if the server has it unloaded.

Returns:

The world, null if unloaded and not loadable.

unregisterDimension

public static void unregisterDimension(int id)

registerDimensionInternal

public static DimensionType registerDimensionInternal(int id,
                                                      ResourceLocation name,
                                                      ModDimension type,
                                                      PacketBuffer data)

initWorld

public static WorldServer initWorld(MinecraftServer server,
                                    DimensionType dim)

unloadWorld

public static void unloadWorld(WorldServer world)

Queues a dimension to unload, if it can be unloaded.

Parameters:

id - The id of the dimension

unloadWorlds

public static void unloadWorlds(MinecraftServer server,
                                boolean checkLeaks)

writeRegistry

public static void writeRegistry(NBTTagCompound data)

readRegistry

public static void readRegistry(NBTTagCompound data)

getRegistry

@Deprecated
public static IRegistry<DimensionType> getRegistry()

Deprecated.