Skip to content

add resource reload start/end events #5108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
chyzman wants to merge 4 commits into
base: 1.21.11
Choose a base branch
from
+62 −0
Open

add resource reload start/end events #5108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1d65ea9
add RESOURCES_LOADED client lifecycle event
chyzman Dec 30, 2025
483ae24
fixed style? the test might be styled wrong, but I copied the style o…
chyzman Dec 30, 2025
9e9b23b
auto formatter moment
chyzman Dec 30, 2025
6d35198
start and end
chyzman Dec 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .../client/java/net/fabricmc/fabric/api/client/event/lifecycle/v1/ClientLifecycleEvents.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,24 @@ private ClientLifecycleEvents() {
}
});

/**
* Called before the client begins loading resources.
*/
public static final Event<StartResourceReload> START_RESOURCE_RELOAD = EventFactory.createArrayBacked(StartResourceReload.class, callbacks -> (client, isFirst) -> {
Copy link
Contributor

@UpcraftLP UpcraftLP Jan 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be helpful to explain the isFirst parameter in the javadoc

for (StartResourceReload callback : callbacks) {
callback.startResourceReload(client, isFirst);
}
});

/**
* Called after the client has finished reloading resources.
*/
public static final Event<EndResourceReload> END_RESOURCE_RELOAD = EventFactory.createArrayBacked(EndResourceReload.class, callbacks -> (client, isFirst) -> {
for (EndResourceReload callback : callbacks) {
callback.endResourceReload(client, isFirst);
}
});

@FunctionalInterface
public interface ClientStarted {
void onClientStarted(Minecraft client);
Expand All @@ -57,4 +75,14 @@ public interface ClientStarted {
public interface ClientStopping {
void onClientStopping(Minecraft client);
}

@FunctionalInterface
public interface StartResourceReload {
void startResourceReload(Minecraft client, boolean isFirst);
}

@FunctionalInterface
public interface EndResourceReload {
void endResourceReload(Minecraft client, boolean isFirst);
}
}
26 changes: 26 additions & 0 deletions ...s-v1/src/client/java/net/fabricmc/fabric/mixin/event/lifecycle/client/MinecraftMixin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,17 @@

package net.fabricmc.fabric.mixin.event.lifecycle.client;

import java.util.concurrent.CompletableFuture;

import com.llamalad7.mixinextras.injector.wrapmethod.WrapMethod;
import com.llamalad7.mixinextras.injector.wrapoperation.Operation;
import org.spongepowered.asm.mixin.Mixin;
import org.spongepowered.asm.mixin.Shadow;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Coerce;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;

import net.minecraft.client.Minecraft;
import net.minecraft.client.multiplayer.ClientLevel;
Expand All @@ -30,6 +37,8 @@

@Mixin(Minecraft.class)
public abstract class MinecraftMixin {
@Shadow private boolean gameLoadFinished;

@Inject(at = @At("HEAD"), method = "tick")
private void onStartTick(CallbackInfo info) {
ClientTickEvents.START_CLIENT_TICK.invoker().onStartTick((Minecraft) (Object) this);
Expand All @@ -51,6 +60,23 @@ private void onStart(CallbackInfo ci) {
ClientLifecycleEvents.CLIENT_STARTED.invoker().onClientStarted((Minecraft) (Object) this);
}

@Inject(at = @At(value = "INVOKE", target = "Lnet/minecraft/server/packs/resources/ReloadableResourceManager;createReload(Ljava/util/concurrent/Executor;Ljava/util/concurrent/Executor;Ljava/util/concurrent/CompletableFuture;Ljava/util/List;)Lnet/minecraft/server/packs/resources/ReloadInstance;"), method = "<init>")
private void onStartResourceLoad(CallbackInfo ci) {
ClientLifecycleEvents.START_RESOURCE_RELOAD.invoker().startResourceReload((Minecraft) (Object) this, true);
}

@Inject(at = @At(value = "INVOKE", target = "Lnet/minecraft/client/ResourceLoadStateTracker;startReload(Lnet/minecraft/client/ResourceLoadStateTracker$ReloadReason;Ljava/util/List;)V"), method = "reloadResourcePacks(ZLnet/minecraft/client/Minecraft$GameLoadCookie;)Ljava/util/concurrent/CompletableFuture;")
private void onStartResourceReload(CallbackInfoReturnable<CompletableFuture<Void>> cir) {
ClientLifecycleEvents.START_RESOURCE_RELOAD.invoker().startResourceReload((Minecraft) (Object) this, false);
}

@WrapMethod(method = "onResourceLoadFinished")
private void onResourceLoadFinished(@Coerce Object gameLoadCookie, Operation<Void> original) {
boolean first = !this.gameLoadFinished;
original.call(gameLoadCookie);
ClientLifecycleEvents.END_RESOURCE_RELOAD.invoker().endResourceReload((Minecraft) (Object) this, first);
}

@Inject(method = "updateLevelInEngines", at = @At("TAIL"))
private void afterClientWorldChange(ClientLevel world, CallbackInfo ci) {
if (world != null) {
Expand Down
8 changes: 8 additions & 0 deletions ...tmodClient/java/net/fabricmc/fabric/test/event/lifecycle/client/ClientLifecycleTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ public void onInitializeClient() {
System.out.println("Client has started stopping!");
});

ClientLifecycleEvents.START_RESOURCE_RELOAD.register((client, first) -> {
LOGGER.info((first ? "First r" : "R") + "esource load starting");
});

ClientLifecycleEvents.END_RESOURCE_RELOAD.register((client, first) -> {
LOGGER.info((first ? "First r" : "R") + "esource load completed");
});

ClientWorldEvents.AFTER_CLIENT_WORLD_CHANGE.register((client, world) -> {
LOGGER.info("Client world changed to {}", world.dimension().identifier());
});
Expand Down
Loading