feat: new methods on world

Author: MichaelHillcox

Diff for: CHANGELOG.md

@@ -1,5 +1,17 @@
 # Kube Utils Changelog
 
+## [21.1.1]
+
+### Added 
+
+- `findFirstBlockTagWithinRadius` to find a block within a radius that has a specific block tag.
+- `findAnyEntitiesWithinRadius` to find any entities within a radius based on an entity type.
+- `findLivingEntitiesWithinRadius` to find living entities within a radius based on an entity type.
+
+### Deprecated
+
+- `findEntitiesWithinRadius` in favour of `findLivingEntitiesWithinRadius`
+
 ## [21.1.0]
 
 ### Changed

Diff for: docs/modules/level.md

@@ -31,8 +31,9 @@ kuLevel.spawnStructure("minecraft:structures/village_1", BlockPos.ZERO);
 This method fails softly meaning if the structure does not exist, the method will simply do nothing.
 
 ### `findEntitiesWithinRadius(entityId: EntityType, start: BlockPos, range: Number)`
+### `Deprecated: Use findLivingEntitiesWithinRadius`
 
-Find entities within a radius based on an entity type. The entity type would typically look like `minecraft:skeleton`. You can typically find modded ones from the mods Java code. 
+Find living entities within a radius based on an entity type. The entity type would typically look like `minecraft:skeleton`. You can typically find modded ones from the mods Java code. 
 
 The search radius is from and expanded cube from the start block position. This means that a range of 1 would be a 3x3 cube with the start position in the middle.
 
