Fix missing colour tint on block particles (#57)

addon.gradle

@@ -6,3 +6,10 @@ minecraft {
         }
     }
 }
+
+test {
+    useJUnitPlatform()
+    testLogging {
+        events "passed", "skipped", "failed"
+    }
+}

dependencies.gradle

@@ -1,4 +1,7 @@
 // Add your dependencies here
 
 dependencies {
+    testImplementation(platform('org.junit:junit-bom:5.14.1'))
+    testImplementation('org.junit.jupiter:junit-jupiter')
+    testRuntimeOnly('org.junit.platform:junit-platform-launcher')
 }

src/main/java/codechicken/core/ClassDiscoverer.java

@@ -116,6 +116,7 @@ public class ClassDiscoverer {
             while (zipEntries.hasMoreElements()) {
                 ZipEntry zipentry = zipEntries.nextElement();
                 String fullname = zipentry.getName().replace('\\', '/');
+                if (fullname.startsWith("META-INF/versions/")) continue;
                 int pos = fullname.lastIndexOf('/');
                 String name = pos == -1 ? fullname : fullname.substring(pos + 1);
                 if (!zipentry.isDirectory() && matcher.matches(name)) {

src/main/java/codechicken/lib/lighting/SimpleBrightnessModel.java

@@ -12,7 +12,12 @@ import codechicken.lib.vec.BlockCoord;
 public class SimpleBrightnessModel implements CCRenderState.IVertexOperation {
 
     public static final int operationIndex = CCRenderState.registerOperation();
-    public static SimpleBrightnessModel instance = new SimpleBrightnessModel();
+    private static final ThreadLocal<SimpleBrightnessModel> instances = ThreadLocal
+            .withInitial(SimpleBrightnessModel::new);
+
+    public static SimpleBrightnessModel instance() {
+        return instances.get();
+    }
 
     public IBlockAccess access;
     public BlockCoord pos = new BlockCoord();

src/main/java/codechicken/lib/packet/PacketCustom.java

@@ -466,7 +466,7 @@ public final class PacketCustom implements MCDataInput, MCDataOutput {
 
     public FluidStack readFluidStack() {
         Fluid fluid = FluidRegistry.getFluid(readShort());
-        if (fluid == null) fluid = FluidRegistry.WATER;
+        if (fluid == null) return null;
 
         return new FluidStack(fluid, readVarInt(), readNBTTagCompound());
     }

src/main/java/codechicken/lib/render/CCRenderState.java

@@ -1,6 +1,7 @@
 package codechicken.lib.render;
 
 import java.util.ArrayList;
+import java.util.HashMap;
 
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.renderer.OpenGlHelper;
@@ -38,9 +39,9 @@ public class CCRenderState {
         return instances.get();
     }
 
-    private static int nextOperationIndex;
+    private static volatile int nextOperationIndex;
 
-    public static int registerOperation() {
+    public static synchronized int registerOperation() {
         return nextOperationIndex++;
     }
 
@@ -87,15 +88,52 @@ public class CCRenderState {
         int operationID();
     }
 
-    private static ArrayList<VertexAttribute<?>> vertexAttributes = new ArrayList<>();
+    public static final class AttributeKey<T> {
 
-    private static int registerVertexAttribute(VertexAttribute<?> attr) {
-        vertexAttributes.add(attr);
-        return vertexAttributes.size() - 1;
+        private static final HashMap<String, AttributeKey<?>> nameMap = new HashMap<>();
+        private static final ArrayList<AttributeKey<?>> attributeKeys = new ArrayList<>();
+        private static int nextLegacyId;
+
+        public final String name;
+        public final int attributeKeyIndex;
+        public final int operationIndex;
+        private VertexAttribute<T> canonical;
+
+        private AttributeKey(String name) {
+            this.name = name;
+            this.attributeKeyIndex = attributeKeys.size();
+            this.operationIndex = registerOperation();
+            attributeKeys.add(this);
+            nameMap.put(name, this);
+        }
+
+        public static synchronized <T> AttributeKey<T> create(String name) {
+            if (nameMap.containsKey(name))
+                throw new IllegalArgumentException("Duplicate registration of attribute with name: " + name);
+            return new AttributeKey<>(name);
+        }
+
+        static synchronized <T> AttributeKey<T> createLegacy() {
+            return new AttributeKey<>("legacy#" + nextLegacyId++);
+        }
+
+        synchronized void setCanonical(VertexAttribute<T> attr) {
+            if (canonical == null) canonical = attr;
+        }
+
+        static synchronized AttributeKey<?> get(int index) {
+            return attributeKeys.get(index);
+        }
     }
 
+    private static final AttributeKey<Vector3[]> NORMAL_KEY = AttributeKey.create("normal");
+    private static final AttributeKey<int[]> COLOUR_KEY = AttributeKey.create("colour");
+    private static final AttributeKey<int[]> LIGHTING_KEY = AttributeKey.create("lighting");
+    private static final AttributeKey<int[]> SIDE_KEY = AttributeKey.create("side");
+    private static final AttributeKey<LC[]> LC_KEY = AttributeKey.create("lc");
+
     public static VertexAttribute<?> getAttribute(int index) {
-        return vertexAttributes.get(index);
+        return AttributeKey.get(index).canonical;
     }
 
     /**
@@ -106,14 +144,26 @@ public class CCRenderState {
      */
     public abstract static class VertexAttribute<T> implements IVertexOperation {
 
-        public final int attributeIndex = registerVertexAttribute(this);
-        private final int operationIndex = registerOperation();
+        public final int attributeIndex;
+        private final int operationIndex;
         /**
          * Set to true when the attrute is part of the pipeline. Should only be managed by CCRenderState when
          * constructing the pipeline
          */
         public boolean active = false;
 
+        protected VertexAttribute(AttributeKey<T> key) {
+            attributeIndex = key.attributeKeyIndex;
+            operationIndex = key.operationIndex;
+            key.setCanonical(this);
+        }
+
+        /** @deprecated keyless attributes get a per-construction index that is threadsafe */
+        @Deprecated
+        protected VertexAttribute() {
+            this(AttributeKey.createLegacy());
+        }
+
         /**
          * Construct a new array for storage of vertex attrutes in a model
          */
@@ -189,7 +239,7 @@ public class CCRenderState {
         return instances.get().lightingAttrib;
     }
 
-    public VertexAttribute<Vector3[]> normalAttrib = new VertexAttribute<>() {
+    public VertexAttribute<Vector3[]> normalAttrib = new VertexAttribute<>(NORMAL_KEY) {
 
         private Vector3[] normalRef;
 
@@ -217,7 +267,7 @@ public class CCRenderState {
             else state.setNormalInstance(Rotation.axes[state.side]);
         }
     };
-    public VertexAttribute<int[]> colourAttrib = new VertexAttribute<>() {
+    public VertexAttribute<int[]> colourAttrib = new VertexAttribute<>(COLOUR_KEY) {
 
         private int[] colourRef;
 
@@ -239,7 +289,7 @@ public class CCRenderState {
             else state.setColourInstance(state.baseColour);
         }
     };
-    public VertexAttribute<int[]> lightingAttrib = new VertexAttribute<>() {
+    public VertexAttribute<int[]> lightingAttrib = new VertexAttribute<>(LIGHTING_KEY) {
 
         private int[] colourRef;
 
@@ -265,7 +315,7 @@ public class CCRenderState {
             state.setColourInstance(ColourRGBA.multiply(state.colour, colourRef[state.vertexIndex]));
         }
     };
-    public VertexAttribute<int[]> sideAttrib = new VertexAttribute<>() {
+    public VertexAttribute<int[]> sideAttrib = new VertexAttribute<>(SIDE_KEY) {
 
         private int[] sideRef;
 
@@ -292,7 +342,7 @@ public class CCRenderState {
     /**
      * Uses the position of the lightmatrix to compute LC if not provided
      */
-    public VertexAttribute<LC[]> lightCoordAttrib = new VertexAttribute<>() {
+    public VertexAttribute<LC[]> lightCoordAttrib = new VertexAttribute<>(LC_KEY) {
 
         private LC[] lcRef;
         private final Vector3 vec = new Vector3(); // for computation

src/main/java/codechicken/lib/render/EntityDigIconFX.java

@@ -1,5 +1,7 @@
 package codechicken.lib.render;
 
+import java.util.Arrays;
+
 import net.minecraft.client.particle.EffectRenderer;
 import net.minecraft.client.particle.EntityFX;
 import net.minecraft.client.renderer.Tessellator;
@@ -11,6 +13,9 @@ import codechicken.lib.vec.Vector3;
 
 public class EntityDigIconFX extends EntityFX {
 
+    /** Tint that leaves the particle colour untouched, for materials that don't colour their texture. */
+    public static final int NO_TINT = 0xFFFFFF;
+
     public EntityDigIconFX(World world, double x, double y, double z, double dx, double dy, double dz, IIcon icon) {
         super(world, x, y, z, dx, dy, dz);
         particleIcon = icon;
@@ -19,6 +24,18 @@ public class EntityDigIconFX extends EntityFX {
         particleScale /= 2.0F;
     }
 
+    /**
+     * Multiplies the particle colour by an 0xRRGGBB tint, the equivalent of vanilla
+     * EntityDiggingFX.applyColourMultiplier. Materials that draw a greyscale texture and colour it at render time
+     * (leaves, grass tops) need this, or their particles come out flat grey.
+     */
+    public EntityDigIconFX applyColourMultiplier(int colour) {
+        particleRed *= (colour >> 16 & 255) / 255F;
+        particleGreen *= (colour >> 8 & 255) / 255F;
+        particleBlue *= (colour & 255) / 255F;
+        return this;
+    }
+
     @Override
     public int getFXLayer() {
         return 1;
@@ -90,8 +107,24 @@ public class EntityDigIconFX extends EntityFX {
                 f9);
     }
 
+    /**
+     * @deprecated the particle is never tinted, so a material that colours a greyscale texture at render time (leaves,
+     *             grass tops) breaks into grey particles. Use
+     *             {@link #addBlockHitEffects(World, Cuboid6, int, IIcon, int, EffectRenderer)}, passing
+     *             {@link #NO_TINT} for materials whose texture is already coloured.
+     */
+    @Deprecated
     public static void addBlockHitEffects(World world, Cuboid6 bounds, int side, IIcon icon,
             EffectRenderer effectRenderer) {
+        addBlockHitEffects(world, bounds, side, icon, NO_TINT, effectRenderer);
+    }
+
+    /**
+     * Spawns a hit particle on side of bounds, tinted by colour (0xRRGGBB, {@link #NO_TINT} for none). The caller
+     * resolves the tint for the side it hit, so per-face materials like grass can tint only the faces that need it.
+     */
+    public static void addBlockHitEffects(World world, Cuboid6 bounds, int side, IIcon icon, int colour,
+            EffectRenderer effectRenderer) {
         float border = 0.1F;
         Vector3 diff = bounds.max.copy().subtract(bounds.min).add(-2 * border);
         diff.x *= world.rand.nextDouble();
@@ -106,13 +139,34 @@ public class EntityDigIconFX extends EntityFX {
         if (side == 4) diff.x = bounds.min.x - border;
         if (side == 5) diff.x = bounds.max.x + border;
 
-        effectRenderer.addEffect(
-                new EntityDigIconFX(world, pos.x, pos.y, pos.z, 0, 0, 0, icon).multiplyVelocity(0.2F)
-                        .multipleParticleScaleBy(0.6F));
+        EntityDigIconFX fx = new EntityDigIconFX(world, pos.x, pos.y, pos.z, 0, 0, 0, icon);
+        effectRenderer.addEffect(fx.applyColourMultiplier(colour).multiplyVelocity(0.2F).multipleParticleScaleBy(0.6F));
     }
 
+    /**
+     * @deprecated the particles are never tinted, so a material that colours a greyscale texture at render time
+     *             (leaves, grass tops) breaks into grey particles. Use
+     *             {@link #addBlockDestroyEffects(World, Cuboid6, IIcon[], int[], EffectRenderer)}, passing
+     *             {@link #NO_TINT} for the faces whose texture is already coloured.
+     */
+    @Deprecated
     public static void addBlockDestroyEffects(World world, Cuboid6 bounds, IIcon[] icons,
             EffectRenderer effectRenderer) {
+        int[] colours = new int[icons.length];
+        Arrays.fill(colours, NO_TINT);
+        addBlockDestroyEffects(world, bounds, icons, colours, effectRenderer);
+    }
+
+    /**
+     * Spawns break particles filling bounds, each drawn from a random face. colours holds the 0xRRGGBB tint for the
+     * matching entry of icons ({@link #NO_TINT} for none) and must be the same length, so a particle is tinted by the
+     * face it was taken from.
+     */
+    public static void addBlockDestroyEffects(World world, Cuboid6 bounds, IIcon[] icons, int[] colours,
+            EffectRenderer effectRenderer) {
+        if (icons.length != colours.length)
+            throw new IllegalArgumentException("icons and colours must have the same length");
+
         Vector3 diff = bounds.max.copy().subtract(bounds.min);
         Vector3 center = bounds.min.copy().add(bounds.max).multiply(0.5);
         Vector3 density = diff.copy().multiply(4);
@@ -121,19 +175,20 @@ public class EntityDigIconFX extends EntityFX {
         density.z = Math.ceil(density.z);
 
         for (int i = 0; i < density.x; ++i) for (int j = 0; j < density.y; ++j) for (int k = 0; k < density.z; ++k) {
-            double x = bounds.min.x + (i + 0.5) * diff.x / density.x;
-            double y = bounds.min.y + (j + 0.5) * diff.y / density.y;
-            double z = bounds.min.z + (k + 0.5) * diff.z / density.z;
-            effectRenderer.addEffect(
-                    new EntityDigIconFX(
-                            world,
-                            x,
-                            y,
-                            z,
-                            x - center.x,
-                            y - center.y,
-                            z - center.z,
-                            icons[world.rand.nextInt(icons.length)]));
+            double px = bounds.min.x + (i + 0.5) * diff.x / density.x;
+            double py = bounds.min.y + (j + 0.5) * diff.y / density.y;
+            double pz = bounds.min.z + (k + 0.5) * diff.z / density.z;
+            int iconSide = world.rand.nextInt(icons.length);
+            EntityDigIconFX fx = new EntityDigIconFX(
+                    world,
+                    px,
+                    py,
+                    pz,
+                    px - center.x,
+                    py - center.y,
+                    pz - center.z,
+                    icons[iconSide]);
+            effectRenderer.addEffect(fx.applyColourMultiplier(colours[iconSide]));
         }
     }
 }

src/main/java/codechicken/lib/world/WorldExtensionManager.java

@@ -55,7 +55,10 @@ public class WorldExtensionManager {
         public void onChunkUnLoad(ChunkEvent.Unload event) {
             if (event.getChunk() instanceof EmptyChunk) return;
 
-            for (WorldExtension extension : worldMap.get(event.world)) extension.unloadChunk(event.getChunk());
+            WorldExtension[] extensions = worldMap.get(event.world);
+            if (extensions == null) return;
+
+            for (WorldExtension extension : extensions) extension.unloadChunk(event.getChunk());
 
             if (event.world.isRemote) removeChunk(event.world, event.getChunk());
         }

src/test/java/codechicken/lib/render/CCRenderStateThreadingTest.java

@@ -0,0 +1,102 @@
+package codechicken.lib.render;
+
+import static org.junit.jupiter.api.Assertions.assertArrayEquals;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.concurrent.CyclicBarrier;
+import java.util.concurrent.ExecutorService;
+import java.util.concurrent.Executors;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+
+import org.junit.jupiter.api.Test;
+
+import codechicken.lib.vec.Vector3;
+
+public class CCRenderStateThreadingTest {
+
+    private static int[] attribIndices() {
+        return new int[] { CCRenderState.normalAttrib().attributeIndex, CCRenderState.colourAttrib().attributeIndex,
+                CCRenderState.lightingAttrib().attributeIndex, CCRenderState.sideAttrib().attributeIndex,
+                CCRenderState.lightCoordAttrib().attributeIndex };
+    }
+
+    @Test
+    public void attributeIndicesStableAcrossThreads() throws Exception {
+        int[] main = attribIndices();
+        assertEquals(5, Arrays.stream(main).distinct().count());
+
+        ExecutorService pool = Executors.newFixedThreadPool(8);
+        try {
+            List<Future<int[]>> futures = new ArrayList<>();
+            for (int i = 0; i < 8; i++) futures.add(pool.submit(CCRenderStateThreadingTest::attribIndices));
+            for (Future<int[]> f : futures) assertArrayEquals(main, f.get(10, TimeUnit.SECONDS));
+        } finally {
+            pool.shutdownNow();
+        }
+    }
+
+    @Test
+    public void modelBakedOnOneThreadIsReadableOnAnother() throws Exception {
+        ExecutorService bakeThread = Executors.newSingleThreadExecutor();
+        ExecutorService renderThread = Executors.newSingleThreadExecutor();
+        try {
+            CCModel model = bakeThread.submit(() -> {
+                CCModel m = CCModel.quadModel(4);
+                m.verts[0] = new Vertex5(0, 1, 0, 0, 0);
+                m.verts[1] = new Vertex5(0, 1, 1, 0, 1);
+                m.verts[2] = new Vertex5(1, 1, 1, 1, 1);
+                m.verts[3] = new Vertex5(1, 1, 0, 1, 0);
+                return m.computeNormals();
+            }).get(10, TimeUnit.SECONDS);
+
+            int side = renderThread.submit(() -> {
+                assertTrue(
+                        model.hasAttribute(CCRenderState.normalAttrib()),
+                        "normals baked on another thread not visible under this thread's attributeIndex");
+                Vector3[] normals = model.getAttributes(CCRenderState.normalAttrib());
+                assertNotNull(normals);
+                return CCModel.findSide(normals[0]);
+            }).get(10, TimeUnit.SECONDS);
+
+            assertEquals(1, side);
+            assertEquals(1, CCModel.findSide(model.getAttributes(CCRenderState.normalAttrib())[0]));
+        } finally {
+            bakeThread.shutdownNow();
+            renderThread.shutdownNow();
+        }
+    }
+
+    @Test
+    public void concurrentFirstUseKeepsIndicesConsistent() throws Exception {
+        int threads = 16;
+        CyclicBarrier barrier = new CyclicBarrier(threads);
+        ExecutorService pool = Executors.newFixedThreadPool(threads);
+        try {
+            List<Future<int[]>> futures = new ArrayList<>();
+            for (int i = 0; i < threads; i++) futures.add(pool.submit(() -> {
+                barrier.await(10, TimeUnit.SECONDS);
+                return attribIndices();
+            }));
+            int[] expected = attribIndices();
+            for (Future<int[]> f : futures) assertArrayEquals(expected, f.get(10, TimeUnit.SECONDS));
+        } finally {
+            pool.shutdownNow();
+        }
+    }
+
+    @Test
+    public void getAttributeReturnsCanonicalForIndex() {
+        int normalIndex = CCRenderState.normalAttrib().attributeIndex;
+        CCRenderState.VertexAttribute<?> canonical = CCRenderState.getAttribute(normalIndex);
+        assertNotNull(canonical);
+        assertEquals(normalIndex, canonical.attributeIndex);
+        assertSame(canonical, CCRenderState.getAttribute(normalIndex));
+    }
+}

src/test/java/codechicken/lib/render/EntityDigIconFXTest.java

@@ -0,0 +1,20 @@
+package codechicken.lib.render;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+import net.minecraft.util.IIcon;
+
+import org.junit.jupiter.api.Test;
+
+public class EntityDigIconFXTest {
+
+    @Test
+    public void rejectsMismatchedIconAndColourCountsBeforeSpawning() {
+        IllegalArgumentException exception = assertThrows(
+                IllegalArgumentException.class,
+                () -> EntityDigIconFX.addBlockDestroyEffects(null, null, new IIcon[1], new int[0], null));
+
+        assertEquals("icons and colours must have the same length", exception.getMessage());
+    }
+}