Skip to content

Commit

Permalink
Fix Jolt note in WorldBoundaryShape3D documentation
Browse files Browse the repository at this point in the history
The dimensions are around the shape's origin, not the world origin (i.e.
`(0, 0, 0)` in global coordinates).

(cherry picked from commit 9030f76)
  • Loading branch information
Calinou authored and Spartan322 committed Feb 4, 2025
1 parent eaf61f8 commit 02e1215
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions doc/classes/WorldBoundaryShape3D.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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 shape's origin). It can be adjusted by changing [member ProjectSettings.physics/jolt_physics_3d/limits/world_boundary_shape_size].
</description>
<tutorials>
</tutorials>
Expand Down

0 comments on commit 02e1215

Please sign in to comment.