From c6cea6e9b372f403a5906813bf5db8583d747d06 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 29 Jun 2019 12:38:01 +0200 Subject: doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. --- doc/classes/Area.xml | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) (limited to 'doc/classes/Area.xml') diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index d23e8567aa..f53baf4dd6 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -86,58 +86,58 @@ - + The rate at which objects stop spinning in this area. Represents the angular velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - + The name of the area's audio bus. - + If [code]true[/code], the area's audio bus overrides the default audio bus. Default value: [code]false[/code]. - + The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. - + The physics layers this area scans to determine collision detection. - + The area's gravity intensity (ranges from -1024 to 1024). This value multiplies the gravity vector. 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. - + If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. Default value: [code]false[/code]. - + The area's gravity vector (not normalized). If gravity is a point (see [member gravity_point]), this will be the point of attraction. - + The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - + If [code]true[/code], other monitoring areas can detect this area. Default value: [code]true[/code]. - + If [code]true[/code], the area detects bodies or areas entering and exiting it. Default value: [code]true[/code]. - + The area's priority. Higher priority areas are processed first. Default value: 0. - + The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. - + If [code]true[/code], the area applies reverb to its associated audio. - + The reverb bus name to use for this area's associated audio. - + 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. -- cgit v1.2.3 From b9aa13e5917b45a540e92e50b81f7bc923e493d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Verschelde?= Date: Sat, 29 Jun 2019 15:24:23 +0200 Subject: doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool. --- doc/classes/Area.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'doc/classes/Area.xml') diff --git a/doc/classes/Area.xml b/doc/classes/Area.xml index f53baf4dd6..6bd1382488 100644 --- a/doc/classes/Area.xml +++ b/doc/classes/Area.xml @@ -93,7 +93,7 @@ The name of the area's audio bus. - If [code]true[/code], the area's audio bus overrides the default audio bus. Default value: [code]false[/code]. + If [code]true[/code], the area's audio bus overrides the default audio bus. The area's physics layer(s). Collidable objects can exist in any of 32 different layers. A contact is detected if object A is in any of the layers that object B scans, or object B is in any layers that object A scans. See also [member collision_mask]. @@ -108,7 +108,7 @@ The falloff factor for point gravity. The greater the value, the faster gravity decreases with distance. - If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member space_override]. Default value: [code]false[/code]. + If [code]true[/code], gravity is calculated from a point (set via [member gravity_vec]). See also [member 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. @@ -117,13 +117,13 @@ The rate at which objects stop moving in this area. Represents the linear velocity lost per second. Values range from [code]0[/code] (no damping) to [code]1[/code] (full damping). - If [code]true[/code], other monitoring areas can detect this area. Default value: [code]true[/code]. + If [code]true[/code], other monitoring areas can detect this area. - If [code]true[/code], the area detects bodies or areas entering and exiting it. Default value: [code]true[/code]. + If [code]true[/code], the area detects bodies or areas entering and exiting it. - The area's priority. Higher priority areas are processed first. Default value: 0. + The area's priority. Higher priority areas are processed first. The degree to which this area applies reverb to its associated audio. Ranges from [code]0[/code] to [code]1[/code] with [code]0.1[/code] precision. -- cgit v1.2.3