From 1a9fc25e00da368c70ea75a24ada3eb78c997a2d Mon Sep 17 00:00:00 2001 From: kobewi Date: Fri, 1 Jul 2022 15:09:41 +0200 Subject: [PATCH] Restore and improve some ParticlesMaterial docs --- doc/classes/ParticlesMaterial.xml | 45 +++++++++++++++++-------------- 1 file changed, 25 insertions(+), 20 deletions(-) diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 885bedbc044..354fbd462cc 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -77,28 +77,30 @@ Each particle's rotation will be animated along this [CurveTexture]. - Maximum angle. + Maximum initial rotation applied to each particle, in degrees. + Only applied when [member particle_flag_disable_z] or [member particle_flag_rotate_y] are [code]true[/code] or the [BaseMaterial3D] being used to draw the particle is using [constant BaseMaterial3D.BILLBOARD_PARTICLES]. - Minimum angle. + Minimum equivalent of [member angle_max]. Each particle's angular velocity (rotation speed) will vary along this [CurveTexture] over its lifetime. Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second. + Only applied when [member particle_flag_disable_z] or [member particle_flag_rotate_y] are [code]true[/code] or the [BaseMaterial3D] being used to draw the particle is using [constant BaseMaterial3D.BILLBOARD_PARTICLES]. - Minimum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second. + Minimum equivalent of [member angular_velocity_max]. Each particle's animation offset will vary along this [CurveTexture]. - 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 [CurveTexture]. @@ -108,7 +110,7 @@ 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]. True if the interaction with particle attractors is enabled. @@ -138,8 +140,10 @@ Damping will vary along this [CurveTexture]. + 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 equivalent of [member damping_max]. Unit vector specifying the particles' emission direction. @@ -187,16 +191,16 @@ Each particle's hue will vary along this [CurveTexture]. - 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 initial velocity. + Maximum initial velocity magnitude for each particle. Direction comes from [member direction] and [member spread]. - Minimum initial velocity. + Minimum equivalent of [member initial_velocity_max]. Particle lifetime randomness ratio. The lifetime will be multiplied by a value interpolated between [code]1.0[/code] and a random number less than one. For example a random ratio of [code]0.4[/code] would scale the original lifetime between [code]0.4-1.0[/code] of its original value. @@ -205,19 +209,20 @@ Each particle's linear acceleration will vary along this [CurveTexture]. - Maximum linear acceleration. + Maximum linear acceleration applied to each particle in the direction of motion. - Minimum linear acceleration. + Minimum equivalent of [member linear_accel_min]. Each particle's orbital velocity will vary along this [CurveTexture]. - 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. + Only available when [member particle_flag_disable_z] is [code]true[/code]. - Minimum orbit velocity. + Minimum equivalent of [member orbit_velocity_max]. Align Y axis of particle with the direction of its velocity. @@ -232,19 +237,19 @@ Each particle's radial acceleration will vary along this [CurveTexture]. - 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]. Each particle's scale will vary along this [CurveTexture]. If a [CurveXYZTexture] is supplied instead, the scale will be separated per-axis. - Maximum scale. + Maximum initial scale applied to each particle. - Minimum scale. + Minimum equivalent of [member scale_max]. Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. @@ -261,10 +266,10 @@ Each particle's tangential acceleration will vary along this [CurveTexture]. - Maximum tangential acceleration. + Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. - Minimum tangential acceleration. + Minimum equivalent of [member tangential_accel_max].