summaryrefslogtreecommitdiff
path: root/doc/classes/StaticBody.xml
blob: b3243a4fca70d83106060e247501120d1f518930 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StaticBody" inherits="PhysicsBody" category="Core" version="3.2">
	<brief_description>
		Static body for 3D physics.
	</brief_description>
	<description>
		Static body for 3D physics. A static body is a simple body that is not intended to move. In contrast to [RigidBody], they don't consume any CPU resources as long as they don't move.
		A static body can also be animated by using simulated motion mode. This is useful for implementing functionalities such as moving platforms. When this mode is active, the body can be animated and automatically computes linear and angular velocity to apply in that frame and to influence other bodies.
		Alternatively, a constant linear or angular velocity can be set for the static body, so even if it doesn't move, it affects other bodies as if it was moving (this is useful for simulating conveyor belts or conveyor wheels).
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
			The body's bounciness.
		</member>
		<member name="constant_angular_velocity" type="Vector3" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="Vector3( 0, 0, 0 )">
			The body's constant angular velocity. This does not rotate the body, but affects other bodies that touch it, as if it was in a state of rotation.
		</member>
		<member name="constant_linear_velocity" type="Vector3" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector3( 0, 0, 0 )">
			The body's constant linear velocity. This does not move the body, but affects other bodies that touch it, as if it was in a state of movement.
		</member>
		<member name="friction" type="float" setter="set_friction" getter="get_friction">
			The body's friction, from 0 (frictionless) to 1 (full friction).
		</member>
		<member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override" default="null">
		</member>
	</members>
	<constants>
	</constants>
</class>