Add clarification about what CharacterBody is used for #10458
Labels
area:class reference
Issues and PRs about the class reference, which should be addressed on the Godot engine repository
area:manual
Issues and PRs related to the Manual/Tutorials section of the documentation
enhancement
good first issue
topic:physics
Your Godot version:
4.3
Issue description:
I've used Godot casually for a few years, and I'm still a bit uncertain what the recommended usage of CharacterBody is. The name indicates that you should use it for characters, like the player, or enemies that move, but after reading the docs, I'm a bit confused. It seems like it's absolutely usable for stuff other than characters, considering all of the extra collision detection information it gives you, and it doesn't seem to mention that it's only for characters, but I'm still unsure of if it's recommended outside of them, since the name makes it seem like that's all it's for.
If CharacterBody is meant to be used outside of just characters, and intended for anything where you want to have more control over the physics of an object, then I think, outside of a name change, it would be helpful to clarify in the documentation, something like "Despite the name, CharacterBody can be used outside of characters, whenever you want more control over physics objects." Maybe inside one of the little blue notes, or in the main description in the reference pages.
I just feel like it would really help if it was fully clarified. Of course, I only think it should say this if it was actually intended to be used for things other than characters. If there's a better way to implement a custom physics body, then it doesn't need to mention what I said above.
URL to the documentation page (if already existing):
https://docs.godotengine.org/en/stable/tutorials/physics/physics_introduction.html#characterbody2d
https://docs.godotengine.org/en/stable/tutorials/physics/using_character_body_2d.html
https://docs.godotengine.org/en/stable/classes/class_characterbody2d.html
https://docs.godotengine.org/en/stable/classes/class_characterbody3d.html
The text was updated successfully, but these errors were encountered: