diff options
author | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-30 13:07:32 +0200 |
---|---|---|
committer | Rémi Verschelde <rverschelde@gmail.com> | 2019-06-30 13:58:07 +0200 |
commit | 1fbca7ed8889f8e71bef1e313f247256c1844823 (patch) | |
tree | 424299cafc57768e2104a2f0f490c8a640f9a682 /doc | |
parent | 850a54a2a55f26a447967f47f99d09cfc2874b38 (diff) |
doc: Mark PhysicsBody bounce/friction as deprecated
Diffstat (limited to 'doc')
-rw-r--r-- | doc/classes/PhysicsMaterial.xml | 2 | ||||
-rw-r--r-- | doc/classes/RigidBody.xml | 4 | ||||
-rw-r--r-- | doc/classes/RigidBody2D.xml | 4 | ||||
-rw-r--r-- | doc/classes/StaticBody.xml | 4 | ||||
-rw-r--r-- | doc/classes/StaticBody2D.xml | 2 |
5 files changed, 12 insertions, 4 deletions
diff --git a/doc/classes/PhysicsMaterial.xml b/doc/classes/PhysicsMaterial.xml index 1582fcc89a..73f1416172 100644 --- a/doc/classes/PhysicsMaterial.xml +++ b/doc/classes/PhysicsMaterial.xml @@ -14,7 +14,7 @@ <member name="absorbent" type="bool" setter="set_absorbent" getter="is_absorbent" default="false"> </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce" default="0.0"> - The body's bounciness. + 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). diff --git a/doc/classes/RigidBody.xml b/doc/classes/RigidBody.xml index dd9bcecfb3..a705789413 100644 --- a/doc/classes/RigidBody.xml +++ b/doc/classes/RigidBody.xml @@ -126,7 +126,8 @@ Lock the body's movement in the Z axis. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> - RigidBody's bounciness. + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> If [code]true[/code], the RigidBody will not calculate forces and will act as a static body while there is no movement. It will wake up when forces are applied through other collisions or when the [code]apply_impulse[/code] method is used. @@ -146,6 +147,7 @@ </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction, from 0 (frictionless) to 1 (max friction). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0"> This is multiplied by the global 3D gravity setting found in [b]Project > Project Settings > Physics > 3d[/b] to produce RigidBody's gravity. For example, a value of 1 will be normal gravity, 2 will apply double gravity, and 0.5 will apply half gravity to this object. diff --git a/doc/classes/RigidBody2D.xml b/doc/classes/RigidBody2D.xml index 43fc5704aa..907a82d51d 100644 --- a/doc/classes/RigidBody2D.xml +++ b/doc/classes/RigidBody2D.xml @@ -127,7 +127,8 @@ The body's total applied torque. </member> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> - The body's bounciness. + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. </member> <member name="can_sleep" type="bool" setter="set_can_sleep" getter="is_able_to_sleep" default="true"> If [code]true[/code], the body will not calculate forces and will act as a static body if there is no movement. The body will wake up when other forces are applied via collisions or by using [method apply_impulse] or [method add_force]. @@ -147,6 +148,7 @@ </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. </member> <member name="gravity_scale" type="float" setter="set_gravity_scale" getter="get_gravity_scale" default="1.0"> Multiplies the gravity applied to the body. The body's gravity is calculated from the [b]Default Gravity[/b] value in [b]Project > Project Settings > Physics > 2d[/b] and/or any additional gravity vector applied by [Area2D]s. diff --git a/doc/classes/StaticBody.xml b/doc/classes/StaticBody.xml index b3243a4fca..878d76a2e3 100644 --- a/doc/classes/StaticBody.xml +++ b/doc/classes/StaticBody.xml @@ -14,7 +14,8 @@ </methods> <members> <member name="bounce" type="float" setter="set_bounce" getter="get_bounce"> - The body's bounciness. + The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. </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. @@ -24,6 +25,7 @@ </member> <member name="friction" type="float" setter="set_friction" getter="get_friction"> The body's friction, from 0 (frictionless) to 1 (full friction). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override" default="null"> </member> diff --git a/doc/classes/StaticBody2D.xml b/doc/classes/StaticBody2D.xml index c039b7888c..4522a50557 100644 --- a/doc/classes/StaticBody2D.xml +++ b/doc/classes/StaticBody2D.xml @@ -14,6 +14,7 @@ <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). + Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override]. </member> <member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="0.0"> The body's constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating. @@ -23,6 +24,7 @@ </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). + Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override]. </member> <member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override" default="null"> </member> |