Package net.minecraftforge.common.world

Class ForgeChunkManager

java.lang.Object

net.minecraftforge.common.world.ForgeChunkManager

@ParametersAreNonnullByDefault
public class ForgeChunkManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForgeChunkManager.LoadingValidationCallback
static class	ForgeChunkManager.TicketHelper	Class to help mods remove no longer valid tickets.
static class	ForgeChunkManager.TicketOwner<T extends Comparable<? super T>>	Helper class to keep track of a ticket owner by modid and owner object
static class	ForgeChunkManager.TicketTracker<T extends Comparable<? super T>>	Helper class to manage tracking and handling loaded tickets.

Field Summary

Fields

Modifier and Type	Field	Description
private static final TicketType<ForgeChunkManager.TicketOwner<BlockPos>>	BLOCK
private static final TicketType<ForgeChunkManager.TicketOwner<BlockPos>>	BLOCK_TICKING
private static final Map<String,ForgeChunkManager.LoadingValidationCallback>	callbacks
private static final TicketType<ForgeChunkManager.TicketOwner<UUID>>	ENTITY
private static final TicketType<ForgeChunkManager.TicketOwner<UUID>>	ENTITY_TICKING
private static final org.apache.logging.log4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
ForgeChunkManager()

Method Summary

Modifier and Type	Method	Description
static boolean	forceChunk(ServerLevel level, String modId, UUID owner, int chunkX, int chunkZ, boolean add, boolean ticking)	Forces a chunk to be loaded for the given mod with the "owner" of the ticket being a given UUID.
static boolean	forceChunk(ServerLevel level, String modId, BlockPos owner, int chunkX, int chunkZ, boolean add, boolean ticking)	Forces a chunk to be loaded for the given mod with the "owner" of the ticket being a given block position.
static boolean	forceChunk(ServerLevel level, String modId, Entity owner, int chunkX, int chunkZ, boolean add, boolean ticking)	Forces a chunk to be loaded for the given mod with the "owner" of the ticket being the UUID of the given entity.
private static <T extends Comparable<? super T>> boolean	forceChunk(ServerLevel level, String modId, T owner, int chunkX, int chunkZ, boolean add, boolean ticking, TicketType<ForgeChunkManager.TicketOwner<T>> type, Function<ForcedChunksSavedData,ForgeChunkManager.TicketTracker<T>> ticketGetter)	Forces a chunk to be loaded for the given mod with the given "owner".
private static <T extends Comparable<? super T>> void	forceChunk(ServerLevel level, ChunkPos pos, TicketType<ForgeChunkManager.TicketOwner<T>> type, ForgeChunkManager.TicketOwner<T> owner, boolean add, boolean ticking)	Adds/Removes a ticket from the level's chunk provider with the proper levels to match the forced chunks.
private static <T extends Comparable<? super T>> void	gatherTicketsByModId(Map<ForgeChunkManager.TicketOwner<T>,it.unimi.dsi.fastutil.longs.LongSet> tickets, Function<com.mojang.datafixers.util.Pair<it.unimi.dsi.fastutil.longs.LongSet,it.unimi.dsi.fastutil.longs.LongSet>,it.unimi.dsi.fastutil.longs.LongSet> typeGetter, Map<String,Map<T,com.mojang.datafixers.util.Pair<it.unimi.dsi.fastutil.longs.LongSet,it.unimi.dsi.fastutil.longs.LongSet>>> modSortedOwnedChunks)	Gathers tickets into a mod filtered map for use in providing all tickets a mod has registered to its ForgeChunkManager.LoadingValidationCallback.
private static <T extends Comparable<? super T>> Map<String,Map<T,com.mojang.datafixers.util.Pair<it.unimi.dsi.fastutil.longs.LongSet,it.unimi.dsi.fastutil.longs.LongSet>>>	gatherTicketsByModId(ForgeChunkManager.TicketTracker<T> tickets)	Gathers tickets into a mod filtered map for use in providing all tickets a mod has registered to its ForgeChunkManager.LoadingValidationCallback.
static boolean	hasForcedChunks(ServerLevel level)	Checks if a level has any forced chunks.
private static void	readBlockForcedChunks(String modId, long chunkPos, CompoundTag modEntry, String key, Map<ForgeChunkManager.TicketOwner<BlockPos>,it.unimi.dsi.fastutil.longs.LongSet> blockForcedChunks)	Reads the forge block forced chunks.
private static void	readEntityForcedChunks(String modId, long chunkPos, CompoundTag modEntry, String key, Map<ForgeChunkManager.TicketOwner<UUID>,it.unimi.dsi.fastutil.longs.LongSet> entityForcedChunks)	Reads the forge entity forced chunks.
static void	readForgeForcedChunks(CompoundTag nbt, ForgeChunkManager.TicketTracker<BlockPos> blockForcedChunks, ForgeChunkManager.TicketTracker<UUID> entityForcedChunks)	Reads the forge forced chunks from the NBT compound.
private static <T extends Comparable<? super T>> void	reinstatePersistentChunks(ServerLevel level, TicketType<ForgeChunkManager.TicketOwner<T>> type, Map<ForgeChunkManager.TicketOwner<T>,it.unimi.dsi.fastutil.longs.LongSet> tickets, boolean ticking)	Adds back any persistent forced chunks to the level's chunk provider.
static void	reinstatePersistentChunks(ServerLevel level, ForcedChunksSavedData saveData)	Reinstates forge's forced chunks when vanilla initially loads a level and reinstates their forced chunks.
static void	setForcedChunkLoadingCallback(String modId, ForgeChunkManager.LoadingValidationCallback callback)	Sets the forced chunk loading validation callback for the given mod.
private static <T extends Comparable<? super T>> void	writeForcedChunkOwners(Map<String,it.unimi.dsi.fastutil.longs.Long2ObjectMap<CompoundTag>> forcedEntries, Map<ForgeChunkManager.TicketOwner<T>,it.unimi.dsi.fastutil.longs.LongSet> forcedChunks, String listKey, int listType, BiConsumer<T,ListTag> ownerWriter)
private static <T extends Comparable<? super T>> void	writeForcedChunkOwners(Map<String,it.unimi.dsi.fastutil.longs.Long2ObjectMap<CompoundTag>> forcedEntries, ForgeChunkManager.TicketTracker<T> tracker, String listKey, int listType, BiConsumer<T,ListTag> ownerWriter)
static void	writeForgeForcedChunks(CompoundTag nbt, ForgeChunkManager.TicketTracker<BlockPos> blockForcedChunks, ForgeChunkManager.TicketTracker<UUID> entityForcedChunks)	Writes the forge forced chunks into the NBT compound.

