Add entity API

src/main/java/de/srendi/advancedperipherals/common/addons/computercraft/apis/EntityAPI.java

@@ -0,0 +1,116 @@
+package de.srendi.advancedperipherals.common.addons.computercraft.apis;
+
+import dan200.computercraft.api.lua.*;
+import dan200.computercraft.shared.util.NBTUtil;
+import de.srendi.advancedperipherals.common.configuration.APConfig;
+import de.srendi.advancedperipherals.common.util.EntityUtil;
+import de.srendi.advancedperipherals.common.util.LuaConverter;
+import de.srendi.advancedperipherals.common.util.Pair;
+import net.minecraft.world.entity.Entity;
+import net.minecraft.world.entity.player.Player;
+
+import java.util.UUID;
+
+public class EntityAPI {
+
+    public static final EntityAPI ENTITY_API = new EntityAPI();
+
+    @LuaFunction(mainThread = true)
+    public final Object getNBT(IArguments arguments) throws LuaException {
+        if (!APConfig.API_CONFIG.enableGetNBT.get())
+            throw new LuaException("This function is disabled in the config. Activate it or ask an admin if they can activate it.");
+
+        Pair<Entity, MethodResult> result = validateAPICall(arguments.getString(0));
+        if (result.rightPresent())
+            return result.getRight();
+        Entity entity = result.getLeft();
+
+        return NBTUtil.toLua(entity.serializeNBT());
+    }
+
+    @LuaFunction(mainThread = true)
+    public final Object getName(IArguments arguments) throws LuaException {
+        Pair<Entity, MethodResult> result = validateAPICall(arguments.getString(0));
+        if (result.rightPresent())
+            return result.getRight();
+        Entity entity = result.getLeft();
+
+        return entity.getName().getString();
+    }
+
+    @LuaFunction(mainThread = true)
+    public final Object getBoundingBox(IArguments arguments) throws LuaException {
+        if (!APConfig.API_CONFIG.enableGetBoundingBox.get())
+            throw new LuaException("This function is disabled in the config. Activate it or ask an admin if they can activate it.");
+
+        Pair<Entity, MethodResult> result = validateAPICall(arguments.getString(0));
+        if (result.rightPresent())
+            return result.getRight();
+        Entity entity = result.getLeft();
+
+        return LuaConverter.aabbToObject(entity.getBoundingBox());
+    }
+
+    @LuaFunction(mainThread = true)
+    public final Object getPos(IArguments arguments) throws LuaException {
+        if (!APConfig.API_CONFIG.enableGetPos.get())
+            throw new LuaException("This function is disabled in the config. Activate it or ask an admin if they can activate it.");
+
+        Pair<Entity, MethodResult> result = validateAPICall(arguments.getString(0));
+        if (result.rightPresent())
+            return result.getRight();
+        Entity entity = result.getLeft();
+
+        return LuaConverter.vec3ToLua(entity.position());
+    }
+
+    /**
+     * Returns entity data depending on the class of the entity. Included data is either not included in the entities
+     * NBT data, or is especially useful so is included for convenience. Because most of this data
+     * doesn't overlap with NBT, it ends up mainly being values that exist only at runtime.
+     */
+    @LuaFunction(mainThread = true)
+    public final Object getData(IArguments arguments) throws LuaException {
+        if (!APConfig.API_CONFIG.enableGetData.get())
+            throw new LuaException("This function is disabled in the config. Activate it or ask an admin if they can activate it.");
+
+        Pair<Entity, MethodResult> result = validateAPICall(arguments.getString(0));
+        if (result.rightPresent())
+            return result.getRight();
+        Entity entity = result.getLeft();
+
+        boolean detailed = arguments.count() > 1 && arguments.getBoolean(1);
+        return LuaConverter.completeEntityToLua(entity, detailed);
+    }
+
+    /**
+     * Returns persistent data added to entities by mods.
+     */
+    @LuaFunction(mainThread = true)
+    public final Object getPersistentData(IArguments arguments) throws LuaException {
+        if (!APConfig.API_CONFIG.enableGetPersistentData.get())
+            throw new LuaException("This function is disabled in the config. Activate it or ask an admin if they can activate it.");
+
+        Pair<Entity, MethodResult> result = validateAPICall(arguments.getString(0));
+        if (result.rightPresent())
+            return result.getRight();
+        Entity entity = result.getLeft();
+
+        return NBTUtil.toLua(entity.getPersistentData());
+    }
+
+    /**
+     * Returns a Pair which either contains the valid Entity from the given uuidString, or an error in the form
+     * of a MethodResult. The other value in the Pair will always be null.
+     * @param uuidString The UUID in the form of a string to get an entity from.
+     */
+    private static Pair<Entity, MethodResult> validateAPICall(String uuidString) {
+        UUID uuid = UUID.fromString(uuidString);
+        Entity entity = EntityUtil.getEntityFromUUID(uuid);
+        if (entity == null)
+            return new Pair<>(null, MethodResult.of(null, "ENTITY_DOESNT_EXIST"));
+        if (!APConfig.API_CONFIG.enablePlayerAccess.get() && entity instanceof Player)
+            return new Pair<>(null, MethodResult.of(null, "Using players in EntityAPI is disabled in the config. Activate it or ask an admin if they can activate it."));
+        return new Pair<>(entity, null);
+    }
+}

