Altarik/ReFramed
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

standardize all the abi-compat comments i can find

Browse Source
This commit is contained in:
quat1024 2023-09-03 18:53:31 -04:00
parent c8d64c460f
commit 1e4027ef23
6 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/main/java/io/github/cottonmc/templates/model/RetexturingBakedModel.java
View File

@ -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);
}
}

6
src/main/java/io/github/cottonmc/templates/model/TemplateAppearance.java
View File

@ -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);

2
src/main/java/io/github/cottonmc/templates/model/TemplateAppearanceManager.java
View File

@ -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"));

4
src/main/java/io/github/cottonmc/templates/model/UnbakedAutoRetexturedModel.java
View File

@ -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);

4
src/main/java/io/github/cottonmc/templates/model/UnbakedJsonRetexturedModel.java
View File

@ -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);

4
src/main/java/io/github/cottonmc/templates/model/UnbakedMeshRetexturedModel.java
View File

@ -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<Mesh> baseMeshFactory) {
this(parent, __ -> baseMeshFactory.get());
}