summaryrefslogtreecommitdiff
path: root/doc/classes/CapsuleShape2D.xml
blob: 2236d8035f0e76ef47972b6c4ef931fee7f8aec3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CapsuleShape2D" inherits="Shape2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Capsule shape resource for 2D physics.
	</brief_description>
	<description>
		2D capsule shape to be added as a [i]direct[/i] child of a [PhysicsBody2D] or [Area2D] using a [CollisionShape2D] node. In 2D, a capsule is a rectangle shape with half-circles at both ends.
		[b]Performance:[/b] Being a primitive collision shape, [CapsuleShape2D] is fast to check collisions against (though not as fast as [CircleShape2D]).
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="height" type="float" setter="set_height" getter="get_height" default="30.0">
			The capsule's height.
		</member>
		<member name="radius" type="float" setter="set_radius" getter="get_radius" default="10.0">
			The capsule's radius.
		</member>
	</members>
</class>