Fix get_region_map_index() checking bounds

Author: TokisanGames

src/terrain_3d_editor.cpp

@@ -38,7 +38,8 @@ Ref<Terrain3DRegion> Terrain3DEditor::_operate_region(const Vector2i &p_region_l
 	}
 	if (storage->get_region_map_index(p_region_loc) < 0) {
 		if (can_print) {
-			LOG(ERROR, "Specified position outside of maximum bounds");
+			LOG(ERROR, "Location ", p_region_loc, " out of bounds. Max: ",
+					-Terrain3DStorage::REGION_MAP_SIZE / 2, " to ", Terrain3DStorage::REGION_MAP_SIZE / 2 - 1);
 		}
 		return Ref<Terrain3DRegion>();
 	}

src/terrain_3d_region.cpp

@@ -251,12 +251,13 @@ Error Terrain3DRegion::save(const String &p_path, const bool p_16_bit) {
 void Terrain3DRegion::set_location(const Vector2i &p_location) {
 	// In the future anywhere they want to put the location might be fine, but because of region_map
 	// We have a limitation of 16x16 and eventually 45x45.
-	if (abs(p_location.x) < Terrain3DStorage::REGION_MAP_SIZE / 2 && abs(p_location.y) < Terrain3DStorage::REGION_MAP_SIZE / 2) {
-		LOG(INFO, "Set location: ", p_location);
-		_location = p_location;
-	} else {
-		LOG(ERROR, "Location out of bounds: ", p_location);
+	if (Terrain3DStorage::get_region_map_index(p_location) < 0) {
+		LOG(ERROR, "Location ", p_location, " out of bounds. Max: ",
+				-Terrain3DStorage::REGION_MAP_SIZE / 2, " to ", Terrain3DStorage::REGION_MAP_SIZE / 2 - 1);
+		return;
 	}
+	LOG(INFO, "Set location: ", p_location);
+	_location = p_location;
 }
 
 void Terrain3DRegion::set_data(const Dictionary &p_data) {

src/terrain_3d_storage.cpp

@@ -199,8 +199,8 @@ Error Terrain3DStorage::add_region(const Ref<Terrain3DRegion> &p_region, const b
 
 	// Check bounds and slow report errors
 	if (get_region_map_index(region_loc) < 0) {
-		LOG(ERROR, "Specified position outside of maximum region map size: +/-",
-				real_t((REGION_MAP_SIZE / 2) * _region_size) * _mesh_vertex_spacing);
+		LOG(ERROR, "Location ", region_loc, " out of bounds. Max: ",
+				-REGION_MAP_SIZE / 2, " to ", REGION_MAP_SIZE / 2 - 1);
 		return FAILED;
 	}
 
@@ -992,6 +992,7 @@ void Terrain3DStorage::_bind_methods() {
 	ClassDB::bind_method(D_METHOD("get_regions_active", "copy", "deep"), &Terrain3DStorage::get_regions_active, DEFVAL(false), DEFVAL(false));
 	ClassDB::bind_method(D_METHOD("get_regions_all"), &Terrain3DStorage::get_regions_all);
 	ClassDB::bind_method(D_METHOD("get_region_map"), &Terrain3DStorage::get_region_map);
+	ClassDB::bind_static_method("Terrain3DStorage", D_METHOD("get_region_map_index"), &Terrain3DStorage::get_region_map_index);
 
 	ClassDB::bind_method(D_METHOD("has_region", "region_location"), &Terrain3DStorage::has_region);
 	ClassDB::bind_method(D_METHOD("has_regionp", "global_position"), &Terrain3DStorage::has_regionp);

src/terrain_3d_storage.h

@@ -104,7 +104,7 @@ class Terrain3DStorage : public Object {
 	TypedArray<Terrain3DRegion> get_regions_active(const bool p_copy = false, const bool p_deep = false) const;
 	Dictionary get_regions_all() const { return _regions; }
 	PackedInt32Array get_region_map() const { return _region_map; }
-	int get_region_map_index(const Vector2i &p_region_loc) const;
+	static int get_region_map_index(const Vector2i &p_region_loc);
 
 	bool has_region(const Vector2i &p_region_loc) const { return get_region_id(p_region_loc) != -1; }
 	bool has_regionp(const Vector3 &p_global_position) const { return get_region_idp(p_global_position) != -1; }
@@ -197,16 +197,18 @@ VARIANT_ENUM_CAST(Terrain3DStorage::HeightFilter);
 
 /// Inline Region Functions
 
-// This function verifies the location is within the bounds of the _region_map array and
-// thus the world. It returns the _region_map index if valid, -1 if not
-inline int Terrain3DStorage::get_region_map_index(const Vector2i &p_region_loc) const {
-	// Offset locations centered on (0,0) to positive only
-	Vector2i loc = Vector2i(p_region_loc + (REGION_MAP_VSIZE / 2));
-	int map_index = loc.y * REGION_MAP_SIZE + loc.x;
-	if (map_index < 0 || map_index >= REGION_MAP_SIZE * REGION_MAP_SIZE) {
+// Verifies the location is within the bounds of the _region_map array and
+// the world, returning the _region_map index, which contains the region_id.
+// Valid region locations are -8, -8 to 7, 7, or when offset: 0, 0 to 15, 15
+// If any bits other than 0xF are set, it's out of bounds and returns -1
+inline int Terrain3DStorage::get_region_map_index(const Vector2i &p_region_loc) {
+	// Offset world to positive values only
+	Vector2i loc = p_region_loc + (REGION_MAP_VSIZE / 2);
+	// Catch values > 15
+	if ((uint32_t(loc.x | loc.y) & uint32_t(~0xF)) > 0) {
 		return -1;
 	}
-	return map_index;
+	return loc.y * REGION_MAP_SIZE + loc.x;
 }
 
 // Returns a region location given a global position. No bounds checking nor data access.