From 3d1c123d453e53f114d9622bdcc61e30906f828a Mon Sep 17 00:00:00 2001 From: PouleyKetchoupp Date: Thu, 4 Nov 2021 18:12:00 -0700 Subject: Separate space override modes for gravity/damping in Area Also make inspector clearer for gravity point properties. --- doc/classes/Area2D.xml | 27 ++++++++++++++------- doc/classes/Area3D.xml | 27 ++++++++++++++------- doc/classes/PhysicsServer2D.xml | 44 +++++++++++++++------------------- doc/classes/PhysicsServer3D.xml | 52 ++++++++++++++++++----------------------- 4 files changed, 78 insertions(+), 72 deletions(-) (limited to 'doc') diff --git a/doc/classes/Area2D.xml b/doc/classes/Area2D.xml index c6a3f87042..8abdaac45f 100644 --- a/doc/classes/Area2D.xml +++ b/doc/classes/Area2D.xml @@ -50,6 +50,9 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/2d/default_angular_damp] for more details about damping. + + Override mode for angular damping calculations within this area. See [enum SpaceOverride] for possible values. + The name of the area's audio bus. @@ -57,21 +60,30 @@ If [code]true[/code], the area's audio bus overrides the default audio bus. - The area's gravity intensity (in pixels per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. + The area's gravity intensity (in pixels per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction. - - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + + The area's gravity vector (not normalized). - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_point_center]). See also [member gravity_space_override]. - - The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. + + If gravity is a point (see [member gravity_point]), this will be the point of attraction. + + + The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + + + Override mode for gravity calculations within this area. See [enum SpaceOverride] for possible values. The rate at which objects stop moving in this area. Represents the linear velocity lost per second. See [member ProjectSettings.physics/2d/default_linear_damp] for more details about damping. + + Override mode for linear damping calculations within this area. See [enum SpaceOverride] for possible values. + If [code]true[/code], other monitoring areas can detect this area. @@ -81,9 +93,6 @@ The area's priority. Higher priority areas are processed first. - - Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values. - diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 571fd8cad3..450ed44307 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -48,6 +48,9 @@ The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. See [member ProjectSettings.physics/3d/default_angular_damp] for more details about damping. + + Override mode for angular damping calculations within this area. See [enum SpaceOverride] for possible values. + The name of the area's audio bus. @@ -55,21 +58,30 @@ If [code]true[/code], the area's audio bus overrides the default audio bus. - The area's gravity intensity (in meters per second squared). This value multiplies the gravity vector. This is useful to alter the force of gravity without altering its direction. + The area's gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction. - - The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + + The area's gravity vector (not normalized). - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_point_center]). See also [member gravity_space_override]. - - The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. + + If gravity is a point (see [member gravity_point]), this will be the point of attraction. + + + The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. + + + Override mode for gravity calculations within this area. See [enum SpaceOverride] for possible values. The rate at which objects stop moving in this area. Represents the linear velocity lost per second. See [member ProjectSettings.physics/3d/default_linear_damp] for more details about damping. + + Override mode for linear damping calculations within this area. See [enum SpaceOverride] for possible values. + If [code]true[/code], other monitoring areas can detect this area. @@ -91,9 +103,6 @@ The degree to which this area's reverb is a uniform effect. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. - - Override mode for gravity and damping calculations within this area. See [enum SpaceOverride] for possible values. - The exponential rate at which wind force decreases with distance from its origin. diff --git a/doc/classes/PhysicsServer2D.xml b/doc/classes/PhysicsServer2D.xml index 7368fe06ab..a4248d11bc 100644 --- a/doc/classes/PhysicsServer2D.xml +++ b/doc/classes/PhysicsServer2D.xml @@ -98,13 +98,6 @@ Returns the space assigned to the area. - - - - - Returns the space override mode for the area. - - @@ -207,14 +200,6 @@ Assigns a space to the area. - - - - - - Sets the space override mode for the area. See [enum AreaSpaceOverrideMode] for a list of available modes. - - @@ -855,28 +840,37 @@ This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. - + + Constant to set/get gravity override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + + Constant to set/get gravity strength in an area. - + 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. - + 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. - + This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE]. - - Constant to set/get the linear dampening factor of an area. + + Constant to set/get linear damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + + + Constant to set/get the linear damping factor of an area. + + + Constant to set/get angular damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. - - Constant to set/get the angular dampening factor of an area. + + Constant to set/get the angular damping factor of an area. - + Constant to set/get the priority (order of processing) of an area. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 0f02cdf92f..9b0cea5407 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -85,13 +85,6 @@ Returns the space assigned to the area. - - - - - Returns the space override mode for the area. - - @@ -201,14 +194,6 @@ Assigns a space to the area. - - - - - - Sets the space override mode for the area. The modes are described in the [enum AreaSpaceOverrideMode] constants. - - @@ -1211,40 +1196,49 @@ This constant is used internally by the engine. Any attempt to create this kind of shape results in an error. - + + Constant to set/get gravity override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + + Constant to set/get gravity strength in an area. - + 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. - + 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. - + This constant was used to set/get the falloff factor for point gravity. It has been superseded by [constant AREA_PARAM_GRAVITY_DISTANCE_SCALE]. - - Constant to set/get the linear dampening factor of an area. + + Constant to set/get linear damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. + + + Constant to set/get the linear damping factor of an area. + + + Constant to set/get angular damping override mode in an area. See [enum AreaSpaceOverrideMode] for possible values. - - Constant to set/get the angular dampening factor of an area. + + Constant to set/get the angular damping factor of an area. - + Constant to set/get the priority (order of processing) of an area. - + Constant to set/get the magnitude of area-specific wind force. - + Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows. - + Constant to set/get the 3D vector that specifies the direction in which an area-specific wind blows. - + Constant to set/get the exponential rate at which wind force decreases with distance from its origin. -- cgit v1.2.3