summaryrefslogtreecommitdiff
path: root/doc/classes/PhysicsMaterial.xml
blob: 0889c238dc11aeb00df75917519ef95b4040013e (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PhysicsMaterial" inherits="Resource" version="4.0">
	<brief_description>
		A material for physics properties.
	</brief_description>
	<description>
		Provides a means of modifying the collision properties of a [PhysicsBody3D].
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="absorbent" type="bool" setter="set_absorbent" getter="is_absorbent" default="false">
			If [code]true[/code], subtracts the bounciness from the colliding object's bounciness instead of adding it.
		</member>
		<member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="0.0">
			The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness).
		</member>
		<member name="friction" type="float" setter="set_friction" getter="get_friction" default="1.0">
			The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction).
		</member>
		<member name="rough" type="bool" setter="set_rough" getter="is_rough" default="false">
			If [code]true[/code], the physics engine will use the friction of the object marked as "rough" when two objects collide. If [code]false[/code], the physics engine will use the lowest friction of all colliding objects instead. If [code]true[/code] for both colliding objects, the physics engine will use the highest friction.
		</member>
	</members>
	<constants>
	</constants>
</class>