Add DhApiBlockColorOverrideEvent

Could be helpful to !1240
2026-04-14 20:36:34 -05:00
parent 61eaa5a734
commit 7667f51cf3
10 changed files with 118 additions and 82 deletions
@@ -12,7 +12,7 @@ import com.seibel.distanthorizons.common.render.blaze.apply.BlazeDhApplyRenderer
 import com.seibel.distanthorizons.common.render.blaze.wrappers.texture.BlazeTextureWrapper;
 import com.seibel.distanthorizons.core.dependencyInjection.SingletonInjector;
 import com.seibel.distanthorizons.core.render.RenderParams;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import com.seibel.distanthorizons.core.wrapperInterfaces.minecraft.IMinecraftRenderWrapper;
 import com.seibel.distanthorizons.core.wrapperInterfaces.render.renderPass.IDhMetaRenderer;
 import com.seibel.distanthorizons.coreapi.DependencyInjection.ApiEventInjector;
@@ -17,7 +17,7 @@ import com.seibel.distanthorizons.common.render.openGl.glObject.enums.GLEnums;
 import com.seibel.distanthorizons.core.render.RenderThreadTaskHandler;
 import com.seibel.distanthorizons.core.wrapperInterfaces.render.objects.IDhGenericObjectVertexBufferContainer;
 import com.seibel.distanthorizons.core.render.renderer.RenderableBoxGroup;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import org.lwjgl.opengl.GL32;

 import java.nio.ByteBuffer;
@@ -13,7 +13,7 @@ import com.mojang.blaze3d.textures.*;
 import com.seibel.distanthorizons.core.dependencyInjection.SingletonInjector;
 import com.seibel.distanthorizons.core.logging.DhLogger;
 import com.seibel.distanthorizons.core.logging.DhLoggerBuilder;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import com.seibel.distanthorizons.core.wrapperInterfaces.minecraft.IMinecraftRenderWrapper;

 import java.util.OptionalDouble;
@@ -6,7 +6,7 @@ import com.seibel.distanthorizons.core.dataObjects.fullData.sources.FullDataSour
 import com.seibel.distanthorizons.core.logging.DhLoggerBuilder;
 import com.seibel.distanthorizons.core.pos.DhSectionPos;
 import com.seibel.distanthorizons.core.pos.blockPos.DhBlockPosMutable;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import com.seibel.distanthorizons.core.util.FullDataPointUtil;

 import com.seibel.distanthorizons.core.wrapperInterfaces.world.IClientLevelWrapper;
@@ -25,7 +25,7 @@ import com.seibel.distanthorizons.common.wrappers.WrapperFactory;
 import com.seibel.distanthorizons.core.config.Config;
 import com.seibel.distanthorizons.core.config.types.ConfigEntry;
 import com.seibel.distanthorizons.core.logging.DhLoggerBuilder;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import com.seibel.distanthorizons.core.util.LodUtil;
 import com.seibel.distanthorizons.core.wrapperInterfaces.block.IBlockStateWrapper;

@@ -128,6 +128,7 @@ public class BlockStateWrapper implements IBlockStateWrapper
 	private final boolean allowsBeaconBeamPassage;
 	private final boolean isSolid;
 	private final boolean isLiquid;
+	private final boolean allowApiColorOverride;
 	/** null if this block can't tint beacons */
 	private final Color beaconTintColor; 
 	private final Color mapColor;
@@ -225,6 +226,17 @@ public class BlockStateWrapper implements IBlockStateWrapper
 			this.opacity = this.calculateOpacity();
 		}
 		
+		// allow overriding if present 
+		if (overrideEventParam != null 
+			&& overrideEventParam.getAllowApiColorOverride() != null)
+		{
+			this.allowApiColorOverride = overrideEventParam.getAllowApiColorOverride();
+		}
+		else
+		{
+			this.allowApiColorOverride = false;
+		}
+		
 		String lowerCaseSerial = this.serialString.toLowerCase();
 		
 		
@@ -682,6 +694,8 @@ public class BlockStateWrapper implements IBlockStateWrapper
 	public boolean isBeaconTintBlock() { return this.beaconTintColor != null; }
 	@Override
 	public boolean allowsBeaconBeamPassage() { return this.allowsBeaconBeamPassage; }
+	@Override
+	public boolean allowApiColorOverride() { return this.allowApiColorOverride; }
 	
 	@Override
 	public Color getMapColor() { return this.mapColor; }
@@ -19,13 +19,17 @@

 package com.seibel.distanthorizons.common.wrappers.block;

+import com.seibel.distanthorizons.api.interfaces.block.IDhApiBlockStateWrapper;
+import com.seibel.distanthorizons.api.interfaces.world.IDhApiLevelWrapper;
+import com.seibel.distanthorizons.api.methods.events.abstractEvents.DhApiBlockColorOverrideEvent;
 import com.seibel.distanthorizons.common.wrappers.McObjectConverter;
 import com.seibel.distanthorizons.core.dataObjects.fullData.sources.FullDataSourceV2;
 import com.seibel.distanthorizons.core.logging.DhLoggerBuilder;
 import com.seibel.distanthorizons.core.pos.blockPos.DhBlockPos;
 import com.seibel.distanthorizons.core.pos.blockPos.DhBlockPosMutable;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import com.seibel.distanthorizons.core.wrapperInterfaces.world.IClientLevelWrapper;
+import com.seibel.distanthorizons.coreapi.DependencyInjection.ApiEventInjector;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 import net.minecraft.core.Direction;
@@ -187,8 +191,9 @@ public class ClientBlockStateColorCache
 		};
 	
 	// these are threadlocals since AbstractDhTintGetter use local variables to handle color queries
