godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #71966 from lawnjelly/occluder_portal_index_docs 

Improve error messages and classref for occluders and portals
This commit is contained in:
Rémi Verschelde 2023-01-26 13:21:52 +01:00
parent a8c829cd91 5a0cb54b3a
commit 768e998b7a
No known key found for this signature in database
GPG Key ID: C3336907360768E1
8 changed files with 28 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/classes/OccluderShapePolygon.xml
View File

@ -17,7 +17,8 @@
<argument index="0" name="index" type="int" />
<argument index="1" name="position" type="Vector2" />
<description>
Sets an individual hole point position.
Sets an individual hole point position. Primarily for use by the editor.
[b]Note:[/b] This function will not resize the hole point array. Set [member hole_points] to set the number of points.
</description>
</method>
<method name="set_polygon_point">
@ -25,7 +26,8 @@
<argument index="0" name="index" type="int" />
<argument index="1" name="position" type="Vector2" />
<description>
Sets an individual polygon point position.
Sets an individual polygon point position. Primarily for use by the editor.
[b]Note:[/b] This function will not resize the polygon point array. Set [member polygon_points] to set the number of points.
</description>
</method>
</methods>

4
doc/classes/OccluderShapeSphere.xml
View File

@ -15,7 +15,7 @@
<argument index="0" name="index" type="int" />
<argument index="1" name="position" type="Vector3" />
<description>
Sets an individual sphere's position.
Sets an individual sphere's position. Primarily for use by the editor.
</description>
</method>
<method name="set_sphere_radius">
@ -23,7 +23,7 @@
<argument index="0" name="index" type="int" />
<argument index="1" name="radius" type="float" />
<description>
Sets an individual sphere's radius.
Sets an individual sphere's radius. Primarily for use by the editor.
</description>
</method>
</methods>

1
doc/classes/Portal.xml
View File

@ -18,6 +18,7 @@
<argument index="1" name="position" type="Vector2" />
<description>
Sets individual points. Primarily for use by the editor.
[b]Note:[/b] This function will not resize the point array. Set [member points] to set the number of points.
</description>
</method>
</methods>

1
doc/classes/Room.xml
View File

@ -19,6 +19,7 @@
<argument index="1" name="position" type="Vector3" />
<description>
Sets individual points. Primarily for use by the editor.
[b]Note:[/b] This function will not resize the point array. Set [member points] to set the number of points.
</description>
</method>
</methods>

4
scene/3d/portal.cpp
View File

@ -115,9 +115,7 @@ String Portal::get_configuration_warning() const {
}
void Portal::set_point(int p_idx, const Vector2 &p_point) {
if (p_idx >= _pts_local_raw.size()) {
return;
}
ERR_FAIL_INDEX_MSG(p_idx, _pts_local_raw.size(), "Index out of bounds. Call set_points() to set the size of the array.");
_pts_local_raw.set(p_idx, p_point);
_sanitize_points();

4
scene/3d/room.cpp
View File

@ -131,9 +131,7 @@ void Room::set_use_default_simplify(bool p_use) {
}
void Room::set_point(int p_idx, const Vector3 &p_point) {
if (p_idx >= _bound_pts.size()) {
return;
}
ERR_FAIL_INDEX_MSG(p_idx, _bound_pts.size(), "Index out of bounds. Call set_points() to set the size of the array.");
_bound_pts.set(p_idx, p_point);

32
scene/resources/occluder_shape.cpp
View File

@ -210,29 +210,29 @@ void OccluderShapeSphere::set_spheres(const Vector<Plane> &p_spheres) {
}
void OccluderShapeSphere::set_sphere_position(int p_idx, const Vector3 &p_position) {
if ((p_idx >= 0) && (p_idx < _spheres.size())) {
Plane p = _spheres[p_idx];
p.normal = p_position;
_spheres.set(p_idx, p);
ERR_FAIL_INDEX(p_idx, _spheres.size());
Plane p = _spheres[p_idx];
p.normal = p_position;
_spheres.set(p_idx, p);
#ifdef TOOLS_ENABLED
_update_aabb();
_update_aabb();
#endif
update_shape_to_visual_server();
notify_change_to_owners();
}
update_shape_to_visual_server();
notify_change_to_owners();
}
void OccluderShapeSphere::set_sphere_radius(int p_idx, real_t p_radius) {
if ((p_idx >= 0) && (p_idx < _spheres.size())) {
Plane p = _spheres[p_idx];
p.d = MAX(p_radius, _min_radius);
_spheres.set(p_idx, p);
ERR_FAIL_INDEX(p_idx, _spheres.size());
Plane p = _spheres[p_idx];
p.d = MAX(p_radius, _min_radius);
_spheres.set(p_idx, p);
#ifdef TOOLS_ENABLED
_update_aabb();
_update_aabb();
#endif
update_shape_to_visual_server();
notify_change_to_owners();
}
update_shape_to_visual_server();
notify_change_to_owners();
}
OccluderShapeSphere::OccluderShapeSphere() {

8
scene/resources/occluder_shape_polygon.cpp
View File

@ -102,9 +102,7 @@ void OccluderShapePolygon::_sanitize_points() {
}
void OccluderShapePolygon::set_polygon_point(int p_idx, const Vector2 &p_point) {
if (p_idx >= _poly_pts_local_raw.size()) {
return;
}
ERR_FAIL_INDEX_MSG(p_idx, _poly_pts_local_raw.size(), "Index out of bounds. Call set_polygon_points() to set the size of the array.");
_poly_pts_local_raw.set(p_idx, p_point);
_sanitize_points();
@ -113,9 +111,7 @@ void OccluderShapePolygon::set_polygon_point(int p_idx, const Vector2 &p_point)
}
void OccluderShapePolygon::set_hole_point(int p_idx, const Vector2 &p_point) {
if (p_idx >= _hole_pts_local_raw.size()) {
return;
}
ERR_FAIL_INDEX_MSG(p_idx, _hole_pts_local_raw.size(), "Index out of bounds. Call set_hole_points() to set the size of the array.");
_hole_pts_local_raw.set(p_idx, p_point);
_sanitize_points();