summaryrefslogtreecommitdiff
path: root/doc/classes/CollisionShape.xml
blob: 682c9340df3956dcdabae129a47cff5d27f6881f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
<?xml version="1.0" encoding="UTF-8" ?>
<class name="CollisionShape" inherits="Spatial" category="Core" version="3.1">
	<brief_description>
		Node that represents collision shape data in 3D space.
	</brief_description>
	<description>
		Editor facility for creating and editing collision shapes in 3D space. You can use this node to represent all sorts of collision shapes, for example, add this to an [Area] to give it a detection shape, or add it to a [PhysicsBody] to create a solid object. [b]IMPORTANT[/b]: this is an Editor-only helper to create shapes, use [method get_shape] to get the actual shape.
	</description>
	<tutorials>
		<link>http://docs.godotengine.org/en/3.0/tutorials/physics/physics_introduction.html</link>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="make_convex_from_brothers">
			<return type="void">
			</return>
			<description>
				Sets the collision shape's shape to the addition of all its convexed [MeshInstance] siblings geometry.
			</description>
		</method>
		<method name="resource_changed">
			<return type="void">
			</return>
			<argument index="0" name="resource" type="Resource">
			</argument>
			<description>
				If this method exists within a script it will be called whenever the shape resource has been modified.
			</description>
		</method>
	</methods>
	<members>
		<member name="disabled" type="bool" setter="set_disabled" getter="is_disabled">
			A disabled collision shape has no effect in the world.
		</member>
		<member name="shape" type="Shape" setter="set_shape" getter="get_shape">
			The actual shape owned by this collision shape.
		</member>
	</members>
	<constants>
	</constants>
</class>