Methods inherited from class java.lang.Object

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

Field Details

LOGGER

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

BLOCK

private static final TicketType<ForgeChunkManager.TicketOwner<BlockPos>> BLOCK

BLOCK_TICKING

private static final TicketType<ForgeChunkManager.TicketOwner<BlockPos>> BLOCK_TICKING

ENTITY

private static final TicketType<ForgeChunkManager.TicketOwner<UUID>> ENTITY

ENTITY_TICKING

private static final TicketType<ForgeChunkManager.TicketOwner<UUID>> ENTITY_TICKING

callbacks

private static final Map<String,ForgeChunkManager.LoadingValidationCallback> callbacks

Constructor Details

ForgeChunkManager

public ForgeChunkManager()

Method Details

setForcedChunkLoadingCallback

public static void setForcedChunkLoadingCallback(String modId,
 ForgeChunkManager.LoadingValidationCallback callback)

Sets the forced chunk loading validation callback for the given mod. This allows for validating and removing no longer valid tickets on level load.

API Note:

This method should be called from a FMLCommonSetupEvent using one of the ParallelDispatchEvent enqueueWork methods.

hasForcedChunks

public static boolean hasForcedChunks(ServerLevel level)

Checks if a level has any forced chunks. Mainly used for seeing if a level should continue ticking with no players in it.

forceChunk

public static boolean forceChunk(ServerLevel level,
 String modId,
 BlockPos owner,
 int chunkX,
 int chunkZ,
 boolean add,
 boolean ticking)

Forces a chunk to be loaded for the given mod with the "owner" of the ticket being a given block position.

Parameters:

add - true to force the chunk, false to unforce the chunk.

ticking - true to make the chunk receive full chunk ticks even if there is no player nearby.

forceChunk

public static boolean forceChunk(ServerLevel level,
 String modId,
 Entity owner,
 int chunkX,
 int chunkZ,
 boolean add,
 boolean ticking)

Forces a chunk to be loaded for the given mod with the "owner" of the ticket being the UUID of the given entity.

Parameters:

add - true to force the chunk, false to unforce the chunk.

ticking - true to make the chunk receive full chunk ticks even if there is no player nearby.

forceChunk

public static boolean forceChunk(ServerLevel level,
 String modId,
 UUID owner,
 int chunkX,
 int chunkZ,
 boolean add,
 boolean ticking)

Forces a chunk to be loaded for the given mod with the "owner" of the ticket being a given UUID.

Parameters:

add - true to force the chunk, false to unforce the chunk.

ticking - true to make the chunk receive full chunk ticks even if there is no player nearby.

forceChunk

private static <T extends Comparable<? super T>>
boolean forceChunk(ServerLevel level,
 String modId,
 T owner,
 int chunkX,
 int chunkZ,
 boolean add,
 boolean ticking,
 TicketType<ForgeChunkManager.TicketOwner<T>> type,
 Function<ForcedChunksSavedData,ForgeChunkManager.TicketTracker<T>> ticketGetter)

Forces a chunk to be loaded for the given mod with the given "owner".

Parameters:

add - true to force the chunk, false to unforce the chunk.

Implementation Note:

Based on ServerLevel.setChunkForced(int, int, boolean)

forceChunk

