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
private static class	DimensionManager.Data
private static class	DimensionManager.NoopChunkStatusListener
static class	DimensionManager.SavedEntry

Field Summary

Fields

Modifier and Type	Field and Description
private static it.unimi.dsi.fastutil.ints.Int2ObjectMap<DimensionManager.Data>	dimensions
private static org.apache.logging.log4j.Marker	DIMMGR
private static java.util.List<java.lang.String>	foldersScheduledForDeletion
private static com.google.common.collect.Multiset<java.lang.Integer>	leakedWorlds
private static org.apache.logging.log4j.Logger	LOGGER
private static java.util.Set<World>	playerWorlds
private static ClearableRegistry<DimensionType>	REGISTRY
private static java.util.Map<ResourceLocation,DimensionManager.SavedEntry>	savedEntries
private static it.unimi.dsi.fastutil.ints.IntSet	unloadQueue
private static java.util.concurrent.ConcurrentMap<World,World>	weakWorldMap

Constructor Summary

Constructors

Constructor and Description
DimensionManager()

Method Summary

Modifier and Type	Method and Description
private static boolean	canUnloadWorld(ServerWorld world)
static void	fireRegister()
private static DimensionManager.Data	getData(DimensionType dim)
static MutableRegistry<DimensionType>	getRegistry() Deprecated.
static ServerWorld	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 ServerWorld	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	markForDeletion(DimensionType dim) Marks the given dimension for deletion upon next reload of the save.
static void	processScheduledDeletions(SaveHandler saveHandler)
static void	readRegistry(CompoundNBT data)
static boolean	rebuildPlayerMap(PlayerList players, boolean changed)
static DimensionType	registerDimension(ResourceLocation name, ModDimension type, PacketBuffer data, boolean hasSkyLight) 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, boolean hasSkyLight)
static DimensionType	registerOrGetDimension(ResourceLocation name, ModDimension type, PacketBuffer data, boolean hasSkyLight) Register or get the existing dimension type for the given dimtype name.
static void	unloadWorld(ServerWorld world) Queues a dimension to unload, if it can be unloaded.
static void	unloadWorlds(MinecraftServer server, boolean checkLeaks)
static void	unregisterDimension(int id) Deprecated.
static void	writeRegistry(CompoundNBT data)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final org.apache.logging.log4j.Logger LOGGER

DIMMGR

private static final org.apache.logging.log4j.Marker DIMMGR

REGISTRY

private static final ClearableRegistry<DimensionType> REGISTRY

dimensions

private static final it.unimi.dsi.fastutil.ints.Int2ObjectMap<DimensionManager.Data> dimensions

unloadQueue

private static final it.unimi.dsi.fastutil.ints.IntSet unloadQueue

weakWorldMap

private static final java.util.concurrent.ConcurrentMap<World,World> weakWorldMap

leakedWorlds

private static final com.google.common.collect.Multiset<java.lang.Integer> leakedWorlds

savedEntries

private static final java.util.Map<ResourceLocation,DimensionManager.SavedEntry> savedEntries

foldersScheduledForDeletion

private static final java.util.List<java.lang.String> foldersScheduledForDeletion

playerWorlds

private static volatile java.util.Set<World> playerWorlds

Constructor Detail

DimensionManager

public DimensionManager()

Method Detail

registerOrGetDimension

public static DimensionType registerOrGetDimension(ResourceLocation name,
                                                   ModDimension type,
                                                   PacketBuffer data,
                                                   boolean hasSkyLight)

Register or get the existing dimension type for the given dimtype name. Dimensions already known to the save are loaded into the DimensionType map before the RegisterDimensionsEvent is fired. You can use this helper to get your existing dimension, or create it if it is not found.

Parameters:

name - Registry name

type - ModDimension type data

data - Extra data for the ModDimension

hasSkyLight - does this dimension have a skylight?

magnifier - The biome generation processor

Returns:

the DimensionType for the dimension.

registerDimension

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

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

hasSkyLight - skylight for this dimension

magnifier - The biome generation processor

Returns:

the DimensionType for the dimension.

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 ServerWorld 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 controls 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.

markForDeletion

public static void markForDeletion(DimensionType dim)

Marks the given dimension for deletion upon next reload of the save. The corresponding data directory will be deleted as well. Note that the dimension need not be currently unloaded. The dimension will stay functioning as normal until the save is reloaded. Vanilla dimensions are not supported and will throw an exception.

Parameters:

dim - the dimension to delete

unregisterDimension

@Deprecated
public static void unregisterDimension(int id)

Deprecated.

Deprecated, unregistering dimensions at runtime is not supported.

See Also:

markForDeletion(DimensionType)

registerDimensionInternal

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

initWorld

public static ServerWorld initWorld(MinecraftServer server,
                                    DimensionType dim)

canUnloadWorld

private static boolean canUnloadWorld(ServerWorld world)

unloadWorld

public static void unloadWorld(ServerWorld world)

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

Parameters:

world - The world to unload

unloadWorlds

public static void unloadWorlds(MinecraftServer server,
                                boolean checkLeaks)

writeRegistry

public static void writeRegistry(CompoundNBT data)

readRegistry

public static void readRegistry(CompoundNBT data)

processScheduledDeletions

public static void processScheduledDeletions(SaveHandler saveHandler)

fireRegister

public static void fireRegister()

getRegistry

@Deprecated
public static MutableRegistry<DimensionType> getRegistry()

Deprecated.

getData

private static DimensionManager.Data getData(DimensionType dim)

rebuildPlayerMap

public static boolean rebuildPlayerMap(PlayerList players,
                                       boolean changed)