diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-03-02 01:37:19 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2022-03-02 20:28:43 +0100 |
| commit | a30e5805afc4d07ea7762463dbade4709867ee6b (patch) | |
| tree | 04cd1d3cfb8377509a1367c2be40542aadf9d260 /doc/classes/SegmentShape2D.xml | |
| parent | 62765fb7ca7cca7ae0c56be99cc99d9b3b0bd040 (diff) | |
Improve documentation related to physics collision shapes
- Document using convex decomposition in the editor.
- Mention that "trimesh" is synonymous with a concave collision shape.
- Add performance hints for each collision shape.
Diffstat (limited to 'doc/classes/SegmentShape2D.xml')
| -rw-r--r-- | doc/classes/SegmentShape2D.xml | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/classes/SegmentShape2D.xml b/doc/classes/SegmentShape2D.xml index 8109886262..a1809301e5 100644 --- a/doc/classes/SegmentShape2D.xml +++ b/doc/classes/SegmentShape2D.xml @@ -1,10 +1,11 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="SegmentShape2D" inherits="Shape2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> - Segment shape for 2D collisions. + Segment shape resource for 2D physics. </brief_description> <description> - Segment shape for 2D collisions. Consists of two points, [code]a[/code] and [code]b[/code]. + 2D segment shape to be added as a [i]direct[/i] child of a [PhysicsBody2D] or [Area2D] using a [CollisionShape2D] node. Consists of two points, [code]a[/code] and [code]b[/code]. + [b]Performance:[/b] Being a primitive collision shape, [SegmentShape2D] is fast to check collisions against (though not as fast as [CircleShape2D]). </description> <tutorials> </tutorials> |