private static <T extends Comparable<? super T>>
void forceChunk(ServerLevel level,
 ChunkPos pos,
 TicketType<ForgeChunkManager.TicketOwner<T>> type,
 ForgeChunkManager.TicketOwner<T> owner,
 boolean add,
 boolean ticking)

Adds/Removes a ticket from the level's chunk provider with the proper levels to match the forced chunks.

Parameters:

add - true to force the chunk, false to unforce the chunk.

ticking - true to make the chunk receive full chunk ticks even if there is no player nearby.

Implementation Note:

We use distance 2 for what we pass, as when using register/releaseTicket the ticket's level is set to 33 - distance and the level that forced chunks use is 31.

reinstatePersistentChunks

public static void reinstatePersistentChunks(ServerLevel level,
 ForcedChunksSavedData saveData)

Reinstates forge's forced chunks when vanilla initially loads a level and reinstates their forced chunks. This method also will validate all of forge's forced chunks using and registered ForgeChunkManager.LoadingValidationCallback.

API Note:

Internal

gatherTicketsByModId

private static <T extends Comparable<? super T>>
Map<String,Map<T,com.mojang.datafixers.util.Pair<it.unimi.dsi.fastutil.longs.LongSet,it.unimi.dsi.fastutil.longs.LongSet>>> gatherTicketsByModId(ForgeChunkManager.TicketTracker<T> tickets)

Gathers tickets into a mod filtered map for use in providing all tickets a mod has registered to its ForgeChunkManager.LoadingValidationCallback.

gatherTicketsByModId

private static <T extends Comparable<? super T>>
void gatherTicketsByModId(Map<ForgeChunkManager.TicketOwner<T>,it.unimi.dsi.fastutil.longs.LongSet> tickets,
 Function<com.mojang.datafixers.util.Pair<it.unimi.dsi.fastutil.longs.LongSet,it.unimi.dsi.fastutil.longs.LongSet>,it.unimi.dsi.fastutil.longs.LongSet> typeGetter,
 Map<String,Map<T,com.mojang.datafixers.util.Pair<it.unimi.dsi.fastutil.longs.LongSet,it.unimi.dsi.fastutil.longs.LongSet>>> modSortedOwnedChunks)

Gathers tickets into a mod filtered map for use in providing all tickets a mod has registered to its ForgeChunkManager.LoadingValidationCallback.

reinstatePersistentChunks

private static <T extends Comparable<? super T>>
void reinstatePersistentChunks(ServerLevel level,
 TicketType<ForgeChunkManager.TicketOwner<T>> type,
 Map<ForgeChunkManager.TicketOwner<T>,it.unimi.dsi.fastutil.longs.LongSet> tickets,
 boolean ticking)

Adds back any persistent forced chunks to the level's chunk provider.

writeForgeForcedChunks

public static void writeForgeForcedChunks(CompoundTag nbt,
 ForgeChunkManager.TicketTracker<BlockPos> blockForcedChunks,
 ForgeChunkManager.TicketTracker<UUID> entityForcedChunks)

Writes the forge forced chunks into the NBT compound. Format is List{modid, List{ChunkPos, List{BlockPos}, List{UUID}}}

API Note:

Internal

writeForcedChunkOwners

private static <T extends Comparable<? super T>>
void writeForcedChunkOwners(Map<String,it.unimi.dsi.fastutil.longs.Long2ObjectMap<CompoundTag>> forcedEntries,
 ForgeChunkManager.TicketTracker<T> tracker,
 String listKey,
 int listType,
 BiConsumer<T,ListTag> ownerWriter)

writeForcedChunkOwners

private static <T extends Comparable<? super T>>
void writeForcedChunkOwners(Map<String,it.unimi.dsi.fastutil.longs.Long2ObjectMap<CompoundTag>> forcedEntries,
 Map<ForgeChunkManager.TicketOwner<T>,it.unimi.dsi.fastutil.longs.LongSet> forcedChunks,
 String listKey,
 int listType,
 BiConsumer<T,ListTag> ownerWriter)

readForgeForcedChunks

public static void readForgeForcedChunks(CompoundTag nbt,
 ForgeChunkManager.TicketTracker<BlockPos> blockForcedChunks,
 ForgeChunkManager.TicketTracker<UUID> entityForcedChunks)

Reads the forge forced chunks from the NBT compound. Format is List{modid, List{ChunkPos, List{BlockPos}, List{UUID}}}

API Note:

Internal

readBlockForcedChunks

private static void readBlockForcedChunks(String modId,
 long chunkPos,
 CompoundTag modEntry,
 String key,
 Map<ForgeChunkManager.TicketOwner<BlockPos>,it.unimi.dsi.fastutil.longs.LongSet> blockForcedChunks)

Reads the forge block forced chunks.

readEntityForcedChunks

private static void readEntityForcedChunks(String modId,
 long chunkPos,
 CompoundTag modEntry,
 String key,
 Map<ForgeChunkManager.TicketOwner<UUID>,it.unimi.dsi.fastutil.longs.LongSet> entityForcedChunks)

Reads the forge entity forced chunks.