Clarify Shapecast safe/unsafe fraction difference in class reference #85839
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
romlok
force-pushed
the
clarify-get-closest-collision-unsafe-fraction
branch
from
4e425b7 to
4359dc4
Compare
mhilbrunner
approved these changes
Apr 7, 2024
|
Thanks! |
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.
This clarifies the difference between
get_closest_collision_safe_fractionand the equivalentunsafeversion in the class reference for bothShapecast2DandShapecast3Dclasses.I've added some explanation of the implementation to the
unsafedescriptions, since if one isn't aware of the implementation, the current descriptions seem linguistically equivalent!Issue: godotengine/godot-docs#8552
Current documentation: https://docs.godotengine.org/en/latest/classes/class_shapecast2d.html#class-shapecast2d-method-get-closest-collision-safe-fraction