summaryrefslogtreecommitdiff
path: root/doc/classes/CircleShape2D.xml
blob: 6f4989daa3de36943381fa7bea72c53c1535b83c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CircleShape2D" inherits="Shape2D" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Circular shape resource for 2D physics.
	</brief_description>
	<description>
		2D circular shape to be added as a [i]direct[/i] child of a [PhysicsBody2D] or [Area2D] using a [CollisionShape2D] node. This shape is useful for modeling balls or small characters and its collision detection with everything else is very fast.
		[b]Performance:[/b] Being a primitive collision shape, [CircleShape2D] is the fastest collision shape to check collisions against, as it only requires a distance check with the shape's origin.
	</description>
	<tutorials>
	</tutorials>
	<members>
		<member name="radius" type="float" setter="set_radius" getter="get_radius" default="10.0">
			The circle's radius.
		</member>
	</members>
</class>