From e52e46036e1a0427e883a7e3e57581af83f27568 Mon Sep 17 00:00:00 2001 From: clayjohn Date: Thu, 20 Jul 2023 22:03:59 +0200 Subject: [PATCH] Add detail to emitting docs for particles Highlight when emitting will and won't restart emission --- doc/classes/CPUParticles2D.xml | 2 +- doc/classes/CPUParticles3D.xml | 2 +- doc/classes/GPUParticles2D.xml | 2 +- doc/classes/GPUParticles3D.xml | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 09f810cb7726..eaacdd590d11 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -169,7 +169,7 @@ The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE]. - If [code]true[/code], particles are being emitted. + If [code]true[/code], particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is [code]true[/code] setting [member emitting] to [code]true[/code] will not restart the emission cycle until after all active particles finish processing. You can use the [signal finished] signal to be notified once all active particles finish processing. How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 905f5475be96..f03c463049b3 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -183,7 +183,7 @@ The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE]. - If [code]true[/code], particles are being emitted. + If [code]true[/code], particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is [code]true[/code] setting [member emitting] to [code]true[/code] will not restart the emission cycle until after all active particles finish processing. You can use the [signal finished] signal to be notified once all active particles finish processing. How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. diff --git a/doc/classes/GPUParticles2D.xml b/doc/classes/GPUParticles2D.xml index e6d3c130cae3..2928215c3e33 100644 --- a/doc/classes/GPUParticles2D.xml +++ b/doc/classes/GPUParticles2D.xml @@ -50,7 +50,7 @@ Particle draw order. Uses [enum DrawOrder] values. - If [code]true[/code], particles are being emitted. + If [code]true[/code], particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is [code]true[/code] setting [member emitting] to [code]true[/code] will not restart the emission cycle until after all active particles finish processing. You can use the [signal finished] signal to be notified once all active particles finish processing. How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. diff --git a/doc/classes/GPUParticles3D.xml b/doc/classes/GPUParticles3D.xml index 0dc7c23315dc..4c0b2d12ed08 100644 --- a/doc/classes/GPUParticles3D.xml +++ b/doc/classes/GPUParticles3D.xml @@ -78,7 +78,7 @@ - If [code]true[/code], particles are being emitted. + If [code]true[/code], particles are being emitted. [member emitting] can be used to start and stop particles from emitting. However, if [member one_shot] is [code]true[/code] setting [member emitting] to [code]true[/code] will not restart the emission cycle until after all active particles finish processing. You can use the [signal finished] signal to be notified once all active particles finish processing. Time ratio between each emission. If [code]0[/code], particles are emitted continuously. If [code]1[/code], all particles are emitted simultaneously.