@@ -44,6 +45,35 @@ const entities = kuLevel.findEntitiesWithinRadius("minecraft:skeleton", BlockPos
 console.log(entities)
 ```
 
+### `findLivingEntitiesWithinRadius(entityId: EntityType, start: BlockPos, range: Number)`
+
+Find living entities within a radius based on an entity type. The entity type would typically look like `minecraft:skeleton`. You can typically find modded ones from the mods Java code.
+
+The search radius is from and expanded cube from the start block position. This means that a range of 1 would be a 3x3 cube with the start position in the middle.
+
+`@return net.minecraft.world.entity.LivingEntity[]`
+
+```javascript
+const kuLevel = new Ku.Level(...);
+const entities = kuLevel.findLivingEntitiesWithinRadius("minecraft:skeleton", BlockPos.ZERO, 4);
+console.log(entities)
+```
+
+### `findAnyEntitiesWithinRadius(entityId: EntityType, start: BlockPos, range: Number)`
+
+Find any entities within a radius based on an entity type. The entity type would typically look like `minecraft:skeleton`. You can typically find modded ones from the mods Java code.
+
+The search radius is from and expanded cube from the start block position. This means that a range of 1 would be a 3x3 cube with the start position in the middle.
+
+`@return net.minecraft.world.entity.Entity[]`
+
+```javascript
+const kuLevel = new Ku.Level(...);
+const entities = kuLevel.findAnyEntitiesWithinRadius("minecraft:display", BlockPos.ZERO, 4);
+console.log(entities)
+```
+
+
 ### `findBlockWithinRadius(blockstate: BlockState, start: BlockPos, range: Number, absolute: boolean)`
 
 Find blocks within a radius that match a given state. Depending on if the `absolute` flag is set to true will depend on if we compare the default state of the block or the absolute state of the block meaning the states **must** match.
@@ -66,6 +96,12 @@ Very much the same as `findBlockWithinRadius` but instead will find the first bl
 
 `@return BlockPos | null`
 
+### `findFirstBlockTagWithinRadius(tag: TagKey<Block>, start: BlockPos, range: number)`
+
+Very much the same as `findBlockWithinRadius` but instead of a block state we use a block tag to find the block.
+
+`@return BlockPos | null`
+
 ### `getRandomLocation(start: BlockPos, min: Number, max: Number)`
 
 Generate a random BlockPos within a min and max range.

Diff for: gradle.properties

@@ -7,7 +7,7 @@ minecraft_version=1.21.1
 neoforge_version=55
 neoforge_full_version=21.1.55
 neoforge_loader_version=4
-mod_version=0
+mod_version=1
 neo_version_range=[21.1.0-beta,)
 
 maven_group=pro.mikey.mods
@@ -18,4 +18,4 @@ mod_author=ErrorMikey/Mikey
 curseforge_id=678815
 modrinth_id=JHdL51WR
 
-kubejs_version=2101.7.0-build.131
+kubejs_version=2101.7.2-build.216

Diff for: src/main/java/pro/mikey/kubeutils/kubejs/modules/LevelKu.java

@@ -7,6 +7,7 @@
 import net.minecraft.core.registries.Registries;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.server.level.ServerLevel;
+import net.minecraft.tags.TagKey;
 import net.minecraft.util.Mth;
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.entity.LivingEntity;
@@ -23,6 +24,7 @@
 import java.util.*;
 import java.util.function.Predicate;
 
+@SuppressWarnings("unused")
 public class LevelKu {
     private static final ResourceLocation UNKNOWN = KubeUtils.id("unknown");
     private final ServerLevel level;
@@ -56,13 +58,48 @@ public void spawnStructure(String structureFile, BlockPos spawnLocation) {
      * @param range         the range to select entities within
      *
      * @return the list of entities found.
+     * @deprecated Use {@link #findLivingEntitiesWithinRadius(ResourceLocation, BlockPos, int)}
      */
+    @Deprecated
     public List<LivingEntity> findEntitiesWithinRadius(ResourceLocation entityId, BlockPos start, int range) {
+        return _findEntityInRange(LivingEntity.class, entityId, start, range)
+                .stream()
+                .map(e -> (LivingEntity) e)
+                .toList();
+    }
+
+    /**
+     * Find living entities within a radius based on an entity type
+     *
+     * @param entityId      the entity resource location (id)
+     * @param start         the starting position to build the bounding box from
+     * @param range         the range to select entities within
+     *
+     * @return the list of entities found.
+     */
+    public List<LivingEntity> findLivingEntitiesWithinRadius(ResourceLocation entityId, BlockPos start, int range) {
+        return findEntitiesWithinRadius(entityId, start, range);
+    }
+
+    /**
+     * Find any entities within a radius based on an entity type
+     *
+     * @param entityId      the entity resource location (id)
+     * @param start         the starting position to build the bounding box from
+     * @param range         the range to select entities within
+     *
+     * @return the list of entities found.
+     */
+    public List<Entity> findAnyEntitiesWithinRadius(ResourceLocation entityId, BlockPos start, int range) {
+        return _findEntityInRange(Entity.class, entityId, start, range);
+    }
+
+    private List<Entity> _findEntityInRange(Class<? extends Entity> entityClass, ResourceLocation entityId, BlockPos start, int range) {
         AABB boundingBox = new AABB(start).inflate(range);
 
-        List<LivingEntity> entities = new ArrayList<>();
+        List<Entity> entities = new ArrayList<>();
         for (Entity current : level.getEntities().getAll()) {
-            if (!(current instanceof LivingEntity)) {
+            if (!entityClass.isInstance(current)) {
                 continue;
             }
 
@@ -74,7 +111,7 @@ public List<LivingEntity> findEntitiesWithinRadius(ResourceLocation entityId, Bl
             }
 
             if (boundingBox.contains(current.position())) {
-                entities.add((LivingEntity) current);
+                entities.add(current);
             }
         }
 
@@ -131,6 +168,30 @@ public BlockPos findSingleBlockWithinRadius(BlockState block, BlockPos start, in
         return null;
     }
 
+    /**
+     * The same as {@link #findSingleBlockWithinRadius(BlockState, BlockPos, int, boolean)} but instead of a block state
+     * we use a block tag to find the block.
+     *
+     * @param blockTag the block tag we're looking for
+     * @param start the starting position
+     * @param range the radius to build from the starting position
+     *
+     * @return the position of the block found or null when nothing is found.
+     */
+    @Nullable
+    public BlockPos findFirstBlockTagWithinRadius(TagKey<Block> blockTag, BlockPos start, int range) {
+        Iterator<BlockPos> iterator = BlockPos.betweenClosedStream(new BoundingBox(start).inflatedBy(range)).iterator();
+
+        while (iterator.hasNext()) {
+            var current = iterator.next();
+            if (level.getBlockState(current).is(blockTag)) {
+                return current.immutable();
+            }
+        }
+
+        return null;
+    }
+
     /**
      * Generate a random location as a {@link BlockPos} at within two given bounds.
      *