Package net.minecraft.resource

Class SinglePreparationResourceReloader<T>

java.lang.Object

net.minecraft.resource.SinglePreparationResourceReloader<T>

Type Parameters:

T - the intermediate object type

All Implemented Interfaces:

ResourceReloader

Direct Known Subclasses:

BakedModelManager, FoliageColormapResourceSupplier, GrassColormapResourceSupplier, JsonDataLoader, SoundManager, SplashTextResourceSupplier, SpriteAtlasHolder, VideoWarningManager

public abstract class SinglePreparationResourceReloader<T>
extends Object
implements ResourceReloader

A base resource reloader implementation that prepares an object in a single call (as opposed to in multiple concurrent tasks) and handles the prepared object in the apply stage.

Nested Class Summary

Nested classes/interfaces inherited from interface net.minecraft.resource.ResourceReloader

ResourceReloader.Synchronizer

Constructor Summary

Constructors

Constructor	Description
SinglePreparationResourceReloader()

Method Summary

Modifier and Type	Method	Description
protected abstract void	apply(T prepared, ResourceManager manager, Profiler profiler)	Handles the prepared intermediate object.
protected abstract T	prepare(ResourceManager manager, Profiler profiler)	Prepares the intermediate object.
CompletableFuture<Void>	reload(ResourceReloader.Synchronizer synchronizer, ResourceManager manager, Profiler prepareProfiler, Profiler applyProfiler, Executor prepareExecutor, Executor applyExecutor)	Performs a reload.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.minecraft.resource.ResourceReloader

getName

Constructor Details

SinglePreparationResourceReloader

public SinglePreparationResourceReloader()

Method Details

reload

public final CompletableFuture<Void> reload(ResourceReloader.Synchronizer synchronizer,
ResourceManager manager,
Profiler prepareProfiler,
Profiler applyProfiler,
Executor prepareExecutor,
Executor applyExecutor)

Performs a reload. Returns a future that is completed when the reload is completed.

In a reload, there is a prepare stage and an apply stage. For the prepare stage, you should create completable futures with CompletableFuture.supplyAsync(..., prepareExecutor) to ensure the prepare actions are done with the prepare executor. Then, you should have a completable future for all the prepared actions, and call combinedPrepare.thenCompose(synchronizer::waitFor) to notify the synchronizer. Finally, you should run CompletableFuture.thenAcceptAsync(..., applyExecutor) for apply actions. In the end, returns the result of thenAcceptAsync.

Specified by:

reload in interface ResourceReloader

Parameters:

synchronizer - the synchronizer

manager - the resource manager

prepareProfiler - the profiler for prepare stage

applyProfiler - the profiler for apply stage

prepareExecutor - the executor for prepare stage

applyExecutor - the executor for apply stage

Returns:

a future for the reload

See Also:

ReloadableResourceManager.reload(Executor, Executor, CompletableFuture, List)

prepare

protected abstract T prepare(ResourceManager manager,
Profiler profiler)

Prepares the intermediate object.

This method is called in the prepare executor in a reload.

Parameters:

manager - the resource manager

profiler - the prepare profiler

Returns:

the prepared object

apply

protected abstract void apply(T prepared,
ResourceManager manager,
Profiler profiler)

Handles the prepared intermediate object.

This method is called in the apply executor, or the game engine, in a reload.

Parameters:

prepared - the prepared object

manager - the resource manager

profiler - the apply profiler