aboutsummaryrefslogtreecommitdiff
path: root/doc/base/classes.xml
diff options
context:
space:
mode:
authorP-GLEZ2016-06-01 11:56:14 +0200
committerRémi Verschelde2016-06-04 22:20:02 +0200
commit298be3356f8a7cee5c06bfe10687913e42c78af3 (patch)
tree258c9973a0d53586e5bfa33e5a3e624174f32438 /doc/base/classes.xml
parent436e968b437eb35026dddeb79e0f9c56701b5755 (diff)
downloadgodot-298be3356f8a7cee5c06bfe10687913e42c78af3.tar.gz
godot-298be3356f8a7cee5c06bfe10687913e42c78af3.tar.zst
godot-298be3356f8a7cee5c06bfe10687913e42c78af3.zip
StaticBody documentation
Documented StaticBody. Also corrected an error in StaticBody2D documentation (cherry picked from commit 35cb75220de897face4d133cd9a9c5c1ac80d8a4)
Diffstat (limited to '')
-rw-r--r--doc/base/classes.xml18
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml
index 7be89b3de..49dba6498 100644
--- a/doc/base/classes.xml
+++ b/doc/base/classes.xml
@@ -33984,58 +33984,68 @@ This method controls whether the position between two cached points is interpola
</class>
<class name="StaticBody" inherits="PhysicsBody" category="Core">
<brief_description>
- PhysicsBody for static collision objects.
+ Static body for 3D Physics.
</brief_description>
<description>
- StaticBody implements a static collision [Node], by utilizing a rigid body in the [PhysicsServer]. Static bodies are used for static collision. For more information on physics body nodes, see [PhysicsBody].
+ Static body for 3D Physics. A static body is a simple body that is not intended to move. They don't consume any CPU resources in contrast to a [RigidBody3D] so they are great for scenario collision.
+ 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>
<methods>
<method name="set_constant_linear_velocity">
<argument index="0" name="vel" type="Vector3">
</argument>
<description>
+ Set a constant linear velocity for the body. This does not move the body, but affects other bodies touching it, as if it was moving.
</description>
</method>
<method name="set_constant_angular_velocity">
<argument index="0" name="vel" type="Vector3">
</argument>
<description>
+ Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
</description>
</method>
<method name="get_constant_linear_velocity" qualifiers="const">
<return type="Vector3">
</return>
<description>
+ Return the constant linear velocity for the body.
</description>
</method>
<method name="get_constant_angular_velocity" qualifiers="const">
<return type="Vector3">
</return>
<description>
+ Return the constant angular velocity for the body.
</description>
</method>
<method name="set_friction">
<argument index="0" name="friction" type="float">
</argument>
<description>
+ Set the body friction, from 0 (frictionless) to 1 (full friction).
</description>
</method>
<method name="get_friction" qualifiers="const">
<return type="float">
</return>
<description>
+ Return the body friction.
</description>
</method>
<method name="set_bounce">
<argument index="0" name="bounce" type="float">
</argument>
<description>
+ Set the body bounciness, from 0 (not bouncy) to 1 (bouncy).
</description>
</method>
<method name="get_bounce" qualifiers="const">
<return type="float">
</return>
<description>
+ Return the body bounciness.
</description>
</method>
</methods>
@@ -34063,14 +34073,14 @@ This method controls whether the position between two cached points is interpola
<argument index="0" name="vel" type="float">
</argument>
<description>
- Set a constant angular velocity for the body.
+ Set a constant angular velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
</description>
</method>
<method name="get_constant_linear_velocity" qualifiers="const">
<return type="Vector2">
</return>
<description>
- Return the constant linear velocity for the body. This does not rotate the body, but affects other bodies touching it, as if it was rotating.
+ Return the constant linear velocity for the body.
</description>
</method>
<method name="get_constant_angular_velocity" qualifiers="const">