Package net.neoforged.neoforge.common.world.chunk

Class ForcedChunkManager

java.lang.Object

net.neoforged.neoforge.common.world.chunk.ForcedChunkManager

@ParametersAreNonnullByDefault
public class ForcedChunkManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ForcedChunkManager.OwnedChunks
(package private) static class	ForcedChunkManager.TicketOwner<T extends Comparable<? super T>>	Helper class to keep track of a ticket owner by controller ID and owner object
static class	ForcedChunkManager.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 Map<ResourceLocation,TicketController>	controllers
private static boolean	initialised
private static final org.apache.logging.log4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
ForcedChunkManager()

Method Summary

Modifier and Type	Method	Description
static void	activateAllDeactivatedTickets(ServerLevel level, TicketStorage saveData)	Reinstates NeoForge's forced chunks when vanilla initially loads a level and reinstates their forced chunks.
static com.mojang.datafixers.kinds.App<com.mojang.serialization.codecs.RecordCodecBuilder.Mu<TicketStorage>,List<ForcedChunkManager.OwnedChunks>>	defineExtraStorageParams()	Defines any extra parameters we are adding via a P1#add call
(package private) static <T extends Comparable<? super T>> boolean	forceChunk(ServerLevel level, ResourceLocation id, T owner, int chunkX, int chunkZ, boolean add, boolean forceNaturalSpawning, Function<TicketStorage,ForcedChunkManager.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	gatherTicketsById(it.unimi.dsi.fastutil.longs.Long2ObjectMap<Set<ForcedChunkManager.TicketOwner<T>>> tickets, Function<TicketSet,it.unimi.dsi.fastutil.longs.LongSet> typeGetter, Map<ResourceLocation,Map<T,TicketSet>> modSortedOwnedChunks)	Gathers tickets into an ID filtered map for use in providing all tickets a controller has registered to its LoadingValidationCallback.
private static <T extends Comparable<? super T>> Map<ResourceLocation,Map<T,TicketSet>>	gatherTicketsById(ForcedChunkManager.TicketTracker<T> tickets, boolean includeLoaded, boolean includeDeactivated)	Gathers tickets into an ID filtered map for use in providing all tickets a controller has registered to its LoadingValidationCallback.
static boolean	hasForcedChunks(ServerLevel level)	Checks if a level has any forced chunks.
static void	init()
static TicketStorage	readStoredTickets(Function<List<com.mojang.datafixers.util.Pair<ChunkPos,Ticket>>,TicketStorage> vanillaInitializer, List<com.mojang.datafixers.util.Pair<ChunkPos,Ticket>> tickets, List<ForcedChunkManager.OwnedChunks> ownedChunks)	Reads any forced chunks we might have previously saved.

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

initialised

private static boolean initialised

controllers

private static Map<ResourceLocation,TicketController> controllers

Constructor Details

ForcedChunkManager

public ForcedChunkManager()

Method Details

init

@Internal
public static void init()

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

static <T extends Comparable<? super T>> boolean forceChunk(ServerLevel level,
 ResourceLocation id,
 T owner,
 int chunkX,
 int chunkZ,
 boolean add,
 boolean forceNaturalSpawning,
 Function<TicketStorage,ForcedChunkManager.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.

activateAllDeactivatedTickets

@Internal
public static void activateAllDeactivatedTickets(ServerLevel level,
 TicketStorage saveData)

Reinstates NeoForge's forced chunks when vanilla initially loads a level and reinstates their forced chunks. This method also will validate all the forced chunks with the registered LoadingValidationCallbacks.

gatherTicketsById

private static <T extends Comparable<? super T>>
Map<ResourceLocation,Map<T,TicketSet>> gatherTicketsById(ForcedChunkManager.TicketTracker<T> tickets,
 boolean includeLoaded,
 boolean includeDeactivated)

Gathers tickets into an ID filtered map for use in providing all tickets a controller has registered to its LoadingValidationCallback.

gatherTicketsById

private static <T extends Comparable<? super T>>
void gatherTicketsById(it.unimi.dsi.fastutil.longs.Long2ObjectMap<Set<ForcedChunkManager.TicketOwner<T>>> tickets,
 Function<TicketSet,it.unimi.dsi.fastutil.longs.LongSet> typeGetter,
 Map<ResourceLocation,Map<T,TicketSet>> modSortedOwnedChunks)

Gathers tickets into an ID filtered map for use in providing all tickets a controller has registered to its LoadingValidationCallback.

defineExtraStorageParams

@Internal
public static com.mojang.datafixers.kinds.App<com.mojang.serialization.codecs.RecordCodecBuilder.Mu<TicketStorage>,List<ForcedChunkManager.OwnedChunks>> defineExtraStorageParams()

Defines any extra parameters we are adding via a P1#add call

readStoredTickets

@Internal
public static TicketStorage readStoredTickets(Function<List<com.mojang.datafixers.util.Pair<ChunkPos,Ticket>>,TicketStorage> vanillaInitializer,
 List<com.mojang.datafixers.util.Pair<ChunkPos,Ticket>> tickets,
 List<ForcedChunkManager.OwnedChunks> ownedChunks)

Reads any forced chunks we might have previously saved.