classref: Sync with current master branch (929333fe2)

classes/class_physicsserver3d.rst

@@ -1076,27 +1076,21 @@ Constant to set/get gravity vector/center in an area.
 
 Constant to set/get whether the gravity vector of an area is a direction, or a center point.
 
-.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE:
+.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE:
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_DISTANCE_SCALE** = ``4``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_UNIT_DISTANCE** = ``4``
 
-Constant to set/get the falloff factor for point gravity of an area. The greater this value is, the faster the strength of gravity decreases with the square of distance.
+Constant to set/get the distance at which the gravity strength is equal to the gravity controlled by :ref:`AREA_PARAM_GRAVITY<class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY>`. For example, on a planet 100 meters in radius with a surface gravity of 4.0 m/s², set the gravity to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 meters from the center the gravity will be 1.0 m/s² (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/s² (half the distance, 4x the gravity), and so on.
 
-.. _class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_POINT_ATTENUATION:
-
-.. rst-class:: classref-enumeration-constant
-
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_GRAVITY_POINT_ATTENUATION** = ``5``
-
-This constant was used to set/get the falloff factor for point gravity. It has been superseded by :ref:`AREA_PARAM_GRAVITY_DISTANCE_SCALE<class_PhysicsServer3D_constant_AREA_PARAM_GRAVITY_DISTANCE_SCALE>`.
+The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance.
 
 .. _class_PhysicsServer3D_constant_AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE:
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``6``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP_OVERRIDE_MODE** = ``5``
 
 Constant to set/get linear damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
 
@@ -1104,7 +1098,7 @@ Constant to set/get linear damping override mode in an area. See :ref:`AreaSpace
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``7``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_LINEAR_DAMP** = ``6``
 
 Constant to set/get the linear damping factor of an area.
 
@@ -1112,7 +1106,7 @@ Constant to set/get the linear damping factor of an area.
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``8``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP_OVERRIDE_MODE** = ``7``
 
 Constant to set/get angular damping override mode in an area. See :ref:`AreaSpaceOverrideMode<enum_PhysicsServer3D_AreaSpaceOverrideMode>` for possible values.
 
@@ -1120,7 +1114,7 @@ Constant to set/get angular damping override mode in an area. See :ref:`AreaSpac
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``9``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_ANGULAR_DAMP** = ``8``
 
 Constant to set/get the angular damping factor of an area.
 
@@ -1128,7 +1122,7 @@ Constant to set/get the angular damping factor of an area.
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``10``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_PRIORITY** = ``9``
 
 Constant to set/get the priority (order of processing) of an area.
 
@@ -1136,7 +1130,7 @@ Constant to set/get the priority (order of processing) of an area.
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_FORCE_MAGNITUDE** = ``11``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_FORCE_MAGNITUDE** = ``10``
 
 Constant to set/get the magnitude of area-specific wind force.
 
@@ -1144,7 +1138,7 @@ Constant to set/get the magnitude of area-specific wind force.
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_SOURCE** = ``12``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_SOURCE** = ``11``
 
 Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows.
 
@@ -1152,7 +1146,7 @@ Constant to set/get the 3D vector that specifies the origin from which an area-s
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_DIRECTION** = ``13``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_DIRECTION** = ``12``
 
 Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows.
 
@@ -1160,7 +1154,7 @@ Constant to set/get the 3D vector that specifies the direction in which an area-
 
 .. rst-class:: classref-enumeration-constant
 
-:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_ATTENUATION_FACTOR** = ``14``
+:ref:`AreaParameter<enum_PhysicsServer3D_AreaParameter>` **AREA_PARAM_WIND_ATTENUATION_FACTOR** = ``13``
 
 Constant to set/get the exponential rate at which wind force decreases with distance from its origin.