BoundingBox.kt extension 'contains(Location)' added

flytegg · Nov 4, 2023 · db63e6a · db63e6a
1 parent 406895a
commit db63e6a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -5,7 +5,7 @@ plugins {
 }
 
 group = "gg.flyte"
-version = "1.0.19"
+version = "1.0.20"
 
 repositories {
     mavenCentral()

diff --git a/src/main/kotlin/gg/flyte/twilight/extension/BoundingBox.kt b/src/main/kotlin/gg/flyte/twilight/extension/BoundingBox.kt
@@ -71,4 +71,17 @@ fun BoundingBox.getLocations(world: World): List<Location> {
     }
 
     return locations
+}
+
+/**
+ * Checks if the specified Location is within the boundaries of this BoundingBox.
+ *
+ * This extension function provides a simple way to determine if a Location is contained
+ * within the BoundingBox using its x, y, and z coordinates.
+ *
+ * @param location The Location to check for containment within this BoundingBox.
+ * @return Boolean true if the Location is within the BoundingBox; false otherwise.
+ */
+fun BoundingBox.contains(location: Location): Boolean {
+    return contains(location.x, location.y, location.z)
 }