src/main/java/de/srendi/advancedperipherals/common/addons/computercraft/peripheral/EnvironmentDetectorPeripheral.java

@@ -8,14 +8,14 @@
 import dan200.computercraft.api.pocket.IPocketAccess;
 import dan200.computercraft.api.turtle.ITurtleAccess;
 import dan200.computercraft.api.turtle.TurtleSide;
+import de.srendi.advancedperipherals.common.addons.computercraft.apis.EntityAPI;
 import de.srendi.advancedperipherals.common.addons.computercraft.operations.SphereOperationContext;
 import de.srendi.advancedperipherals.common.addons.computercraft.owner.BlockEntityPeripheralOwner;
 import de.srendi.advancedperipherals.common.addons.computercraft.owner.IPeripheralOwner;
 import de.srendi.advancedperipherals.common.addons.computercraft.owner.PocketPeripheralOwner;
 import de.srendi.advancedperipherals.common.addons.computercraft.owner.TurtlePeripheralOwner;
 import de.srendi.advancedperipherals.common.blocks.base.PeripheralBlockEntity;
 import de.srendi.advancedperipherals.common.configuration.APConfig;
-import de.srendi.advancedperipherals.common.util.LuaConverter;
 import de.srendi.advancedperipherals.lib.peripherals.BasePeripheral;
 import de.srendi.advancedperipherals.lib.peripherals.IPeripheralPlugin;
 import net.minecraft.core.BlockPos;
@@ -40,6 +40,7 @@
 import java.util.*;
 import java.util.function.Function;
 
+import static de.srendi.advancedperipherals.common.addons.computercraft.apis.EntityAPI.ENTITY_API;
 import static de.srendi.advancedperipherals.common.addons.computercraft.operations.SphereOperation.SCAN_ENTITIES;
 
 public class EnvironmentDetectorPeripheral extends BasePeripheral<IPeripheralOwner> {
@@ -198,16 +199,17 @@ public final boolean isSunny() {
     @LuaFunction(mainThread = true)
     public final MethodResult scanEntities(@NotNull IComputerAccess access, @NotNull IArguments arguments) throws LuaException {
         int radius = arguments.getInt(0);
-        boolean detailed = arguments.count() > 1 ? arguments.getBoolean(1) : false;
         return withOperation(SCAN_ENTITIES, new SphereOperationContext(radius), context -> {
             if (radius > SCAN_ENTITIES.getMaxCostRadius())
                 return MethodResult.of(null, "Radius exceeds max value");
             return null;
         }, context -> {
             BlockPos pos = owner.getPos();
             AABB box = new AABB(pos);
-            List<Map<String, Object>> entities = getLevel().getEntities((Entity) null, box.inflate(radius), entity -> entity instanceof LivingEntity && entity.isAlive()).stream().map(entity -> LuaConverter.completeEntityWithPositionToLua(entity, pos, detailed)).toList();
-            return MethodResult.of(entities);
+            List<String> entityUUIDs = getLevel().getEntities((Entity) null, box.inflate(radius), LivingEntity.class::isInstance).stream()
+                    .map(entity -> entity.getUUID().toString())
+                    .toList();
+            return MethodResult.of(entityUUIDs);
         }, null);
     }
 
@@ -243,4 +245,9 @@ public final MethodResult canSleepPlayer(String playername) {
             return MethodResult.of(canContinueSleep == Event.Result.ALLOW);
         }
     }
+
+    @LuaFunction
+    public final EntityAPI getEntityAPI() {
+        return ENTITY_API;
+    }
 }

src/main/java/de/srendi/advancedperipherals/common/addons/computercraft/peripheral/PlayerDetectorPeripheral.java