-	private static final ThreadLocal<TintWithoutLevelOverrider> TintWithoutLevelOverrideGetter = ThreadLocal.withInitial(() -> new TintWithoutLevelOverrider());
-	private static final ThreadLocal<TintGetterOverride> TintOverrideGetter = ThreadLocal.withInitial(() -> new TintGetterOverride());
+	private static final ThreadLocal<TintWithoutLevelOverrider> TintWithoutLevelOverrideGetter = ThreadLocal.withInitial(TintWithoutLevelOverrider::new);
+	private static final ThreadLocal<TintGetterOverride> TintOverrideGetter = ThreadLocal.withInitial(TintGetterOverride::new);
+	private static final ThreadLocal<DhApiBlockColorOverrideEvent.EventParam> ColorOverrideEventParamGetter = ThreadLocal.withInitial(DhApiBlockColorOverrideEvent.EventParam::new);
 	
 	//endregion
 	
@@ -514,11 +519,9 @@ public class ClientBlockStateColorCache
 	public int getColor(BiomeWrapper biomeWrapper, FullDataSourceV2 fullDataSource, DhBlockPos blockPos)
 	{
 		// only get the tint if the block needs to be tinted
-		if (!this.needPostTinting)
+		int tintColor = AbstractDhTintGetter.INVALID_COLOR;
+		if (this.needPostTinting)
 		{
-			return this.baseColor;
-		}
-		
 			// don't try tinting blocks that don't support our method of tint getting
 			if (BROKEN_BLOCK_STATES.contains(this.blockState))
 			{
@@ -527,7 +530,6 @@ public class ClientBlockStateColorCache
 			
 			
 			// attempt to get the tint
-		int tintColor = AbstractDhTintGetter.INVALID_COLOR;
 			try
 			{
 				// try to use the fast tint getter logic first
@@ -591,7 +593,7 @@ public class ClientBlockStateColorCache
 						// only display the error once per block/biome type to reduce log spam
 						if (!BROKEN_BLOCK_STATES.contains(this.blockState))
 						{
-						LOGGER.warn("Failed to get block color for block: [" + this.blockState + "] and biome: [" + biomeWrapper + "] at pos: " + blockPos + ". Error: ["+e.getMessage() + "]. Note: future errors for this block/biome will be ignored.", e);
+							LOGGER.warn("Failed to get block color for block: [" + this.blockState + "] and biome: [" + biomeWrapper + "] at pos: " + blockPos + ". Error: [" + e.getMessage() + "]. Note: future errors for this block/biome will be ignored.", e);
 							BROKEN_BLOCK_STATES.add(this.blockState);
 						}
 					#endif
@@ -627,22 +629,42 @@ public class ClientBlockStateColorCache
 				// only display the error once per block/biome type to reduce log spam
 				if (!BROKEN_BLOCK_STATES.contains(this.blockState))
 				{
-				LOGGER.warn("Failed to get block color for block: [" + this.blockState + "] and biome: [" + biomeWrapper + "] at pos: " + blockPos + ". Error: ["+e.getMessage() + "]. Note: future errors for this block/biome will be ignored.", e);
+					LOGGER.warn("Failed to get block color for block: [" + this.blockState + "] and biome: [" + biomeWrapper + "] at pos: " + blockPos + ". Error: [" + e.getMessage() + "]. Note: future errors for this block/biome will be ignored.", e);
 					BROKEN_BLOCK_STATES.add(this.blockState);
 				}
 			}
+		}
 		
 		
-		
+		int returnColor;
 		if (tintColor != AbstractDhTintGetter.INVALID_COLOR)
 		{
-			return ColorUtil.multiplyARGBwithRGB(this.baseColor, tintColor);
+			returnColor = ColorUtil.multiplyARGBwithRGB(this.baseColor, tintColor);
 		}
 		else
 		{
 			// unable to get the tinted color, use the base color instead
-			return this.baseColor;
+			returnColor = this.baseColor;
 		}
+		
+		
+		// only fire an API event if needed
+		// (this is done to reduce GC pressure and speed up color getting)
+		if (this.blockStateWrapper.allowApiColorOverride())
+		{
+			DhApiBlockColorOverrideEvent.EventParam eventParam = ColorOverrideEventParamGetter.get();
+			eventParam.update(
+				this.clientLevelWrapper,
+				this.blockStateWrapper, returnColor,
+				blockPos.getX(), blockPos.getY(), blockPos.getZ()
+			);
+			ApiEventInjector.INSTANCE.fireAllEvents(DhApiBlockColorOverrideEvent.class, eventParam);
+			
+			// let the API user override this color
+			returnColor = eventParam.getColorAsInt();
+		}
+		
+		return returnColor;
 	}
 	
 	
@@ -25,7 +25,7 @@ import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 #if MC_VER < MC_1_17_1
 #elif MC_VER < MC_1_21_3
 #else
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import net.minecraft.client.renderer.texture.SpriteContents;
 #endif

@@ -33,7 +33,7 @@ import com.seibel.distanthorizons.core.config.Config;
 import com.seibel.distanthorizons.core.dependencyInjection.ModAccessorInjector;
 import com.seibel.distanthorizons.core.enums.EDhDirection;
 import com.seibel.distanthorizons.core.logging.DhLoggerBuilder;
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 import com.seibel.distanthorizons.core.wrapperInterfaces.misc.ILightMapWrapper;

 #if MC_VER < MC_1_17_1
@@ -48,7 +48,7 @@ import net.minecraft.world.level.chunk.status.ChunkStatus;
 #if MC_VER < MC_1_21_3
 import net.minecraft.world.phys.Vec3;
 #else
-import com.seibel.distanthorizons.core.util.ColorUtil;
+import com.seibel.distanthorizons.coreapi.util.ColorUtil;
 #endif

 #if MC_VER <= MC_1_21_10