io.github.opencubicchunks.cubicchunks.core.server.chunkio.async.forge

Class AsyncWorldIOExecutor

java.lang.Object

io.github.opencubicchunks.cubicchunks.core.server.chunkio.async.forge.AsyncWorldIOExecutor

@MethodsReturnNonnullByDefault
 @ParametersAreNonnullByDefault
public class AsyncWorldIOExecutor
extends java.lang.Object

Brazenly copied from Forge and Sponge and reimplemented to suit our needs: Load cubes and columns outside the main thread, then synchronize at the start of the next tick

Constructor Summary

Constructors

Constructor and Description
AsyncWorldIOExecutor()

Method Summary

Modifier and Type	Method and Description
static boolean	canDropColumn(net.minecraft.world.World world, int x, int z)
static void	dropQueuedColumnLoad(net.minecraft.world.World world, int x, int z, java.util.function.Consumer<net.minecraft.world.chunk.Chunk> runnable) Notify the loader that this column isn't needed anymore
static void	dropQueuedCubeLoad(net.minecraft.world.World world, int x, int y, int z, java.util.function.Consumer<Cube> runnable) Notify the loader that this cube isn't needed anymore
static void	onPlayerLoggedIn(net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedInEvent evt)
static void	onPlayerLoggedOut(net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedOutEvent evt)
static void	onWorldTick(net.minecraftforge.fml.common.gameevent.TickEvent.WorldTickEvent evt)
static void	queueColumnLoad(net.minecraft.world.World world, ICubeIO loader, int x, int z, java.util.function.Consumer<net.minecraft.world.chunk.Chunk> runnable, java.util.function.Consumer<net.minecraft.world.chunk.Chunk> setLoadingColumnCallback) Queue a column load, running the specified callback when the load has finished
static void	queueCubeLoad(net.minecraft.world.World world, ICubeIO loader, CubeProviderServer cache, int x, int y, int z, java.util.function.Consumer<Cube> runnable) Queue a cube load, running the specified callback when the load has finished.
static void	shutdownNowBlocking()
static net.minecraft.world.chunk.Chunk	syncColumnLoad(net.minecraft.world.World world, ICubeIO loader, int x, int z, java.util.function.Consumer<net.minecraft.world.chunk.Chunk> setLoadingColumnCallback) Load a column, directly
static Cube	syncCubeLoad(net.minecraft.world.World world, ICubeIO loader, CubeProviderServer cache, int cubeX, int cubeY, int cubeZ) Load a cube, directly.
static void	tick() Run a synchronous tick, finishing the loading process for load tasks that are ready

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncWorldIOExecutor

public AsyncWorldIOExecutor()

Method Detail

syncCubeLoad

@Nullable
public static Cube syncCubeLoad(net.minecraft.world.World world,
                                          ICubeIO loader,
                                          CubeProviderServer cache,
                                          int cubeX,
                                          int cubeY,
                                          int cubeZ)

Load a cube, directly.

Parameters:

world - The world in which the cube lies

loader - The file loader for cubes

cache - the cube cache used to load cubes and columns

cubeX - X coordinate of the cube to load

cubeY - Y coordinate of the cube to load

cubeZ - Z coordinate of the cube to load

Returns:

The loaded cube, or null if either not present or the load failed

syncColumnLoad

@Nullable
public static net.minecraft.world.chunk.Chunk syncColumnLoad(net.minecraft.world.World world,
                                                                       ICubeIO loader,
                                                                       int x,
                                                                       int z,
                                                                       java.util.function.Consumer<net.minecraft.world.chunk.Chunk> setLoadingColumnCallback)

Load a column, directly

Parameters:

world - The world in which the column lies

loader - The file loader for columns

x - column x position

z - column z position

setLoadingColumnCallback - callback to run just before and after the load event is posted

Returns:

The loaded column

queueCubeLoad

public static void queueCubeLoad(net.minecraft.world.World world,
                                 ICubeIO loader,
                                 CubeProviderServer cache,
                                 int x,
                                 int y,
                                 int z,
                                 java.util.function.Consumer<Cube> runnable)

Queue a cube load, running the specified callback when the load has finished. This may cause a two tick delay if the column has to be loaded, too! If you need it faster, consider sync loading either column or both cube and column.

Parameters:

world - The world of the cube

loader - The file loader for this world

cache - The server cube cache

x - cube x position

y - cube y position

z - cube z position

runnable - The callback

queueColumnLoad

public static void queueColumnLoad(net.minecraft.world.World world,
                                   ICubeIO loader,
                                   int x,
                                   int z,
                                   java.util.function.Consumer<net.minecraft.world.chunk.Chunk> runnable,
                                   java.util.function.Consumer<net.minecraft.world.chunk.Chunk> setLoadingColumnCallback)

Queue a column load, running the specified callback when the load has finished

Parameters:

world - The world of the column

loader - The file loader for this world

x - column x position

z - column z position

runnable - The callback

setLoadingColumnCallback - callback to run just before and after the load event is posted

dropQueuedCubeLoad

public static void dropQueuedCubeLoad(net.minecraft.world.World world,
                                      int x,
                                      int y,
                                      int z,
                                      java.util.function.Consumer<Cube> runnable)

Notify the loader that this cube isn't needed anymore

Parameters:

world - The world

x - cube x position

y - cube y position

z - cube z position

runnable - The runnable that should be dropped

dropQueuedColumnLoad

public static void dropQueuedColumnLoad(net.minecraft.world.World world,
                                        int x,
                                        int z,
                                        java.util.function.Consumer<net.minecraft.world.chunk.Chunk> runnable)

Notify the loader that this column isn't needed anymore

Parameters:

world - The world

x - column x position

z - column z postion

runnable - The runnable that should be dropped

shutdownNowBlocking

public static void shutdownNowBlocking()

tick

public static void tick()

Run a synchronous tick, finishing the loading process for load tasks that are ready

canDropColumn

public static boolean canDropColumn(net.minecraft.world.World world,
                                    int x,
                                    int z)

onPlayerLoggedIn

public static void onPlayerLoggedIn(@Nonnull
                                    net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedInEvent evt)

onPlayerLoggedOut

public static void onPlayerLoggedOut(@Nonnull
                                     net.minecraftforge.fml.common.gameevent.PlayerEvent.PlayerLoggedOutEvent evt)

onWorldTick

public static void onWorldTick(net.minecraftforge.fml.common.gameevent.TickEvent.WorldTickEvent evt)