Improved description of apply_impulse to clarify the "position" vector #1018
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cbscribe
reviewed
Jan 25, 2018
| @@ -202,7 +202,7 @@ Called during physics processing, allowing you to read and safely modify the sim | |||
|
|
|||
| - void **apply_impulse** **(** :ref:`Vector3<class_vector3>` position, :ref:`Vector3<class_vector3>` impulse **)** | |||
|
|
|||
| Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the offset from the body origin are in global coordinates. | |||
| Apply a positioned impulse (which will be affected by the body mass and shape). This is the equivalent of hitting a billiard ball with a cue: a force that is applied once, and only once. Both the impulse and the position are in global coordinates, and the position is relative to the objects origin. | |||
|
Changes to the class reference should be made on the source XML in https://github.com/godotengine/godot/tree/master/doc/classes |
|
Can you make this same change to RigidBody2D? |
akien-mga
added a commit
to godotengine/godot
that referenced
this pull request
Jan 25, 2018
Also enhance RigidBody docs as per godotengine/godot-docs#1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
|
I've merged it in the proper repo as part of d516aab. For RigidBody2D this is not needed as is, as the parameter is named "offset" already so the docs make sense. (But then RigidBody2D and RigidBody re slightly inconsistent with each other). |
octetdev2
pushed a commit
to octetdev2/godot-tile-module
that referenced
this pull request
Apr 24, 2022
Also enhance RigidBody docs as per godotengine/godot-docs#1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
akien-mga
added a commit
to godotengine/godot-visual-script
that referenced
this pull request
Aug 23, 2022
Also enhance RigidBody docs as per godotengine/godot-docs#1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Minor change to the documentation for apply_impulse, as to me the note on offset being relative was "hidden."