Spray can refactor and creative spray can

src/main/java/gregtech/api/block/machines/BlockMachine.java

@@ -19,7 +19,7 @@
 import gregtech.api.util.Mods;
 import gregtech.client.renderer.handler.MetaTileEntityRenderer;
 import gregtech.common.creativetab.GTCreativeTabs;
-import gregtech.common.items.MetaItems;
+import gregtech.common.items.behaviors.spray.AbstractSprayBehavior;
 import gregtech.integration.ctm.IFacadeWrapper;
 
 import net.minecraft.block.Block;
@@ -257,9 +257,10 @@ public EnumFacing[] getValidRotations(@NotNull World world, @NotNull BlockPos po
     public boolean recolorBlock(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing side,
                                 @NotNull EnumDyeColor color) {
         MetaTileEntity metaTileEntity = getMetaTileEntity(world, pos);
-        if (metaTileEntity == null || metaTileEntity.getPaintingColor() == color.colorValue)
+        if (metaTileEntity == null || metaTileEntity.getPaintingColor() == color.colorValue) {
             return false;
-        metaTileEntity.setPaintingColor(color.colorValue);
+        }
+        metaTileEntity.setPaintingColor(color.colorValue, side);
         return true;
     }
 
@@ -326,15 +327,8 @@ public void onBlockPlacedBy(World worldIn, @NotNull BlockPos pos, @NotNull IBloc
         }
 
         // Color machines on place if holding spray can in off-hand
-        if (placer instanceof EntityPlayer) {
-            ItemStack offhand = placer.getHeldItemOffhand();
-            for (int i = 0; i < EnumDyeColor.values().length; i++) {
-                if (offhand.isItemEqual(MetaItems.SPRAY_CAN_DYES[i].getStackForm())) {
-                    MetaItems.SPRAY_CAN_DYES[i].getBehaviours().get(0).onItemUse((EntityPlayer) placer, worldIn,
-                            pos, EnumHand.OFF_HAND, EnumFacing.UP, 0, 0, 0);
-                    break;
-                }
-            }
+        if (placer instanceof EntityPlayer player) {
+            AbstractSprayBehavior.handleExternalSpray(player, EnumHand.OFF_HAND, worldIn, pos, EnumFacing.UP);
         }
 
         metaTileEntity.onPlacement(placer);

src/main/java/gregtech/api/color/ColorMode.java

@@ -0,0 +1,39 @@
+package gregtech.api.color;
+
+import net.minecraft.item.EnumDyeColor;
+
+public enum ColorMode {
+
+    /**
+     * Only try spraying a block to an {@link EnumDyeColor}.
+     */
+    DYE(true, false),
+    /**
+     * Only try spraying a block to an ARGB value.
+     */
+    ARGB(false, true),
+    /**
+     * Try spraying the block to an {@link EnumDyeColor}, and if that failed fall back to ARGB.
+     */
+    PREFER_DYE(true, true),
+    /**
+     * Try spraying the block to an ARGB value, and if that failed fall back to {@link EnumDyeColor}.
+     */
+    PREFER_ARGB(true, true);
+
+    private final boolean dye;
+    private final boolean argb;
+
+    ColorMode(boolean dye, boolean argb) {
+        this.dye = dye;
+        this.argb = argb;
+    }
+
+    public boolean dye() {
+        return dye;
+    }
+
+    public boolean argb() {
+        return argb;
+    }
+}

src/main/java/gregtech/api/color/ColorModeSupport.java

@@ -0,0 +1,51 @@
+package gregtech.api.color;
+
+import net.minecraft.item.EnumDyeColor;
+import net.minecraft.util.text.ITextComponent;
+import net.minecraft.util.text.TextComponentTranslation;
+
+import com.cleanroommc.modularui.api.drawable.IKey;
+import org.jetbrains.annotations.NotNull;
+
+public enum ColorModeSupport {
+
+    /**
+     * This block only supports being colored to an {@link EnumDyeColor}.
+     */
+    DYE_ONLY("gregtech.color_mode.error.argb"),
+    /**
+     * This block only supports being colored to an ARGB value.
+     */
+    ARGB_ONLY("gregtech.color_mode.error.dye"),
+    /**
+     * This block supports being colored to a {@link EnumDyeColor} or ARGB value.
+     */
+    EITHER("gregtech.color_mode.error.either");
+
+    @NotNull
+    private final String errorKey;
+
+    ColorModeSupport(@NotNull String errorKey) {
+        this.errorKey = errorKey;
+    }
+
+    public @NotNull String getErrorTranslationKey() {
+        return errorKey;
+    }
+
+    public @NotNull IKey getErrorKey() {
+        return IKey.lang(errorKey);
+    }
+
+    public @NotNull ITextComponent getErrorText() {
+        return new TextComponentTranslation(errorKey);
+    }
+
+    public boolean supportsMode(@NotNull ColorMode colorMode) {
+        return switch (this) {
+            case DYE_ONLY -> colorMode.dye();
+            case ARGB_ONLY -> colorMode.argb();
+            case EITHER -> true;
+        };
+    }
+}

src/main/java/gregtech/api/color/ColoredBlockContainer.java

@@ -0,0 +1,124 @@
+package gregtech.api.color;
+
+import gregtech.api.color.containers.AE2ColorContainer;
+import gregtech.api.color.containers.BedColorContainer;
+import gregtech.api.color.containers.GTPipeColorContainer;
+import gregtech.api.color.containers.MTEColorContainer;
+import gregtech.api.color.containers.VanillaColorContainer;
+import gregtech.api.util.GTUtility;
+import gregtech.api.util.Mods;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.EnumDyeColor;
+import net.minecraft.util.EnumActionResult;
+import net.minecraft.util.EnumFacing;
+import net.minecraft.util.ResourceLocation;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.world.World;
+
+import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap;
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.Map;
+import java.util.Objects;
+
+/**
+ * Used to provide a consistent interface for dealing with colored blocks, whether vanilla or modded. <br/>
+ * Inspired by GT5u's <a href=
+ * "https://github.com/GTNewHorizons/GT5-Unofficial/blob/7ba0fc903e5d14928d2b894b00a7b7dfc65eee18/src/main/java/gregtech/api/util/ColoredBlockContainer.java">ColoredBlockContainer</a>
+ */
+public abstract class ColoredBlockContainer {
+
+    @NotNull
+    private static final Map<ResourceLocation, ColoredBlockContainer> CONTAINERS = new Object2ObjectOpenHashMap<>(5);
+
+    public static void registerContainer(@NotNull ColoredBlockContainer container) {
+        Objects.requireNonNull(container, "A null ColoredBlockContainer cannot be registered!");
+        ResourceLocation id = container.id;
+        Objects.requireNonNull(id, "A ColoredBlockContainer cannot have a null ID!");
+        if (CONTAINERS.containsKey(id)) {
+            throw new IllegalArgumentException(
+                    String.format("A ColoredBlockContainer with an ID of %s already exists!", id));
+        }
+
+        CONTAINERS.put(id, container);
+    }
+
+    /**
+     * Get the color container for the block or tile entity at the provided position. <br/>
+     * Will return {@code null} if no container was valid.
+     */
+    public static @Nullable ColoredBlockContainer getContainer(@NotNull World world, @NotNull BlockPos pos,
+                                                               @NotNull EnumFacing facing,
+                                                               @NotNull EntityPlayer player) {
+        for (ColoredBlockContainer container : CONTAINERS.values()) {
+            if (container.isBlockValid(world, pos, facing, player)) {
+                return container;
+            }
+        }
+
+        return null;
+    }
+
+    @ApiStatus.Internal
+    public static void registerCEuContainers() {
+        registerContainer(new GTPipeColorContainer(GTUtility.gregtechId("pipe")));
+        registerContainer(new MTEColorContainer(GTUtility.gregtechId("mte")));
+        if (Mods.AppliedEnergistics2.isModLoaded()) {
+            registerContainer(new AE2ColorContainer(GTUtility.gregtechId("ae2")));
+        }
+        registerContainer(new VanillaColorContainer(GTUtility.gregtechId("vanilla")));
+        registerContainer(new BedColorContainer(GTUtility.gregtechId("bed")));
+    }
+
+    @NotNull
+    protected final ResourceLocation id;
+
+    public ColoredBlockContainer(@NotNull ResourceLocation id) {
+        this.id = id;
+    }
+
+    public abstract boolean isBlockValid(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                         @NotNull EntityPlayer player);
+
+    public @NotNull EnumActionResult setColor(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                              @NotNull EntityPlayer player, @Nullable EnumDyeColor newColor) {
+        return EnumActionResult.PASS;
+    }
+
+    public @NotNull EnumActionResult setColor(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                              @NotNull EntityPlayer player, int newColor) {
+        return EnumActionResult.PASS;
+    }
+
+    public @NotNull EnumActionResult removeColor(@NotNull World world, @NotNull BlockPos pos,
+                                                 @NotNull EnumFacing facing,
+                                                 @NotNull EntityPlayer player) {
+        return EnumActionResult.PASS;
+    }
+
+    public @Nullable EnumDyeColor getColor(@NotNull World world, @NotNull BlockPos pos,
+                                           @NotNull EnumFacing facing, @NotNull EntityPlayer player) {
+        return null;
+    }
+
+    public int getColorInt(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                           @NotNull EntityPlayer player) {
+        EnumDyeColor dyeColor = getColor(world, pos, facing, player);
+        return dyeColor == null ? -1 : dyeColor.colorValue;
+    }
+
+    public boolean colorMatches(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                @NotNull EntityPlayer player, @Nullable EnumDyeColor color) {
+        return getColor(world, pos, facing, player) == color;
+    }
+
+    public boolean colorMatches(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                @NotNull EntityPlayer player, int color) {
+        return getColorInt(world, pos, facing, player) == color;
+    }
+
+    public abstract @NotNull ColorModeSupport getSupportedColorMode();
+}

src/main/java/gregtech/api/color/containers/AE2ColorContainer.java

@@ -0,0 +1,82 @@
+package gregtech.api.color.containers;
+
+import gregtech.api.color.ColorModeSupport;
+import gregtech.api.color.ColoredBlockContainer;
+
+import net.minecraft.entity.player.EntityPlayer;
+import net.minecraft.item.EnumDyeColor;
+import net.minecraft.tileentity.TileEntity;
+import net.minecraft.util.EnumActionResult;
+import net.minecraft.util.EnumFacing;
+import net.minecraft.util.ResourceLocation;
+import net.minecraft.util.math.BlockPos;
+import net.minecraft.world.World;
+
+import appeng.api.implementations.tiles.IColorableTile;
+import appeng.api.util.AEColor;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+public class AE2ColorContainer extends ColoredBlockContainer {
+
+    public AE2ColorContainer(@NotNull ResourceLocation id) {
+        super(id);
+    }
+
+    @Override
+    public @NotNull EnumActionResult setColor(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                              @NotNull EntityPlayer player, @Nullable EnumDyeColor newColor) {
+        if (newColor == null) {
+            return removeColor(world, pos, facing, player);
+        }
+
+        if (colorMatches(world, pos, facing, player, newColor)) {
+            return EnumActionResult.PASS;
+        }
+
+        TileEntity te = world.getTileEntity(pos);
+        if (te instanceof IColorableTile colorableTile) {
+            if (colorableTile.getColor().dye != newColor) {
+                return colorableTile.recolourBlock(facing, AEColor.values()[newColor.ordinal()], player) ?
+                        EnumActionResult.SUCCESS : EnumActionResult.FAIL;
+            }
+        }
+
+        return EnumActionResult.PASS;
+    }
+
+    @Override
+    public @NotNull EnumActionResult removeColor(@NotNull World world, @NotNull BlockPos pos,
+                                                 @NotNull EnumFacing facing,
+                                                 @NotNull EntityPlayer player) {
+        TileEntity te = world.getTileEntity(pos);
+        if (te instanceof IColorableTile colorableTile && colorableTile.getColor() != AEColor.TRANSPARENT) {
+            return colorableTile.recolourBlock(facing, AEColor.TRANSPARENT, player) ? EnumActionResult.SUCCESS :
+                    EnumActionResult.PASS;
+        }
+
+        return EnumActionResult.PASS;
+    }
+
+    @Override
+    public @Nullable EnumDyeColor getColor(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                           @NotNull EntityPlayer player) {
+        TileEntity te = world.getTileEntity(pos);
+        if (te instanceof IColorableTile colorableTile) {
+            return colorableTile.getColor().dye;
+        }
+
+        return null;
+    }
+
+    @Override
+    public boolean isBlockValid(@NotNull World world, @NotNull BlockPos pos, @NotNull EnumFacing facing,
+                                @NotNull EntityPlayer player) {
+        return world.getTileEntity(pos) instanceof IColorableTile;
+    }
+
+    @Override
+    public @NotNull ColorModeSupport getSupportedColorMode() {
+        return ColorModeSupport.DYE_ONLY;
+    }
+}