Skip to content

Commit e013b79

Browse files
authored
Add detailed documentation for Part.Shape (#900)
## Changes - Make the table consistent with https://create.roblox.com/docs/reference/engine/enums/PartType - Add details about exactness guarantees for part collisions ## Checks By submitting your pull request for review, you agree to the following: - [x] This contribution was created in whole or in part by me, and I have the right to submit it under the terms of this repository's open source licenses. - [x] I understand and agree that this contribution and a record of it are public, maintained indefinitely, and may be redistributed under the terms of this repository's open source licenses. - [x] To the best of my knowledge, all proposed changes are accurate. ---------
1 parent 5f88496 commit e013b79

File tree

1 file changed

+11
-8
lines changed
  • content/en-us/reference/engine/classes

1 file changed

+11
-8
lines changed

content/en-us/reference/engine/classes/Part.yaml

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,17 +24,20 @@ properties:
2424
The `Enum.PartType` enum controls the shape value, and has five possible
2525
shapes:
2626
27-
| Shape/Value | Description |
28-
| ----------- | --------------------------------------- |
29-
| Ball | A spherical shape, like a basketball. |
30-
| Cylinder | A rod-like shape, like a tin can. |
31-
| Block | The default, brick shape. |
32-
| Wedge | A wedge shape with a slope on one side. |
33-
| CornerWedge | A wedge shape with slopes on two sides. |
27+
| Shape/Value | Description |
28+
| ----------- | ------------------------------------------- |
29+
| Ball | A spherical shape. |
30+
| Block | A block shape. |
31+
| Cylinder | A cylinder shape. |
32+
| Wedge | A wedge shape with a slope on one side. |
33+
| CornerWedge | A wedge shape with slopes on two sides. |
3434
35-
Note that `Class.MeshPart` and
35+
`Class.MeshPart` and
3636
[solid modeling](../../../parts/solid-modeling.md) can be used to obtain
3737
completely custom part shapes.
38+
39+
Collisions between balls, blocks, and wedges, and corner wedges are exact, whereas collisions between terrain, cylinders, TriangleMeshes, and other geometry types are approximations.
40+
This means that the ball shape can be useful to create stable colliders for car wheels.
3841
code_samples:
3942
- using-a-script-to-create-a-part
4043
type: PartType

0 commit comments

Comments
 (0)