From 1e4027ef230748bad470a432c4b5fcd0ca0efed5 Mon Sep 17 00:00:00 2001 From: quat1024 Date: Sun, 3 Sep 2023 18:53:31 -0400 Subject: [PATCH] standardize all the abi-compat comments i can find --- .../templates/model/RetexturingBakedModel.java | 13 +++++++------ .../templates/model/TemplateAppearance.java | 6 +++--- .../templates/model/TemplateAppearanceManager.java | 2 +- .../templates/model/UnbakedAutoRetexturedModel.java | 4 ++-- .../templates/model/UnbakedJsonRetexturedModel.java | 4 ++-- .../templates/model/UnbakedMeshRetexturedModel.java | 4 ++-- 6 files changed, 17 insertions(+), 16 deletions(-) diff --git a/src/main/java/io/github/cottonmc/templates/model/RetexturingBakedModel.java b/src/main/java/io/github/cottonmc/templates/model/RetexturingBakedModel.java index 79e5131..c0a7d8b 100644 --- a/src/main/java/io/github/cottonmc/templates/model/RetexturingBakedModel.java +++ b/src/main/java/io/github/cottonmc/templates/model/RetexturingBakedModel.java @@ -25,11 +25,6 @@ import java.util.concurrent.ConcurrentMap; import java.util.function.Supplier; public abstract class RetexturingBakedModel extends ForwardingBakedModel { - @Deprecated(forRemoval = true) //Kept for ABI compat. From before there was an AO boolean (<2.1.1) - public RetexturingBakedModel(BakedModel baseModel, TemplateAppearanceManager tam, ModelBakeSettings settings, BlockState itemModelState) { - this(baseModel, tam, settings, itemModelState, true); - } - public RetexturingBakedModel(BakedModel baseModel, TemplateAppearanceManager tam, ModelBakeSettings settings, BlockState itemModelState, boolean ao) { this.wrapped = baseModel; //field from the superclass; vanilla getQuads etc will delegate through to this @@ -131,7 +126,7 @@ public abstract class RetexturingBakedModel extends ForwardingBakedModel { this.ta = ta; } - @Deprecated(forRemoval = true) //Kept for ABI compat (<2.2). Use TintingTransformer for retinting, it works better anyway + @Deprecated(forRemoval = true) //TODO ABI: Deprecated in 2.2. Use TintingTransformer for retinting, it works better anyway protected RetexturingTransformer(TemplateAppearance ta, int ignoredTint) { this(ta); } @@ -173,4 +168,10 @@ public abstract class RetexturingBakedModel extends ForwardingBakedModel { return true; } } + + //TODO ABI: From before there was an AO boolean, <2.1.1. + @Deprecated(forRemoval = true) + public RetexturingBakedModel(BakedModel baseModel, TemplateAppearanceManager tam, ModelBakeSettings settings, BlockState itemModelState) { + this(baseModel, tam, settings, itemModelState, true); + } } diff --git a/src/main/java/io/github/cottonmc/templates/model/TemplateAppearance.java b/src/main/java/io/github/cottonmc/templates/model/TemplateAppearance.java index 18e2525..70550cc 100644 --- a/src/main/java/io/github/cottonmc/templates/model/TemplateAppearance.java +++ b/src/main/java/io/github/cottonmc/templates/model/TemplateAppearance.java @@ -5,20 +5,20 @@ import net.minecraft.client.texture.Sprite; import net.minecraft.util.math.Direction; import org.jetbrains.annotations.NotNull; -//TODO: move to the api package +//TODO ABI: move to the api package public interface TemplateAppearance { @NotNull RenderMaterial getRenderMaterial(boolean ao); @NotNull Sprite getSprite(Direction dir); int getBakeFlags(Direction dir); boolean hasColor(Direction dir); - //binary-compat - from before conditional model AO was added + //TODO ABI: Dates from before conditional model AO was added. @Deprecated(forRemoval = true) default @NotNull RenderMaterial getRenderMaterial() { return getRenderMaterial(false); } - //binary-compat - I never ended up implementing this, it's much easier to modify particles via the BlockState + //TODO ABI: Deprecated in 2.2. I never ended up implementing this, it's much easier to modify particles via the BlockState @Deprecated(forRemoval = true) default @NotNull Sprite getParticleSprite() { return getSprite(Direction.NORTH); diff --git a/src/main/java/io/github/cottonmc/templates/model/TemplateAppearanceManager.java b/src/main/java/io/github/cottonmc/templates/model/TemplateAppearanceManager.java index 3ab382a..8e295fb 100644 --- a/src/main/java/io/github/cottonmc/templates/model/TemplateAppearanceManager.java +++ b/src/main/java/io/github/cottonmc/templates/model/TemplateAppearanceManager.java @@ -51,7 +51,7 @@ public class TemplateAppearanceManager { this.barrierItemAppearance = new SingleSpriteAppearance(barrier, materialsWithoutAo.get(BlendMode.CUTOUT), serialNumber.getAndIncrement()); } - //TODO ABI: Shouldn't have been made public. Clean up at a later point. + //TODO ABI: Shouldn't have been made public. Noticed this in 2.2. @ApiStatus.Internal public static final SpriteIdentifier DEFAULT_SPRITE_ID = new SpriteIdentifier(PlayerScreenHandler.BLOCK_ATLAS_TEXTURE, new Identifier("minecraft:block/scaffolding_top")); private static final SpriteIdentifier BARRIER_SPRITE_ID = new SpriteIdentifier(PlayerScreenHandler.BLOCK_ATLAS_TEXTURE, new Identifier("minecraft:item/barrier")); diff --git a/src/main/java/io/github/cottonmc/templates/model/UnbakedAutoRetexturedModel.java b/src/main/java/io/github/cottonmc/templates/model/UnbakedAutoRetexturedModel.java index 277b4de..682902b 100644 --- a/src/main/java/io/github/cottonmc/templates/model/UnbakedAutoRetexturedModel.java +++ b/src/main/java/io/github/cottonmc/templates/model/UnbakedAutoRetexturedModel.java @@ -101,8 +101,8 @@ public class UnbakedAutoRetexturedModel implements UnbakedModel, TemplatesClient }; } - //ABI compat. - @Deprecated(forRemoval = true) //2.2 - use TemplatesClientApi.getInstance().auto, and use the builder to set this field + //TODO ABI: (2.2) use TemplatesClientApi.getInstance.auto, and use the builder properties to set this field + @Deprecated(forRemoval = true) public UnbakedAutoRetexturedModel(Identifier parent, BlockState itemModelState) { this(parent); itemModelState(itemModelState); diff --git a/src/main/java/io/github/cottonmc/templates/model/UnbakedJsonRetexturedModel.java b/src/main/java/io/github/cottonmc/templates/model/UnbakedJsonRetexturedModel.java index 9b42e44..8d9e6b2 100644 --- a/src/main/java/io/github/cottonmc/templates/model/UnbakedJsonRetexturedModel.java +++ b/src/main/java/io/github/cottonmc/templates/model/UnbakedJsonRetexturedModel.java @@ -119,8 +119,8 @@ public class UnbakedJsonRetexturedModel implements UnbakedModel, TemplatesClient }; } - //ABI compat - @Deprecated(forRemoval = true) //2.2 - use TemplatesClientApi.getInstance().json, and use the builder to set this field + //TODO ABI: (2.2) use TemplatesClientApi.getInstance.json, and use the builder properties to set this field + @Deprecated(forRemoval = true) public UnbakedJsonRetexturedModel(Identifier parent, BlockState itemModelState) { this(parent); itemModelState(itemModelState); diff --git a/src/main/java/io/github/cottonmc/templates/model/UnbakedMeshRetexturedModel.java b/src/main/java/io/github/cottonmc/templates/model/UnbakedMeshRetexturedModel.java index 6dd0693..02f5fd7 100644 --- a/src/main/java/io/github/cottonmc/templates/model/UnbakedMeshRetexturedModel.java +++ b/src/main/java/io/github/cottonmc/templates/model/UnbakedMeshRetexturedModel.java @@ -70,8 +70,8 @@ public class UnbakedMeshRetexturedModel implements UnbakedModel, TemplatesClient }; } - //ABI compat - @Deprecated(forRemoval = true) //2.2 - use TemplatesClientApi.getInstance().mesh + //TODO ABI: (2.2) use TemplatesClientApi.getInstance.mesh + @Deprecated(forRemoval = true) public UnbakedMeshRetexturedModel(Identifier parent, Supplier baseMeshFactory) { this(parent, __ -> baseMeshFactory.get()); }