mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-22 13:09:59 +00:00
Add support for custom particle groups (#10692)
This commit is contained in:
6 files changed
+156
-25
No files matched your search
@@ -1,14 +1,5 @@
|
||||
--- a/net/minecraft/client/particle/ParticleEngine.java
|
||||
+++ b/net/minecraft/client/particle/ParticleEngine.java
|
||||
@@ -26,7 +_,7 @@
|
||||
public class ParticleEngine {
|
||||
private static final List<ParticleRenderType> RENDER_ORDER = List.of(ParticleRenderType.SINGLE_QUADS, ParticleRenderType.ITEM_PICKUP, ParticleRenderType.ELDER_GUARDIANS);
|
||||
protected ClientLevel level;
|
||||
- private final Map<ParticleRenderType, ParticleGroup<?>> particles = Maps.newIdentityHashMap();
|
||||
+ private final Map<ParticleRenderType, ParticleGroup<?>> particles = Maps.newTreeMap(net.minecraftforge.client.ForgeHooksClient.makeParticleRenderTypeComparator(RENDER_ORDER));
|
||||
private final Queue<TrackingEmitter> trackingEmitters = Queues.newArrayDeque();
|
||||
private final Queue<Particle> particlesToAdd = Queues.newArrayDeque();
|
||||
private final Object2IntOpenHashMap<ParticleLimit> trackedParticleCounts = new Object2IntOpenHashMap<>();
|
||||
@@ -63,7 +_,7 @@
|
||||
private <T extends ParticleOptions> Particle makeParticle(
|
||||
T p_107396_, double p_107397_, double p_107398_, double p_107399_, double p_107400_, double p_107401_, double p_107402_
|
||||
@@ -18,12 +9,34 @@
|
||||
return particleprovider == null
|
||||
? null
|
||||
: particleprovider.createParticle(p_107396_, this.level, p_107397_, p_107398_, p_107399_, p_107400_, p_107401_, p_107402_, this.random);
|
||||
@@ -123,7 +_,7 @@
|
||||
@@ -113,6 +_,8 @@
|
||||
return new ItemPickupParticleGroup(this);
|
||||
} else if (p_428647_ == ParticleRenderType.ELDER_GUARDIANS) {
|
||||
return new ElderGuardianParticleGroup(this);
|
||||
+ } else if (factories.containsKey(p_428647_)) {
|
||||
+ return factories.get(p_428647_).apply(this);
|
||||
} else {
|
||||
return (ParticleGroup<?>)(p_428647_ == ParticleRenderType.NO_RENDER ? new NoRenderParticleGroup(this) : new QuadParticleGroup(this, p_428647_));
|
||||
}
|
||||
@@ -122,8 +_,20 @@
|
||||
this.trackedParticleCounts.addTo(p_423291_, p_172283_);
|
||||
}
|
||||
|
||||
+
|
||||
+ private static final Map<ParticleRenderType, java.util.function.Function<ParticleEngine, ParticleGroup<?>>> factories = new java.util.HashMap<>();
|
||||
+ private static final List<ParticleRenderType> particleRenderOrder = new java.util.ArrayList<>(RENDER_ORDER);
|
||||
+
|
||||
+ // Forge: allow custom particle groups
|
||||
+ public static void registerParticleGroup(ParticleRenderType type, java.util.function.Function<ParticleEngine, ParticleGroup<?>> factory) {
|
||||
+ if (factories.putIfAbsent(type, factory) != null) {
|
||||
+ throw new IllegalArgumentException(type.name() + " already has a factory registered. Previous factory was " + factories.get(type) + ". This factory was " + factory);
|
||||
+ }
|
||||
+ particleRenderOrder.add(type);
|
||||
+ }
|
||||
+
|
||||
public void extract(ParticlesRenderState p_423938_, Frustum p_424803_, Camera p_430521_, float p_426823_) {
|
||||
- for (ParticleRenderType particlerendertype : RENDER_ORDER) {
|
||||
+ for (ParticleRenderType particlerendertype : this.particles.keySet()) { // Forge: allow custom ParticleRenderType's
|
||||
+ for (ParticleRenderType particlerendertype : particleRenderOrder) { // Forge: allow custom ParticleRenderType's
|
||||
ParticleGroup<?> particlegroup = this.particles.get(particlerendertype);
|
||||
if (particlegroup != null && !particlegroup.isEmpty()) {
|
||||
p_423938_.add(particlegroup.extractRenderState(p_424803_, p_430521_, p_426823_));
|
||||
@@ -729,20 +729,6 @@ public class ForgeHooksClient {
|
||||
return font.split(text, maxWidth).stream().map(ClientTooltipComponent::create);
|
||||
}
|
||||
|
||||
public static Comparator<ParticleRenderType> makeParticleRenderTypeComparator(List<ParticleRenderType> renderOrder) {
|
||||
Comparator<ParticleRenderType> vanillaComparator = Comparator.comparingInt(renderOrder::indexOf);
|
||||
return (typeOne, typeTwo) -> {
|
||||
boolean vanillaOne = renderOrder.contains(typeOne);
|
||||
boolean vanillaTwo = renderOrder.contains(typeTwo);
|
||||
|
||||
if (vanillaOne && vanillaTwo)
|
||||
return vanillaComparator.compare(typeOne, typeTwo);
|
||||
if (!vanillaOne && !vanillaTwo)
|
||||
return Integer.compare(System.identityHashCode(typeOne), System.identityHashCode(typeTwo));
|
||||
return vanillaOne ? -1 : 1;
|
||||
};
|
||||
}
|
||||
|
||||
public static boolean isBlockInSolidLayer(BlockState state) {
|
||||
var model = Minecraft.getInstance().getBlockRenderer().getBlockModel(state);
|
||||
return model.getRenderTypes(state, RandomSource.create(), ModelData.EMPTY).contains(ChunkSectionLayer.SOLID);
|
||||
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"type": "minecraft:function",
|
||||
"environment": "minecraft:default",
|
||||
"function": "forge:custom_particle_type_test/is_custom_group",
|
||||
"max_ticks": 100,
|
||||
"structure": "forge:empty3x3x3"
|
||||
}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"type": "minecraft:function",
|
||||
"environment": "minecraft:default",
|
||||
"function": "forge:custom_particle_type_test/prevent_duplicate_group",
|
||||
"max_ticks": 100,
|
||||
"structure": "forge:empty3x3x3"
|
||||
}
|
||||
@@ -0,0 +1,117 @@
|
||||
/*
|
||||
* Copyright (c) Forge Development LLC and contributors
|
||||
* SPDX-License-Identifier: LGPL-2.1-only
|
||||
*/
|
||||
|
||||
package net.minecraftforge.debug.client;
|
||||
|
||||
import net.minecraft.client.Minecraft;
|
||||
import net.minecraft.client.multiplayer.ClientLevel;
|
||||
import net.minecraft.client.particle.*;
|
||||
import net.minecraft.gametest.framework.GameTestHelper;
|
||||
import net.minecraft.world.entity.player.Player;
|
||||
import net.minecraft.world.level.block.Blocks;
|
||||
import net.minecraftforge.event.TickEvent;
|
||||
import net.minecraftforge.fml.common.Mod;
|
||||
import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext;
|
||||
import net.minecraftforge.gametest.GameTest;
|
||||
import net.minecraftforge.gametest.GameTestNamespace;
|
||||
import net.minecraftforge.test.BaseTestMod;
|
||||
|
||||
import java.lang.reflect.Field;
|
||||
import java.util.Map;
|
||||
|
||||
@GameTestNamespace("forge")
|
||||
@Mod(CustomParticleTypeTest.MOD_ID)
|
||||
public class CustomParticleTypeTest extends BaseTestMod {
|
||||
public static final String MOD_ID = "custom_particle_type_test";
|
||||
private static final ParticleRenderType CUSTOM_TYPE = new ParticleRenderType("GRP_ONE");
|
||||
private static final ParticleRenderType CUSTOM_TYPE_TWO = new ParticleRenderType("GRP_TWO");
|
||||
private static final ParticleRenderType CUSTOM_TYPE_DUP = new ParticleRenderType("GRP_DUP");
|
||||
|
||||
public CustomParticleTypeTest(FMLJavaModLoadingContext context) {
|
||||
super(context, false, false);
|
||||
}
|
||||
|
||||
@GameTest
|
||||
public static void is_custom_group(GameTestHelper helper) {
|
||||
helper.addRecordListener(TickEvent.ClientTickEvent.Pre.BUS, CustomParticleTypeTest::onClientTick);
|
||||
try {
|
||||
ParticleEngine.registerParticleGroup(CUSTOM_TYPE, engine -> new TestParticleGroup(engine, CUSTOM_TYPE));
|
||||
ParticleEngine.registerParticleGroup(CUSTOM_TYPE_TWO, engine -> new OtherTestParticleGroup(engine, CUSTOM_TYPE_TWO));
|
||||
} catch (IllegalArgumentException ignored) {} // OK to call multiple times.
|
||||
helper.runAfterDelay(20, () -> {
|
||||
// Wait a little bit so there are some particles around.
|
||||
// If the particles (field) map contains our types, then we know they were added successfully and the test is OK.
|
||||
var engine = Minecraft.getInstance().particleEngine;
|
||||
try {
|
||||
Field field = ParticleEngine.class.getDeclaredField("particles");
|
||||
field.setAccessible(true);
|
||||
@SuppressWarnings("unchecked")
|
||||
var val = ((Map<ParticleRenderType, ParticleGroup<?>>) field.get(engine));
|
||||
var isPresentOne = val.get(CUSTOM_TYPE);
|
||||
var isPresentTwo = val.get(CUSTOM_TYPE_TWO);
|
||||
if (isPresentTwo instanceof OtherTestParticleGroup && isPresentOne instanceof TestParticleGroup) helper.succeed();
|
||||
else helper.fail("Particle types were not present when CustomParticleTypeTest checked");
|
||||
} catch (Exception e) {
|
||||
helper.fail("Unable to get 'particles' field from ParticleEngine, was it renamed or removed?");
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
@GameTest
|
||||
public static void prevent_duplicate_group(GameTestHelper helper) {
|
||||
boolean flag = false;
|
||||
try {
|
||||
ParticleEngine.registerParticleGroup(CUSTOM_TYPE_DUP, engine -> new TestParticleGroup(engine, CUSTOM_TYPE_DUP));
|
||||
ParticleEngine.registerParticleGroup(CUSTOM_TYPE_DUP, engine -> new TestParticleGroup(engine, CUSTOM_TYPE_DUP));
|
||||
} catch (IllegalArgumentException e) {
|
||||
flag = true;
|
||||
}
|
||||
helper.assertTrue(flag, "Test did not catch duplicate particle group registration.");
|
||||
helper.succeed();
|
||||
}
|
||||
|
||||
private static class TestParticleGroup extends QuadParticleGroup {
|
||||
public TestParticleGroup(ParticleEngine p_422302_, ParticleRenderType p_427417_) {
|
||||
super(p_422302_, p_427417_);
|
||||
}
|
||||
}
|
||||
private static class OtherTestParticleGroup extends QuadParticleGroup {
|
||||
public OtherTestParticleGroup(ParticleEngine p_422302_, ParticleRenderType p_427417_) {
|
||||
super(p_422302_, p_427417_);
|
||||
}
|
||||
}
|
||||
|
||||
private static class CustomParticle extends TerrainParticle {
|
||||
public CustomParticle(ClientLevel level, double x, double y, double z) {
|
||||
super(level, x, y, z, 0, .25, 0, Blocks.OBSIDIAN.defaultBlockState());
|
||||
}
|
||||
|
||||
@Override
|
||||
public ParticleRenderType getGroup()
|
||||
{
|
||||
return CUSTOM_TYPE;
|
||||
}
|
||||
}
|
||||
private static class AnotherCustomParticle extends TerrainParticle {
|
||||
public AnotherCustomParticle(ClientLevel level, double x, double y, double z) {
|
||||
super(level, x, y, z, 0, .25, 0, Blocks.SAND.defaultBlockState());
|
||||
}
|
||||
|
||||
@Override
|
||||
public ParticleRenderType getGroup()
|
||||
{
|
||||
return CUSTOM_TYPE_TWO;
|
||||
}
|
||||
}
|
||||
|
||||
public static void onClientTick(TickEvent.ClientTickEvent.Pre event) {
|
||||
ClientLevel level = Minecraft.getInstance().level;
|
||||
Player player = Minecraft.getInstance().player;
|
||||
if (player == null || level == null) { return; }
|
||||
|
||||
Minecraft.getInstance().particleEngine.add(new CustomParticle(level, player.getX(), player.getY(), player.getZ()));
|
||||
Minecraft.getInstance().particleEngine.add(new AnotherCustomParticle(level, player.getX(), player.getY(), player.getZ()));
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1 @@
|
||||
clientSideOnly=true
|
||||
Reference in new issue
Block a user