diff options
| author | Poommetee Ketson <poommetee@protonmail.com> | 2017-09-23 23:30:48 +0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-23 23:30:48 +0700 |
| commit | ea7646aabe262e37e13a814a79c38efc69b1a09b (patch) | |
| tree | bebae022745e9574fe0602d4f6d6adc0fe17f4c9 /doc | |
| parent | 480b417c5baf4d15379bfca873e19e0e0ba24f45 (diff) | |
| parent | d82a7cdcf7e836566d9c1060d45e2ad1c20e5d72 (diff) | |
Merge pull request #11515 from cbscribe/kcc_staticbody2d_doc
[DOCS] Update StaticBody2D class ref
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/StaticBody2D.xml | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index 2f23ac588b..cff41074b8 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -4,9 +4,8 @@ Static body for 2D Physics. </brief_description> <description> - Static body for 2D 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 [RigidBody2D] 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). + Static body for 2D Physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms. + Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt). </description> <tutorials> </tutorials> @@ -80,12 +79,16 @@ </methods> <members> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). </member> <member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity"> + Constant angular velocity for the body. This does not rotate the body, but affects colliding bodies, as if it were rotating. </member> <member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity"> + Constant linear velocity for the body. This does not move the body, but affects colliding bodies, as if it were moving. </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> + The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction). </member> </members> <constants> |