diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 99411c73aa71..cd68bca45b3e 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -43,7 +43,7 @@ - Returns the enabled state of the given flag (see [enum ParticleFlags] for options). + Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options). @@ -81,7 +81,7 @@ - Enables or disables the given flag (see [enum ParticleFlags] for options). + Enables or disables the given particle flag (see [enum ParticleFlags] for options). @@ -99,13 +99,13 @@ Minimum equivalent of [member angle_max]. - Each particle's angular velocity will vary along this [Curve]. + Each particle's angular velocity (rotation speed) will vary along this [Curve] over its lifetime. Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second. - Minimum equivalent of [member angular_velocity_max]. + Minimum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second. Each particle's animation offset will vary along this [Curve]. diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 27726ff8a236..c2cafae1d383 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -93,10 +93,10 @@ Each particle's rotation will be animated along this [Curve]. - Maximum angle. + Maximum initial rotation applied to each particle, in degrees. - Minimum angle. + Minimum equivalent of [member angle_max]. Each particle's angular velocity (rotation speed) will vary along this [Curve] over its lifetime. @@ -111,19 +111,20 @@ Each particle's animation offset will vary along this [Curve]. - Maximum animation offset. + Maximum animation offset that corresponds to frame index in the texture. [code]0[/code] is the first frame, [code]1[/code] is the last one. See [member CanvasItemMaterial.particles_animation]. - Minimum animation offset. + Minimum equivalent of [member anim_offset_max]. Each particle's animation speed will vary along this [Curve]. - Maximum particle animation speed. + Maximum particle animation speed. Animation speed of [code]1[/code] means that the particles will make full [code]0[/code] to [code]1[/code] offset cycle during lifetime, [code]2[/code] means [code]2[/code] cycles etc. + With animation speed greater than [code]1[/code], remember to enable [member CanvasItemMaterial.particles_anim_loop] property if you want the animation to repeat. - Minimum particle animation speed. + Minimum equivalent of [member anim_speed_max]. Each particle's initial color. @@ -141,10 +142,10 @@ Damping will vary along this [Curve]. - Maximum damping. + The maximum rate at which particles lose velocity. For example value of [code]100[/code] means that the particle will go from [code]100[/code] velocity to [code]0[/code] in [code]1[/code] second. - Minimum damping. + Minimum equivalent of [member damping_max]. Unit vector specifying the particles' emission direction. @@ -153,7 +154,7 @@ Particle draw order. Uses [enum DrawOrder] values. - The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. + The box's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX]. Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS]. @@ -205,16 +206,16 @@ Each particle's hue will vary along this [Curve]. - Maximum hue variation. + Maximum initial hue variation applied to each particle. It will shift the particle color's hue. - Minimum hue variation. + Minimum equivalent of [member hue_variation_max]. - Maximum value of the initial velocity. + Maximum initial velocity magnitude for each particle. Direction comes from [member direction] and [member spread]. - Minimum value of the initial velocity. + Minimum equivalent of [member initial_velocity_max]. Amount of time each particle will exist. @@ -226,10 +227,10 @@ Each particle's linear acceleration will vary along this [Curve]. - Maximum linear acceleration. + Maximum linear acceleration applied to each particle in the direction of motion. - Minimum linear acceleration. + Minimum equivalent of [member linear_accel_max]. If [code]true[/code], particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the [CPUParticles3D] node (and its parents) when it is moved or rotated. If [code]false[/code], particles use global coordinates; they will not move or rotate along the [CPUParticles3D] node (and its parents) when it is moved or rotated. @@ -244,10 +245,10 @@ Each particle's orbital velocity will vary along this [Curve]. - Maximum orbit velocity. + Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second. - Minimum orbit velocity. + Minimum equivalent of [member orbit_velocity_max]. Align Y axis of particle with the direction of its velocity. @@ -265,10 +266,10 @@ Each particle's radial acceleration will vary along this [Curve]. - Maximum radial acceleration. + Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative. - Minimum radial acceleration. + Minimum equivalent of [member radial_accel_max]. Emission lifetime randomness ratio. @@ -277,10 +278,10 @@ Each particle's scale will vary along this [Curve]. - Maximum scale. + Maximum initial scale applied to each particle. - Minimum scale. + Minimum equivalent of [member scale_amount_max]. Curve for the scale over life, along the x axis. @@ -304,10 +305,10 @@ Each particle's tangential acceleration will vary along this [Curve]. - Maximum tangent acceleration. + Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. - Minimum tangent acceleration. + Minimum equivalent of [member tangential_accel_max]. The [AABB] that determines the node's region which needs to be visible on screen for the particle system to be active.