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.
Fixes godotengine/godot-docs#8087
How did the "spears falling from the skies" come to be?
Well, I was making this massive PR refactoring physics classes' documentation, and this was a class I hadn't used before. I noticed a few issues in this page. The first was that the documentation said "SeparationRayShape is useful for characters" which seemed so broad. You can use everything for characters except for stuff like worldboundaries and heightmaps. So I started thinking about how to give a more obvious example.
The second issue in the old documentation page, and it was a reoccuring issue, was a performance remark along the lines of "SeparationRayShape is fast, but CircleShape is faster". Again, why would you mention this? It's not like the two shapes are similar to any capacity, no one will replace their SeparationRayShapes for CircleShapes for performance reasons.
Wanting to make these performance remarks more useful, I made a test project and started spawning a lot of physics shapes. Spawning 1000 SeparationRayShapes looked like a "Rain of spears" sorta spell, so it gave me the idea to put this as an example in the docs. I didn't even look into its common use cases 😓