diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-01-16 21:15:11 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-16 21:15:11 +0100 |
| commit | 3f66d8b953c89d366f83a71ec8404f47c1824d5c (patch) | |
| tree | f9a6163d1cc9e9cd2717cdd0a1129c4c8bc7a429 | |
| parent | 3099f6fae4da58f6c55d7bf4a060e21b5968a0bf (diff) | |
| parent | b4675973fd7287c7540a9393649826bf604dbb65 (diff) | |
Merge pull request #45232 from Xrayez/doc-gpu-particles-visibility
Document GPU particles visibility rect/aabb behavior
| -rw-r--r-- | doc/classes/GPUParticles2D.xml | 3 | ||||
| -rw-r--r-- | doc/classes/GPUParticles3D.xml | 3 |
2 files changed, 4 insertions, 2 deletions
diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index c09151405a..ebe4e3b00d 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -71,7 +71,8 @@ Particle texture. If [code]null[/code], particles will be squares. </member> <member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect" default="Rect2( -100, -100, 200, 200 )"> - Editor visibility helper. + The [Rect2] that determines the node's region which needs to be visible on screen for the particle system to be active. + Grow the rect if particles suddenly appear/disappear when the node enters/exits the screen. The [Rect2] can be grown via code or with the [b]Particles → Generate Visibility Rect[/b] editor tool. </member> </members> <constants> diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index d1296c3418..aea106af50 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -123,7 +123,8 @@ <member name="sub_emitter" type="NodePath" setter="set_sub_emitter" getter="get_sub_emitter" default="NodePath("")"> </member> <member name="visibility_aabb" type="AABB" setter="set_visibility_aabb" getter="get_visibility_aabb" default="AABB( -4, -4, -4, 8, 8, 8 )"> - The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active. + The [AABB] that determines the node's region which needs to be visible on screen for the particle system to be active. + Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The [AABB] can be grown via code or with the [b]Particles → Generate AABB[/b] editor tool. </member> </members> <constants> |