Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Raise configuration warning when PhysicsBody/2D is scaled #35614

Closed
wants to merge 1 commit into from
Closed

WIP: Raise configuration warning when PhysicsBody/2D is scaled #35614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions scene/2d/physics_body_2d.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -944,6 +944,14 @@ String RigidBody2D::get_configuration_warning() const {

String warning = CollisionObject2D::get_configuration_warning();

// Remove this if GH-5734 is fixed.
if (!get_scale().is_equal_approx(Vector2(1.0, 1.0))) {
if (warning != String()) {
warning += "\n\n";
}
warning += TTR("Scaling RigidBody2D is not supported by the physics engine and will lead to undefined behavior.\nYou may scale its parent node or sprite, but the RigidBody2D and its collision shape or polygon should have a scale of Vector2(1.0, 1.0).\nThis design limitation may be lifted in a future release.");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the current state, this could say:
"Scaling RigidBody2D is not supported by the physics engine and will lead to undefined behavior.\nYou may scale its collision shape, polygon or sprite, but the RigidBody2D should have a scale of Vector2(1.0, 1.0).\nThis design limitation may be lifted in a future release."

}

if ((get_mode() == MODE_RIGID || get_mode() == MODE_CHARACTER) && (ABS(t.elements[0].length() - 1.0) > 0.05 || ABS(t.elements[1].length() - 1.0) > 0.05)) {
if (warning != String()) {
warning += "\n\n";
Expand Down
8 changes: 8 additions & 0 deletions scene/3d/physics_body.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -915,6 +915,14 @@ String RigidBody::get_configuration_warning() const {

String warning = CollisionObject::get_configuration_warning();

// Remove this if GH-5734 is fixed.
if (!get_scale().is_equal_approx(Vector3(1.0, 1.0, 1.0))) {
if (warning != String()) {
warning += "\n\n";
}
warning += TTR("Scaling RigidBody is not supported by the physics engine and will lead to undefined behavior.\nYou may scale their parent node or mesh, but the RigidBody and its collision shape or polygon should have a scale of Vector3(1.0, 1.0, 1.0).\nThis design limitation may be lifted in a future release.");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the scaling limitation for collision polygons/shapes was actually lifted in 3.0, but I prefer to err on the side of caution and discourage scaling shapes. It's much better to scale the parent, or the mesh.

}

if ((get_mode() == MODE_RIGID || get_mode() == MODE_CHARACTER) && (ABS(t.basis.get_axis(0).length() - 1.0) > 0.05 || ABS(t.basis.get_axis(1).length() - 1.0) > 0.05 || ABS(t.basis.get_axis(2).length() - 1.0) > 0.05)) {
if (warning != String()) {
warning += "\n\n";
Expand Down