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

Clarify velocity_computed signal description #92293

Merged
merged 1 commit into from
May 28, 2024

Conversation

rvenson
Copy link
Contributor

@rvenson rvenson commented May 23, 2024

As stated in the issue #81761, the velocity_computed signal is no longer triggered by NavigationAgent.set_velocity(). I updated the documentation for NavigationAgent2D and NavigationAgent3D to describe it cleaner since the current description could be misleading.

Current description:

Notifies when the collision avoidance velocity is calculated. Emitted when velocity is set. Only emitted when avoidance_enabled is true.

Updated description:

Notifies when the collision avoidance velocity is calculated. Emitted every update as long avoidance_enabled is true and the agent has a navigation map.

@rvenson rvenson requested a review from a team as a code owner May 23, 2024 20:02
@AThousandShips AThousandShips requested a review from a team May 23, 2024 20:04
Copy link
Contributor

@Scony Scony left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd change the wording from as long to as long as or from as long to whenever both

@rvenson rvenson closed this May 23, 2024
@rvenson rvenson force-pushed the fix-navigation-agent-docs branch from 9ee7321 to b947c53 Compare May 23, 2024 21:00
@rvenson rvenson reopened this May 23, 2024
@rvenson rvenson force-pushed the fix-navigation-agent-docs branch from 9ee7321 to 7b0f585 Compare May 23, 2024 22:02
@rvenson
Copy link
Contributor Author

rvenson commented May 23, 2024

I'd change the wording from as long to as long as or from as long to whenever both

Fixed. Thank you.

@akien-mga akien-mga added this to the 4.3 milestone May 24, 2024
@akien-mga akien-mga added cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels May 24, 2024
@rvenson rvenson force-pushed the fix-navigation-agent-docs branch from 7b0f585 to c8cab57 Compare May 25, 2024 18:13
@akien-mga akien-mga changed the title Clarify velocity_computed signal description Clarify velocity_computed signal description May 28, 2024
@akien-mga akien-mga merged commit 4ca4746 into godotengine:master May 28, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks! And congrats for your first merged Godot contribution 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.1 Considered for cherry-picking into a future 4.1.x release cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants