Fix documentation for get_velocity_at_local_position#116106
Merged
Repiteo merged 1 commit intoFeb 10, 2026
Merged
Conversation
mihe
approved these changes
Feb 10, 2026
Contributor
|
Thanks! Congratulations on your first merged contribution! 🎉 |
rivie13
pushed a commit
to rivie13/Phoenix-Agentic-Engine
that referenced
this pull request
Feb 16, 2026
…city-at-local-position Fix documentation for `get_velocity_at_local_position`
This file contains hidden or 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
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.
Resolves godotengine/godot-docs#7110
There is a misleading description of the expected space of
local_positionparameter ofget_velocity_at_local_positionfunction of bothPhysicsDirectBodyState2DandPhysicsDirectBodyState3Dclasses.See the docs issue, but briefly, by passing an vector in local space of the body (both translation and rotation), gives incorrect values, by passing an vector in local translation, but global rotation (meaning an offset product of
global_point-body.transform.origin) it returns the correct velocity value in global space.The function has the same behaviour of
apply_forcefor the parameter, expecting an vector in local translation space, but global rotation space.It's ideal to rename the function to something like
get_velocity_at_offset, but this goes outside the scope of this PR and the docs update is more urgent.