imports/architectury-api
1
0
Fork 0
mirror of https://github.com/architectury/architectury-api.git synced 2026-03-30 05:05:19 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix ParticleProviderRegistry not working properly on Forge, add Javadocs (#305)

Browse Source 
* Fix ParticleProviderRegistry not working properly on Forge, add Javadocs

Based on https://github.com/architectury/architectury-api/pull/196#issuecomment-1200268981, supersedes #196

* Update testmod, fix bounds on deferred register

* Warn when registering particles too late on Forge
This commit is contained in:
Max
2022-07-31 18:48:38 +02:00
committed by GitHub
parent 7b4b91ea47
commit a7d31393a0
6 changed files with 37 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
common/src/main/java/dev/architectury/registry/client/particle/ParticleProviderRegistry.java
View File

@@ -19,7 +19,9 @@
package dev.architectury.registry.client.particle;
import dev.architectury.event.events.client.ClientLifecycleEvent;
import dev.architectury.injectables.annotations.ExpectPlatform;
import dev.architectury.registry.registries.RegistrySupplier;
import net.fabricmc.api.EnvType;
import net.fabricmc.api.Environment;
import net.minecraft.client.particle.ParticleProvider;
@@ -31,6 +33,17 @@ import net.minecraft.core.particles.ParticleType;
import java.util.List;
/**
* A utility class for registering custom {@link ParticleProvider}s for particle types.
* <p>
* This class's methods should be invoked <b>before</b> {@link ClientLifecycleEvent#CLIENT_SETUP},
* as doing so afterwards will result in the providers not being registered properly on Forge, causing crashes on startup.
* <p>
* Generally speaking, you should either listen to the registration of your particle type yourself and use either
* {@link #register(ParticleType, ParticleProvider)} or {@link #register(ParticleType, DeferredParticleProvider)} to register the provider,
* or use the helper methods {@link #register(RegistrySupplier, ParticleProvider)} and {@link #register(RegistrySupplier, DeferredParticleProvider)},
* which will automatically handle the listening for you.
*/
@Environment(EnvType.CLIENT)
public final class ParticleProviderRegistry {
public interface ExtendedSpriteSet extends SpriteSet {
@@ -39,6 +52,14 @@ public final class ParticleProviderRegistry {
List<TextureAtlasSprite> getSprites();
}
public static <T extends ParticleOptions> void register(RegistrySupplier<? extends ParticleType<T>> supplier, ParticleProvider<T> provider) {
supplier.listen(it -> register(it, provider));
}
public static <T extends ParticleOptions> void register(RegistrySupplier<? extends ParticleType<T>> supplier, DeferredParticleProvider<T> provider) {
supplier.listen(it -> register(it, provider));
}
@ExpectPlatform
public static <T extends ParticleOptions> void register(ParticleType<T> type, ParticleProvider<T> provider) {
throw new AssertionError();