Skip to content

refactor entity converter #745

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2025
Merged

refactor entity converter #745

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5072193
refactor entity convertion in LuaConverter
zyxkad Jun 7, 2025
2e49ba9
small fixes
zyxkad Jun 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ import net.darkhax.curseforgegradle.TaskPublishCurseForge
import java.text.SimpleDateFormat

plugins {
id "maven-publish"
id 'checkstyle'
id 'com.github.breadmoirai.github-release' version '2.5.2'
id 'com.modrinth.minotaur' version '2.+'
id 'java'
id 'maven-publish'
id 'net.darkhax.curseforgegradle' version '1.1.16'
id 'org.jetbrains.changelog' version '1.2.1'
id "com.modrinth.minotaur" version "2.+"
id "org.jetbrains.kotlin.jvm" version "1.6.10"
id 'net.minecraftforge.gradle' version '[6.0.18,6.2)'
id 'org.jetbrains.changelog' version '1.2.1'
id 'org.jetbrains.kotlin.jvm' version '1.6.10'
id 'org.parchmentmc.librarian.forgegradle' version '1.+'
id 'org.spongepowered.mixin' version '0.7.+'
id "com.github.breadmoirai.github-release" version "2.5.2"
id 'checkstyle'
id 'java'
}

java {
Expand Down
2 changes: 1 addition & 1 deletion ...dperipherals/common/addons/computercraft/peripheral/plugins/AutomataEntityHandPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ public final MethodResult inspectAnimal(@NotNull IArguments arguments) throws Lu
if (!(entity instanceof Animal animal))
return MethodResult.of(null, "Well, entity is not animal entity, but how?");

return MethodResult.of(LuaConverter.animalToLua(animal, owner.getToolInMainHand(), true));
return MethodResult.of(LuaConverter.completeEntityToLua(animal, owner.getToolInMainHand(), true));
}

