test: characterize custom Java tile traits

This commit is contained in:
Algent committed 2026-09-08 23:15:37 +02:00
1 parent f40a9bf90b
commit d98e48ff03
6 files changed
+142

No files matched your search

@@ -0,0 +1,28 @@
package codechicken.multipart.examples;
import codechicken.multipart.TMultiPart;
import codechicken.multipart.TileMultipart;
/** Register by name before loading this Java class; FMP transforms it into a runtime trait interface. */
public abstract class CustomTileTrait extends TileMultipart implements CustomTileTraitCapability {
@Override
public int totalContribution() {
return CustomTileTraitAccess.totalContribution(this);
}
}
final class CustomTileTraitAccess {
private CustomTileTraitAccess() {}
static int totalContribution(Object trait) {
int total = 0;
for (TMultiPart part : ((TileMultipart) trait).jPartList()) {
if (part instanceof CustomTileTraitPart) {
total += ((CustomTileTraitPart) part).tileContribution();
}
}
return total;
}
}
@@ -0,0 +1,7 @@
package codechicken.multipart.examples;
/** Stable consumer-facing API implemented by generated tiles carrying {@link CustomTileTraitPart} parts. */
public interface CustomTileTraitCapability {
int totalContribution();
}
@@ -0,0 +1,22 @@
package codechicken.multipart.examples;
import codechicken.multipart.MultipartGenerator;
import codechicken.multipart.TileMultipart;
/** Compiling registration and access example for a consumer-owned generated tile trait. */
public final class CustomTileTraitExample {
private static final String TRAIT = "codechicken.multipart.examples.CustomTileTrait";
private CustomTileTraitExample() {}
/** Call once during mod initialization, before FMP inspects any implementing part class. */
public static void register() {
MultipartGenerator.registerTrait(CustomTileTraitPart.class.getName(), TRAIT);
}
/** Read through the stable capability interface; tiles without the custom trait contribute zero. */
public static int totalContribution(TileMultipart tile) {
return tile instanceof CustomTileTraitCapability ? ((CustomTileTraitCapability) tile).totalContribution() : 0;
}
}
@@ -0,0 +1,7 @@
package codechicken.multipart.examples;
/** Marker and contribution contract for parts that request the example generated tile trait. */
public interface CustomTileTraitPart {
int tileContribution();
}
@@ -0,0 +1,76 @@
package codechicken.multipart.test;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertSame;
import static org.junit.jupiter.api.Assertions.assertTrue;
import java.util.Arrays;
import java.util.List;
import org.junit.jupiter.api.Test;
import codechicken.multipart.MultipartGenerator;
import codechicken.multipart.TMultiPart;
import codechicken.multipart.TileMultipart;
import codechicken.multipart.TileMultipartClient;
import codechicken.multipart.examples.CustomTileTraitCapability;
import codechicken.multipart.examples.CustomTileTraitExample;
import codechicken.multipart.examples.CustomTileTraitPart;
class CustomTileTraitFunctionalTest {
@Test
void registeredJavaTraitIsSelectedOnBothSidesAndExposesItsStableCapability() {
for (boolean client : new boolean[] { false, true }) {
ContributingPart first = new ContributingPart(4);
ContributingPart second = new ContributingPart(7);
List<TMultiPart> parts = Arrays.asList(first, new PlainPart(), second);
TileMultipart tile = MultipartGenerator.generateCompositeTile(null, parts, client);
assertEquals(client, tile instanceof TileMultipartClient);
assertTrue(tile instanceof CustomTileTraitCapability);
assertEquals(0, CustomTileTraitExample.totalContribution(tile), "Generation does not load parts");
tile.loadPartList(parts);
assertEquals(11, CustomTileTraitExample.totalContribution(tile));
assertEquals(1, first.calls);
assertEquals(1, second.calls);
assertSame(tile, first.tile());
assertSame(tile, second.tile());
assertSame(tile, MultipartGenerator.generateCompositeTile(tile, parts, client));
assertSame(
tile.getClass(),
MultipartGenerator.generateCompositeTile(null, Arrays.asList(new ContributingPart(1)), client)
.getClass());
}
assertFalse(new TileMultipart() instanceof CustomTileTraitCapability);
assertEquals(0, CustomTileTraitExample.totalContribution(new TileMultipart()));
assertEquals(0, CustomTileTraitExample.totalContribution(null));
}
private static class PlainPart extends TMultiPart {
@Override
public String getType() {
return "custom_tile_trait:plain";
}
}
private static final class ContributingPart extends PlainPart implements CustomTileTraitPart {
private final int contribution;
private int calls;
private ContributingPart(int contribution) {
this.contribution = contribution;
}
@Override
public int tileContribution() {
calls++;
return contribution;
}
}
}
@@ -24,6 +24,7 @@ import org.junit.platform.reporting.legacy.xml.LegacyXmlReportGeneratingListener
import codechicken.microblock.MicroblockGenerator;
import codechicken.multipart.MultipartGenerator;
import codechicken.multipart.examples.BlockConversionExample;
import codechicken.multipart.examples.CustomTileTraitExample;
import codechicken.multipart.examples.IlluminatedMicroblockExample;
import cpw.mods.fml.common.Mod;
import cpw.mods.fml.common.event.FMLInitializationEvent;
@@ -60,6 +61,7 @@ public final class ForgeMultipartFunctionalTestMod {
public void init(FMLInitializationEvent event) {
PartRegistrationFunctionalTest.registerDuringInit();
MultipartGenerator.registerPassThroughInterface(GeneratorPassThroughFixture.class.getName(), false, true);
CustomTileTraitExample.register();
externalScalaMicroblockTraitId = MicroblockGenerator
.registerTrait("codechicken.multipart.test.ExternalScalaMicroblockFixture");
IlluminatedMicroblockExample.registerMaterials(illuminatedLamp);