@@ -195,7 +195,7 @@ public final boolean isPlayerInRange(int range, String username) {
 
     @LuaFunction(value = {"getPlayerPos", "getPlayer"}, mainThread = true)
     public final Map<String, Object> getPlayerPos(IArguments arguments) throws LuaException {
-        if (!APConfig.PERIPHERALS_CONFIG.playerSpy.get())
+        if (!APConfig.PERIPHERALS_CONFIG.enablePlayerPosFunction.get())
             throw new LuaException("This function is disabled in the config. Activate it or ask an admin if he can activate it.");
         ResourceKey<Level> dimension = getLevel().dimension();
 
@@ -271,6 +271,19 @@ public final Map<String, Object> getPlayerPos(IArguments arguments) throws LuaEx
         return info;
     }
 
+    @LuaFunction(mainThread = true)
+    public final String getPlayerUUID(String username) throws LuaException {
+        ResourceKey<Level> dimension = getLevel().dimension();
+
+        for (Player player : getPlayers()) {
+            if (!isAllowedMultiDimensional() && player.getLevel().dimension() != dimension)
+                continue;
+            if(player.getName().getString().equals(username))
+                return player.getUUID().toString();
+        }
+        return null;
+    }
+
     private List<ServerPlayer> getPlayers() {
         return ServerLifecycleHooks.getCurrentServer().getPlayerList().getPlayers();
     }

src/main/java/de/srendi/advancedperipherals/common/addons/computercraft/peripheral/plugins/AutomataEntityHandPlugin.java

@@ -87,7 +87,9 @@ public final MethodResult searchAnimals(IArguments args) throws LuaException {
         BlockPos currentPos = owner.getPos();
         AABB box = new AABB(currentPos);
         ItemStack itemInHand = owner.getToolInMainHand();
-        List<Map<String, Object>> entities = owner.getLevel().getEntities((Entity) null, box.inflate(automataCore.getInteractionRadius()), suitableEntity).stream().map(entity -> LuaConverter.completeEntityWithPositionToLua(entity, itemInHand, currentPos, detailed)).toList();
+        List<Map<String, Object>> entities = owner.getLevel().getEntities((Entity) null, box.inflate(automataCore.getInteractionRadius()), suitableEntity).stream()
+                .map(entity -> LuaConverter.completeEntityWithRelativePositionToLua(entity, itemInHand, currentPos, detailed))
+                .toList();
         return MethodResult.of(entities);
     }
 }

src/main/java/de/srendi/advancedperipherals/common/configuration/APConfig.java