@LuaFunction(mainThread = true)
Expand Down
170 changes: 101 additions & 69 deletions src/main/java/de/srendi/advancedperipherals/common/util/LuaConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
import net.minecraft.world.level.block.state.properties.Property;
import net.minecraft.world.level.material.Fluid;
import net.minecraft.world.phys.Vec3;
import net.minecraft.world.scores.Team;
import net.minecraftforge.common.IForgeShearable;
import net.minecraftforge.fluids.FluidStack;
import net.minecraftforge.fluids.FluidType;
Expand All @@ -45,75 +46,87 @@
public class LuaConverter {

private static final CompoundTag EMPTY_TAG = new CompoundTag();
private static final Map<Class<? extends Entity>, List<EntityConverter<?>>> ENTITY_CONVERTERS = new HashMap<>();

public static Map<String, Object> entityToLua(Entity entity) {
Map<String, Object> data = new HashMap<>();
data.put("id", entity.getId());
data.put("uuid", entity.getStringUUID());
if (entity.hasCustomName())
data.put("customName", entity.getCustomName().getString());
EntityType<?> type = entity.getType();
data.put("displayName", type.getDescription().getString());
data.put("name", type.builtInRegistryHolder().key().location().toString());
data.put("type", type.getDescriptionId());
data.put("category", type.getCategory());
data.put("canBurn", entity.fireImmune());
data.put("canFreeze", entity.canFreeze());
data.put("isGlowing", entity.isCurrentlyGlowing());
data.put("isUnderWater", entity.isUnderWater());
data.put("isInLava", entity.isInLava());
data.put("isInWall", entity.isInWall());
return data;
/**
* registerEntityConverter register a converter for a type of entity.
* If an old converter exists, it will invoke the old one first before invoke the new converter.
*
* @param clazz The entity's class
* @param converter The {@link EntityConverter}
*/
public static <T extends Entity> void registerEntityConverter(Class<T> clazz, EntityConverter<T> converter) {
ENTITY_CONVERTERS.computeIfAbsent(clazz, (k) -> new ArrayList<>(1)).add(converter);
}

public static Map<String, Object> livingEntityToLua(LivingEntity entity, boolean detailed) {
Map<String, Object> data = entityToLua(entity);
data.put("baby", entity.isBaby());
data.put("health", entity.getHealth());
data.put("maxHealth", entity.getMaxHealth());
data.put("lastDamageSource", entity.getLastDamageSource() == null ? null : entity.getLastDamageSource().toString());
if (detailed) {
Map<String, Object> effMap = new HashMap<>();
entity.getActiveEffectsMap().forEach((key, value) -> {
effMap.put(key.getDescriptionId(), effectToObject(value));
});
data.put("effects", effMap);
}
return data;
// register default entity converters
static {
registerEntityConverter(Entity.class, (entity, data, ctx) -> {
data.put("id", entity.getId());
data.put("uuid", entity.getStringUUID());
if (entity.hasCustomName())
data.put("customName", entity.getCustomName().getString());
EntityType<?> type = entity.getType();
data.put("displayName", type.getDescription().getString());
data.put("name", type.builtInRegistryHolder().key().location().toString());
if (ctx.detailed()) {
data.put("type", type.getDescriptionId());
data.put("category", type.getCategory().getName());
data.put("canBurn", entity.fireImmune());
data.put("canFreeze", entity.canFreeze());
data.put("tags", entity.getTags());
data.put("isGlowing", entity.isCurrentlyGlowing());
data.put("isUnderWater", entity.isUnderWater());
data.put("isInLava", entity.isInLava());
data.put("isInWall", entity.isInWall());
data.put("team", teamToLua(entity.getTeam()));
}
});
registerEntityConverter(LivingEntity.class, (entity, data, ctx) -> {
data.put("baby", entity.isBaby());
data.put("health", entity.getHealth());
data.put("maxHealth", entity.getMaxHealth());
if (ctx.detailed()) {
data.put("lastDamageSource", entity.getLastDamageSource() == null ? null : entity.getLastDamageSource().toString());
Map<String, Object> effMap = new HashMap<>();
entity.getActiveEffectsMap().forEach((key, value) -> {
effMap.put(key.getDescriptionId(), effectToLua(value));
});
data.put("effects", effMap);
}
});
registerEntityConverter(Mob.class, (entity, data, ctx) -> {
data.put("aggressive", entity.isAggressive());
});
registerEntityConverter(Animal.class, (entity, data, ctx) -> {
data.put("inLove", entity.isInLove());
if (ctx.detailed() && !ctx.itemInHand().isEmpty() && entity instanceof IForgeShearable shareable) {
data.put("shareable", shareable.isShearable(ctx.itemInHand(), entity.level, entity.blockPosition()));
}
});
registerEntityConverter(Player.class, (entity, data, ctx) -> {
data.put("score", entity.getScore());
data.put("luck", entity.getLuck());
Inventory inv = entity.getInventory();
data.put("handSlot", inv.selected);
if (ctx.detailed()) {
Map<Integer, Object> invMap = new HashMap<>();
for (int slot = 0; slot < inv.getContainerSize(); slot++) {
ItemStack item = inv.getItem(slot);
if (!item.isEmpty()) {
invMap.put(slot, itemStackToObject(item));
}
}
data.put("inventory", invMap);
}
});
}

public static Map<String, Object> mobToLua(Mob animal, boolean detailed) {
Map<String, Object> data = livingEntityToLua(animal, detailed);
data.put("aggressive", animal.isAggressive());
return data;
}
@FunctionalInterface
public interface EntityConverter<T extends Entity> {
void entityToMap(T entity, Map<String, Object> data, Context ctx);

public static Map<String, Object> animalToLua(Animal animal, ItemStack itemInHand, boolean detailed) {
Map<String, Object> data = mobToLua(animal, detailed);
data.put("inLove", animal.isInLove());
if (animal instanceof IForgeShearable shareable && !itemInHand.isEmpty()) {
data.put("shareable", shareable.isShearable(itemInHand, animal.level, animal.blockPosition()));
}
return data;
}

public static Map<String, Object> playerToLua(Player player, boolean detailed) {
Map<String, Object> data = livingEntityToLua(player, detailed);
data.put("score", player.getScore());
data.put("luck", player.getLuck());
Inventory inv = player.getInventory();
data.put("handSlot", inv.selected);
if (detailed) {
Map<Integer, Object> invMap = new HashMap<>();
for (int slot = 0; slot < inv.getContainerSize(); slot++) {
ItemStack item = inv.getItem(slot);
if (!item.isEmpty()) {
invMap.put(slot, itemStackToObject(item));
}
}
data.put("inventory", invMap);
}
return data;
record Context(boolean detailed, ItemStack itemInHand) {}
}

public static Map<String, Object> completeEntityToLua(Entity entity) {
Expand All @@ -129,11 +142,20 @@ public static Map<String, Object> completeEntityToLua(Entity entity, ItemStack i
}

public static Map<String, Object> completeEntityToLua(Entity entity, ItemStack itemInHand, boolean detailed) {
if (entity instanceof Player player) return playerToLua(player, detailed);
if (entity instanceof Animal animal) return animalToLua(animal, itemInHand, detailed);
if (entity instanceof Mob mob) return mobToLua(mob, detailed);
if (entity instanceof LivingEntity livingEntity) return livingEntityToLua(livingEntity, detailed);
return entityToLua(entity);
if (entity == null) {
return null;
}
EntityConverter.Context ctx = new EntityConverter.Context(detailed, itemInHand);
Map<String, Object> data = new HashMap<>();
for (Class<?> entityClass = entity.getClass(); Entity.class.isAssignableFrom(entityClass); entityClass = entityClass.getSuperclass()) {
List<EntityConverter<? extends Entity>> converters = ENTITY_CONVERTERS.get((Class<? extends Entity>) entityClass);
if (converters != null) {
for (EntityConverter<? extends Entity> converter : converters) {
((EntityConverter<Entity>) converter).entityToMap(entity, data, ctx);
}
}
}
return data;
}

public static Map<String, Object> completeEntityWithPositionToLua(Entity entity, BlockPos pos) {
Expand Down Expand Up @@ -303,14 +325,24 @@ public static BlockPos convertToBlockPos(BlockPos center, Map<?, ?> table) throw
return new BlockPos(center.getX() + relative.getX(), center.getY() + relative.getY(), center.getZ() + relative.getZ());
}

public static Object effectToObject(MobEffectInstance effect) {
public static Map<String, Object> effectToLua(MobEffectInstance effect) {
Map<String, Object> map = new HashMap<>();
map.put("name", effect.getDescriptionId());
map.put("duration", effect.getDuration());
map.put("amplifier", effect.getAmplifier());
return map;
}

public static Map<String, Object> teamToLua(Team team) {
if (team == null) {
return null;
}
Map<String, Object> map = new HashMap<>();
map.put("name", team.getName());
map.put("color", team.getColor());
return map;
}

public static Map<String, Object> shipToObject(ServerShip ship) {
return shipToObject(ship, null);
}
Expand Down