diff --git a/doc/classes/CPUParticles.xml b/doc/classes/CPUParticles.xml index 9cf38aeb6bf..a8aa29a81c2 100644 --- a/doc/classes/CPUParticles.xml +++ b/doc/classes/CPUParticles.xml @@ -1,8 +1,11 @@ + CPU-based 3D particle emitter. + CPU-based 3D particle node used to create a variety of particle systems and effects. + See also [Particles], which provides the same functionality with hardware acceleration, but may not run on older devices. @@ -13,56 +16,77 @@ + Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial]. + Restarts the particle emitter. + Number of particles emitted in one emission cycle. + Initial rotation applied to each particle, in degrees. + Each particle's rotation will be animated along this [Curve]. + Rotation randomness ratio. Default value: [code]0[/code]. + Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. + Each particle's angular velocity will vary along this [Curve]. + Angular velocity randomness ratio. Default value: [code]0[/code]. + Particle animation offset. + Each particle's animation offset will vary along this [Curve]. + Animation offset randomness ratio. Default value: [code]0[/code]. + Particle animation speed. + Each particle's animation speed will vary along this [Curve]. + Animation speed randomness ratio. Default value: [code]0[/code]. + Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. - Each particle's vertex color will vary along this [GradientTexture]. + Each particle's color will vary along this [Gradient]. + The rate at which particles lose velocity. + Damping will vary along this [Curve]. + Damping randomness ratio. Default value: [code]0[/code]. + Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX]. + The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_BOX]. @@ -71,124 +95,186 @@ + Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. + The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE]. + If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. + 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. Default value: [code]0[/code]. + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. + Align y-axis of particle with the direction of its velocity. + If [code]true[/code], particles will not move on the z axis. Default value: [code]false[/code]. + If [code]true[/code], particles rotate around y-axis by [member angle]. + Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. Default [code]0[/code]. + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code] + Gravity applied to every particle. Default value: [code](0, -9.8, 0)[/code]. + Initial hue variation applied to each particle. + Each particle's hue will vary along this [Curve]. + Hue variation randomness ratio. Default value: [code]0[/code]. + Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation. + Initial velocity randomness ratio. Default value: [code]0[/code]. + Amount of time each particle will exist. Default value: [code]1[/code]. + Linear acceleration applied to each particle in the direction of motion. + Each particle's linear acceleration will vary along this [Curve]. + Linear acceleration randomness ratio. Default value: [code]0[/code]. + If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. + The [Mesh] used for each particle. If [code]null[/code], particles will be spheres. + If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code]. + Particle system starts as if it had already run for this many seconds. + Radial acceleration applied to each particle. Makes particle accelerate away from origin. + Each particle's radial acceleration will vary along this [Curve]. + Radial acceleration randomness ratio. Default value: [code]0[/code]. + Emission lifetime randomness ratio. Default value: [code]0[/code]. + Initial scale applied to each particle. + Each particle's scale will vary along this [Curve]. + Scale randomness ratio. Default value: [code]0[/code]. + Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. + Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Default value: [code]45[/code]. + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. + Each particle's tangential acceleration will vary along this [Curve]. + Tangential acceleration randomness ratio. Default value: [code]0[/code]. + Particles are drawn in the order emitted. + Particles are drawn in order of remaining lifetime. + Particles are drawn in order of depth. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital velocity properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue variation properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties. - + + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties. + + + Represents the size of the [enum Parameter] enum. + Use with [method set_flag] to set [member flag_align_y]. + Use with [method set_flag] to set [member flag_rotate_y]. + Represents the size of the [enum Flags] enum. + All particles will be emitted from a single point. + Particles will be emitted in the volume of a sphere. + Particles will be emitted in the volume of a box. + Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index cd860a2e707..68659d051d4 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -1,10 +1,14 @@ + CPU-based 2D particle emitter. + CPU-based 2D particle node used to create a variety of particle systems and effects. + See also [Particles2D], which provides the same functionality with hardware acceleration, but may not run on older devices. + https://docs.godotengine.org/en/latest/tutorials/2d/particle_systems_2d.html @@ -13,53 +17,74 @@ + Sets this node's properties to match a given [Particles2D] node with an assigned [ParticlesMaterial]. + Restarts the particle emitter. + Number of particles emitted in one emission cycle. + Initial rotation applied to each particle, in degrees. + Each particle's rotation will be animated along this [Curve]. + Rotation randomness ratio. Default value: [code]0[/code]. + Initial angular velocity applied to each particle. Sets the speed of rotation of the particle. + Each particle's angular velocity will vary along this [Curve]. + Angular velocity randomness ratio. Default value: [code]0[/code]. + Particle animation offset. + Each particle's animation offset will vary along this [Curve]. + Animation offset randomness ratio. Default value: [code]0[/code]. + Particle animation speed. + Each particle's animation speed will vary along this [Curve]. + Animation speed randomness ratio. Default value: [code]0[/code]. + Each particle's initial color. If [member texture] is defined, it will be multiplied by this color. + Each particle's color will vary along this [Gradient]. + The rate at which particles lose velocity. + Damping will vary along this [Curve]. + Damping randomness ratio. Default value: [code]0[/code]. + Particle draw order. Uses [enum DrawOrder] values. Default value: [constant DRAW_ORDER_INDEX]. @@ -68,122 +93,178 @@ + The rectangle's extents if [member emission_shape] is set to [const EMISSION_SHAPE_RECTANGLE]. + Particles will be emitted inside this region. Use [enum EmissionShape] for values. Default value: [constant EMISSION_SHAPE_POINT]. + The circle's radius if [member emission_shape] is set to [const EMISSION_SHAPE_CIRCLE]. + If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. + 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. Default value: [code]0[/code]. + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. + Align y-axis of particle with the direction of its velocity. + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code] + Gravity applied to every particle. Default value: [code](0, 98)[/code]. + Initial hue variation applied to each particle. + Each particle's hue will vary along this [Curve]. + Hue variation randomness ratio. Default value: [code]0[/code]. + Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation. + Initial velocity randomness ratio. Default value: [code]0[/code]. + Amount of time each particle will exist. Default value: [code]1[/code]. + Linear acceleration applied to each particle in the direction of motion. + Each particle's linear acceleration will vary along this [Curve]. + Linear acceleration randomness ratio. Default value: [code]0[/code]. + If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. + Normal map to be used for the [member texture] property. + If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code]. + Particle system starts as if it had already run for this many seconds. + Radial acceleration applied to each particle. Makes particle accelerate away from origin. + Each particle's radial acceleration will vary along this [Curve]. + Radial acceleration randomness ratio. Default value: [code]0[/code]. + Emission lifetime randomness ratio. Default value: [code]0[/code]. + Initial scale applied to each particle. + Each particle's scale will vary along this [Curve]. + Scale randomness ratio. Default value: [code]0[/code]. + Particle system's running speed scaling ratio. Default value: [code]1[/code]. A value of [code]0[/code] can be used to pause the particles. + Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Default value: [code]45[/code]. + Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion. + Each particle's tangential acceleration will vary along this [Curve]. + Tangential acceleration randomness ratio. Default value: [code]0[/code]. + Particle texture. If [code]null[/code] particles will be squares. + Particles are drawn in the order emitted. + Particles are drawn in order of remaining lifetime. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital velocity properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue variation properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties. + Represents the size of the [enum Parameter] enum. + Use with [method set_flag] to set [member flag_align_y]. + All particles will be emitted from a single point. + Particles will be emitted on the perimeter of a circle. + Particles will be emitted in the area of a rectangle. + Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. + Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index 0e920b41966..1a277213b74 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -55,8 +55,10 @@ Time ratio between each emission. If [code]0[/code] particles are emitted continuously. If [code]1[/code] all particles are emitted simultaneously. Default value: [code]0[/code]. + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. + If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]. Amount of time each particle will exist. Default value: [code]1[/code]. diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index 854fce7fe28..46d37da87c3 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -40,7 +40,7 @@ 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. Default value: [code]0[/code]. - The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself. + The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the simulation of the particle system itself. If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code] @@ -52,7 +52,7 @@ If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code]. - Normal map to be used for the [code]texture[/code] property. + Normal map to be used for the [member texture] property. If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code]. diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index 4b4161ad43a..ee6e5a0dd67 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -100,7 +100,7 @@ Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane. Default [code]0[/code]. - Gravity applied to every particle. Default value: [code](0, 98, 0)[/code]. + Gravity applied to every particle. Default value: [code](0, -9.8, 0)[/code]. Initial hue variation applied to each particle. @@ -112,13 +112,13 @@ Hue variation randomness ratio. Default value: [code]0[/code]. - Initial velocity magnitude for each particle. Direction comes from [member spread]. + Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation. Initial velocity randomness ratio. Default value: [code]0[/code]. - Linear acceleration applied to each particle. Acceleration increases velocity magnitude each frame without affecting direction. + Linear acceleration applied to each particle in the direction of motion. Each particle's linear acceleration will vary along this [CurveTexture]. @@ -184,7 +184,7 @@ Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties. - Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital_velocity properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital velocity properties. Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties. @@ -205,7 +205,7 @@ Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties. - Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue_variation properties. + Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue variation properties. Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties.