search

godotengine / godot-docs

Godot Engine official documentation
https://docs.godotengine.org
Other
3.91k stars 3.2k forks source link

RigidBody's add_torque explanation is ambiguous #5349

Open aXu-AP opened 2 years ago

aXu-AP commented 2 years ago

3.3.4

After reading RigidBody add_torque's documentation I was at loss how to use this function. It should include information of what direction the torque is added. Current:

Adds a constant rotational force (i.e. a motor) without affecting position.

Suggestion:

Adds a constant rotational force without affecting position. The rotation is clockwise around the torque vector passed. Uses the rotation of the global coordinate system.

https://docs.godotengine.org/en/stable/classes/class_rigidbody.html#class-rigidbody-method-add-torque

aXu-AP commented 2 years ago

Now that I think about it, actually problem might not be in documentation, but in the function arguments itself. Wouldn't be more clear and consistent if arguments were axis : Vector3, force : float much like in Node3D's rotate function?