Document PhysicsServer3D shapes
#110223
Open
Document PhysicsServer3D shapes
#110223
+36
−14
Conversation
This file contains hidden or 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
doc/classes/PhysicsServer3D.xml
Outdated
Comment on lines
1034
to
1044
| - [constant SHAPE_WORLD_BOUNDARY]: a [Plane] [code]plane[/code], | ||
| - [constant SHAPE_SEPARATION_RAY]: a dictionary containing the key [code]length[/code] with a [float] value and the key [code]slide_on_slope[/code] with a [bool] value, | ||
| - [constant SHAPE_SPHERE]: a [float] [code]radius[/code], | ||
| - [constant SHAPE_BOX]: a [Vector3] [code]half_extents[/code], | ||
| - [constant SHAPE_CAPSULE]: a dictionary containing the keys [code]height[/code] and [code]radius[/code] with [float] values, | ||
| - [constant SHAPE_CYLINDER]: a dictionary containing the keys [code]height[/code] and [code]radius[/code] with [float] values, | ||
| - [constant SHAPE_CONVEX_POLYGON]: a [PackedVector3Array] of points defining a convex polygon (the shape will be the convex hull of the points), | ||
| - [constant SHAPE_CONCAVE_POLYGON]: a dictionary containing the key [code]faces[/code] with a [PackedVector3Array] value (of length divisible by 3, so that each 3-tuple of points forms a face) and the key [code]backface_collision[/code] with a [bool] value, | ||
| - [constant SHAPE_HEIGHTMAP]: a dictionary containing the keys [code]width[/code] and [code]height[/code] with [float] values, and the key [code]heights[/code] with a [PackedFloat32Array] value (or a [PackedFloat64Array] value if Godot was compiled with the [code]precision=double[/code] option) of size [code]width * height[/code] or a float [Image] value of size [code]width × height[/code] (with format [constant Image.FORMAT_RF]), and optionally the keys [code]min_height[/code] and [code]max_height[/code] with [float] values, | ||
| - [constant SHAPE_SOFT_BODY]: the input [param data] is ignored and this method has no effect, | ||
| - [constant SHAPE_CUSTOM]: the input [param data] is interpreted by the custom physics server, if it supports a custom shape. |
There was a problem hiding this comment.
These descriptions are all a bit cumbersome, I'll see if I can make some suggestions for improving the readability
There was a problem hiding this comment.
Suggestions are welcome, but note this is already a big improvement over the zero information content that was there previously.
There was a problem hiding this comment.
Absolutely, but I find it very difficult to parse the information in this and especially getting a good overview of what it says
There was a problem hiding this comment.
I think I improved the phrasing of what used to be the worst parts (and fixed some typos). Also, the layout of the information is consistent with the PhysicsServer2D documentation, so if we want to improve that then I think it should be done as a follow-up.
rburing
force-pushed
the
physicsserver3d_shape_doc
branch
5 times, most recently
from
8a5db9e to
97cf92a
Compare
rburing
force-pushed
the
physicsserver3d_shape_doc
branch
from
97cf92a to
9505c0d
Compare
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.
Consistent with the
PhysicsServer2Ddocumentation. In particular, documentPhysicsServer3D.shape_set_data: