Document WorldBoundaryShape3D having a finite size when using Jolt Physics #101108
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
Calinou
force-pushed
the
doc-worldboundaryshape3d-finite-size
branch
2 times, most recently
from
2c9ea21 to
83578c4
Compare
Calinou
force-pushed
the
doc-worldboundaryshape3d-finite-size
branch
from
83578c4 to
31ccbe0
Compare
akien-mga
reviewed
Jan 11, 2025
…ysics This also mentions Jolt Physics in the ProjectSettings 3D physics engine documentation.
Calinou
force-pushed
the
doc-worldboundaryshape3d-finite-size
branch
from
31ccbe0 to
e668188
Compare
akien-mga
approved these changes
Jan 14, 2025
AThousandShips
approved these changes
Jan 15, 2025
|
Thanks! |
mihe
reviewed
Jan 17, 2025
| @@ -5,6 +5,7 @@ | |||
| </brief_description> | |||
| <description> | |||
| A 3D world boundary shape, intended for use in physics. [WorldBoundaryShape3D] works like an infinite plane that forces all physics bodies to stay above it. The [member plane]'s normal determines which direction is considered as "above" and in the editor, the line over the plane represents this direction. It can for example be used for endless flat floors. | |||
| [b]Note:[/b] When the physics engine is set to [b]Jolt Physics[/b] in the project settings ([member ProjectSettings.physics/3d/physics_engine]), [WorldBoundaryShape3D] has a finite size (centered at the world origin). It can be adjusted by changing [member ProjectSettings.physics/jolt_physics_3d/limits/world_boundary_shape_size]. | |||
There was a problem hiding this comment.
Maybe I'm the only one confused by this, but is "the world origin" meant to refer to global (0, 0, 0) or the origin of the shape in the world?
The size is centered around the shape's own origin, and not global (0, 0, 0).
There was a problem hiding this comment.
This is a reasonable spot to be confused by. I also thought this referred to the origin of the world, instead of the global origin (global position).
There was a problem hiding this comment.
Pull request opened:
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 also mentions Jolt Physics in the ProjectSettings 3D physics engine documentation.
Not cherry-pickable to 4.3, as Jolt Physics isn't present there.