From 840d860f8834e89c1bba37a1734a21a3527dd105 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Mon, 8 Apr 2024 22:59:02 +0200 Subject: [PATCH] Document Area3D wind properties only affecting SoftBody3D --- doc/classes/Area3D.xml | 3 +++ doc/classes/PhysicsServer3D.xml | 2 +- doc/classes/SoftBody3D.xml | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/doc/classes/Area3D.xml b/doc/classes/Area3D.xml index 4ee16d499d1..8eedd3cdf2a 100644 --- a/doc/classes/Area3D.xml +++ b/doc/classes/Area3D.xml @@ -124,12 +124,15 @@ The exponential rate at which wind force decreases with distance from its origin. + [b]Note:[/b] This wind force only applies to [SoftBody3D] nodes. Other physics bodies are currently not affected by wind. The magnitude of area-specific wind force. + [b]Note:[/b] This wind force only applies to [SoftBody3D] nodes. Other physics bodies are currently not affected by wind. The [Node3D] which is used to specify the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the [Node3D]'s local transform, and its origin is the origin of the [Node3D]'s local transform. + [b]Note:[/b] This wind force only applies to [SoftBody3D] nodes. Other physics bodies are currently not affected by wind. diff --git a/doc/classes/PhysicsServer3D.xml b/doc/classes/PhysicsServer3D.xml index 7dcb1858342..4a4a1ad0251 100644 --- a/doc/classes/PhysicsServer3D.xml +++ b/doc/classes/PhysicsServer3D.xml @@ -1628,7 +1628,7 @@ 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 magnitude of area-specific wind force. This wind force only applies to [SoftBody3D] nodes. Other physics bodies are currently not affected by wind. Constant to set/get the 3D vector that specifies the origin from which an area-specific wind blows. diff --git a/doc/classes/SoftBody3D.xml b/doc/classes/SoftBody3D.xml index a4d80a7c3e4..195196b78ca 100644 --- a/doc/classes/SoftBody3D.xml +++ b/doc/classes/SoftBody3D.xml @@ -5,6 +5,7 @@ A deformable 3D physics mesh. Used to create elastic or deformable objects such as cloth, rubber, or other flexible materials. + Additionally, [SoftBody3D] is subject to wind forces defined in [Area3D] (see [member Area3D.wind_source_path], [member Area3D.wind_force_magnitude], and [member Area3D.wind_attenuation_factor]). [b]Note:[/b] There are many known bugs in [SoftBody3D]. Therefore, it's not recommended to use them for things that can affect gameplay (such as trampolines).