@@ -18,6 +18,7 @@ public class APConfig extends ModConfig {
     public static final PeripheralsConfig PERIPHERALS_CONFIG = new PeripheralsConfig();
     public static final MetaphysicsConfig METAPHYSICS_CONFIG = new MetaphysicsConfig();
     public static final WorldConfig WORLD_CONFIG = new WorldConfig();
+    public static final APIConfig API_CONFIG = new APIConfig();
 
     public APConfig(IAPConfig config, ModContainer container) {
         super(config.getType(), config.getConfigSpec(), container, "Advancedperipherals/" + config.getFileName() + ".toml");
@@ -32,6 +33,7 @@ public static void register(ModLoadingContext context) {
         modContainer.addConfig(new APConfig(PERIPHERALS_CONFIG, modContainer));
         modContainer.addConfig(new APConfig(METAPHYSICS_CONFIG, modContainer));
         modContainer.addConfig(new APConfig(WORLD_CONFIG, modContainer));
+        modContainer.addConfig(new APConfig(API_CONFIG, modContainer));
     }
 
     @Override

src/main/java/de/srendi/advancedperipherals/common/configuration/APIConfig.java

@@ -0,0 +1,51 @@
+package de.srendi.advancedperipherals.common.configuration;
+
+import net.minecraftforge.common.ForgeConfigSpec;
+import net.minecraftforge.fml.config.ModConfig;
+
+public class APIConfig implements IAPConfig {
+    //Entity
+    public final ForgeConfigSpec.BooleanValue enableEntityAPI;
+    public final ForgeConfigSpec.BooleanValue enableGetNBT;
+    public final ForgeConfigSpec.BooleanValue enableGetBoundingBox;
+    public final ForgeConfigSpec.BooleanValue enableGetPos;
+    public final ForgeConfigSpec.BooleanValue enableGetData;
+    public final ForgeConfigSpec.BooleanValue enableGetPersistentData;
+    public final ForgeConfigSpec.BooleanValue enablePlayerAccess;
+    private final ForgeConfigSpec configSpec;
+
+    public APIConfig() {
+        ForgeConfigSpec.Builder builder = new ForgeConfigSpec.Builder();
+
+        builder.comment("APIs config").push("APIs");
+
+        builder.push("entity");
+
+        enableEntityAPI = builder.comment("Enables the \"entity\" API").define("enableEntityAPI", true);
+        enableGetNBT = builder.comment("Activates the \"getNBT\" function of the entity API").define("enableGetNBT", true);
+        enableGetBoundingBox = builder.comment("Activates the \"getBoundingBox\" function of the entity API").define("enableGetBoundingBox", true);
+        enableGetPos = builder.comment("Activates the \"getPos\" function of the entity API").define("enableGetPos", true);
+        enableGetData = builder.comment("Activates the \"getData\" function of the entity API").define("enableGetData", true);
+        enableGetPersistentData = builder.comment("Activates the \"getPersistentData\" function of the entity API").define("enableGetPersistentData", true);
+        enablePlayerAccess = builder.comment("Allows player entities to be used with the EntityAPI.").define("enablePlayerAccess", true);
+
+        builder.pop();
+
+        configSpec = builder.build();
+    }
+
+    @Override
+    public ForgeConfigSpec getConfigSpec() {
+        return configSpec;
+    }
+
+    @Override
+    public String getFileName() {
+        return "APIs";
+    }
+
+    @Override
+    public ModConfig.Type getType() {
+        return ModConfig.Type.COMMON;
+    }
+}

src/main/java/de/srendi/advancedperipherals/common/configuration/PeripheralsConfig.java

@@ -18,7 +18,7 @@ public class PeripheralsConfig implements IAPConfig {
 
     // Player Detector
     public final ForgeConfigSpec.IntValue playerDetMaxRange;
-    public final ForgeConfigSpec.BooleanValue playerSpy;
+    public final ForgeConfigSpec.BooleanValue enablePlayerPosFunction;
     public final ForgeConfigSpec.BooleanValue morePlayerInformation;
     public final ForgeConfigSpec.BooleanValue enablePlayerDetector;
     public final ForgeConfigSpec.BooleanValue playerDetMultiDimensional;
@@ -136,7 +136,7 @@ public PeripheralsConfig() {
 
         enablePlayerDetector = builder.comment("Enable the Player Detector or not.").define("enablePlayerDetector", true);
         playerDetMaxRange = builder.comment("The max range of the player detector functions. If anyone use a higher range, the detector will use this max range. -1 for unlimited").defineInRange("playerDetMaxRange", -1, -1, Integer.MAX_VALUE);
-        playerSpy = builder.comment("Activates the \"getPlayerPos\" function of the Player Detector").define("enablePlayerPosFunction", true);
+        enablePlayerPosFunction = builder.comment("Activates the \"getPlayerPos\" function of the Player Detector").define("enablePlayerPosFunction", true);
         morePlayerInformation = builder.comment("Adds more information to `getPlayerPos` of the Player Detector. Like rotation and dimension").define("morePlayerInformation", true);
         playerDetMultiDimensional = builder.comment("If true, the player detector can observe players which aren't in the same dimension as the detector itself. `playerDetMaxRange` needs to be infinite(-1) for it to work.").define("chatBoxMultiDimensional", true);
         playerSpyRandError = builder.comment("If true, add random error to `getPlayerPos` player position that varies based on how far the player is from the detector. Prevents getting the exact position of players far from the detector.").define("enablePlayerPosRandomError", false);

src/main/java/de/srendi/advancedperipherals/common/configuration/WorldConfig.java

@@ -10,6 +10,7 @@ public class WorldConfig implements IAPConfig {
     public final ForgeConfigSpec.BooleanValue enableVillagerStructures;
     public final ForgeConfigSpec.BooleanValue givePlayerBookOnJoin;
     public final ForgeConfigSpec.IntValue villagerStructureWeight;
+    public final ForgeConfigSpec.BooleanValue enableWanderingTraderTrades;
     private final ForgeConfigSpec configSpec;
 
     public WorldConfig() {
@@ -20,6 +21,7 @@ public WorldConfig() {
         enableVillagerStructures = builder.comment("Enable the villager structures for the computer scientist.").define("enableVillagerStructures", true);
         givePlayerBookOnJoin = builder.comment("Gives the ap documentation to new players.").define("givePlayerBookOnJoin", true);
         villagerStructureWeight = builder.comment("The weight of the villager structures.").defineInRange("villagerStructureWeight", 10, 0, 16000);
+        enableWanderingTraderTrades = builder.comment("Enable new wandering trader trades.").define("enableWanderingTraderTrades", true);
 
         builder.pop();
         configSpec = builder.build();

src/main/java/de/srendi/advancedperipherals/common/util/EntityUtil.java

@@ -0,0 +1,23 @@
+package de.srendi.advancedperipherals.common.util;
+
+import net.minecraft.server.level.ServerLevel;
+import net.minecraft.world.entity.Entity;
+import net.minecraftforge.server.ServerLifecycleHooks;
+
+import java.util.UUID;
+
+public class EntityUtil {
+    /**
+     * Searches all levels for an {@link Entity} with the given {@link UUID}.
+     * @param uuid the unique identifier of the {@code Entity}
+     * @return an {@code Entity} that has the given {@code UUID} if one is found, null otherwise
+     */
+    public static Entity getEntityFromUUID(UUID uuid) {
+        for (ServerLevel level : ServerLifecycleHooks.getCurrentServer().getAllLevels()) {
+            Entity entity = level.getEntity(uuid);
+            if (entity != null)
+                return entity;
+        }
+        return null;
+    }
+}