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.

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

center_of_mass in RigidBody3D is missleading #10000

Open
Altarick opened this issue Sep 25, 2024 · 0 comments
Open

center_of_mass in RigidBody3D is missleading #10000

Altarick opened this issue Sep 25, 2024 · 0 comments
Labels

Comments

@Altarick
Copy link

Your Godot version:
4.3-stable_win64
Issue description:
The documentation for center_of_mass in RigidBody3D is a bit confusing and contradictory, an important precision should be added to avoid confusion.

The page states that center_of_mass is "The body's custom center of mass" but also that "When center_of_mass_mode is set to CENTER_OF_MASS_MODE_AUTO (default value), the center of mass is automatically computed.". However it seems that even if the center of mass is automatically computed in this case, it is not made accessible through center_of_mass

Thus the documentation should warn for this, and read something like "When center_of_mass_mode is set to CENTER_OF_MASS_MODE_AUTO (default value), the center of mass is automatically computed for internal usage, but center_of_mass will be not be set to the computed value."

At least two people fell for it :
https://www.reddit.com/r/godot/comments/1fn1ube/why_is_the_center_of_mass_being_calculated_as_000/

URL to the documentation page:
https://docs.godotengine.org/en/stable/classes/class_rigidbody3d.html#class-rigidbody3d-property-center-of-mass

If you know how to fix the issue you are reporting please
consider opening a pull request. We provide a tutorial on
using git here: https://docs.godotengine.org/en/stable/community/contributing/pr_workflow.html,
writing documentation at https://docs.godotengine.org/en/stable/community/contributing/docs_writing_guidelines.html
and contributing to the class reference here: https://docs.godotengine.org/en/stable/community/contributing/updating_the_class_reference.html

@Altarick Altarick added the bug label Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant