mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-21 10:25:24 +08:00
Code Issues Packages Projects Releases Wiki Activity
ffd4de67d0
godot/doc/classes/CPUParticles2D.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

376 lines
22 KiB
XML
Raw Normal View History

doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 16:08:05 +08:00
<class name="CPUParticles2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<brief_description>
Improve the top docs sections of VFX classes
2023-06-24 19:19:58 +08:00
A CPU-based 2D particle emitter.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</brief_description>
<description>
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
CPU-based 2D particle node used to create a variety of particle systems and effects.
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs.
2020-03-31 00:22:57 +08:00
See also [GPUParticles2D], which provides the same functionality with hardware acceleration, but may not run on older devices.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:43:07 +08:00
<link title="Particle systems (2D)">$DOCS_URL/tutorials/2d/particle_systems_2d.html</link>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</tutorials>
<methods>
<method name="convert_from_particles">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="particles" type="Node" />
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<description>
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 17:09:22 +08:00
Sets this node's properties to match a given [GPUParticles2D] node with an assigned [ParticleProcessMaterial].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<method name="get_param_curve" qualifiers="const">
<return type="Curve" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Returns the [Curve] of the parameter specified by [enum Parameter].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<method name="get_param_max" qualifiers="const">
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
Fill random docs
2022-10-07 03:59:48 +08:00
Returns the maximum value range for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<method name="get_param_min" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
Fill random docs
2022-10-07 03:59:48 +08:00
Returns the minimum value range for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
<method name="get_particle_flag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
Fix miscellaneous oddities around the class reference
2024-08-19 00:51:37 +08:00
Returns the enabled state of the given particle flag (see [enum ParticleFlags] for options).
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<method name="restart">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<description>
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Restarts the particle emitter.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<method name="set_param_curve">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<param index="1" name="curve" type="Curve" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Sets the [Curve] of the parameter specified by [enum Parameter].
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<method name="set_param_max">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<param index="1" name="value" type="float" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
Fill random docs
2022-10-07 03:59:48 +08:00
Sets the maximum value for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<method name="set_param_min">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="param" type="int" enum="CPUParticles2D.Parameter" />
<param index="1" name="value" type="float" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
Fill random docs
2022-10-07 03:59:48 +08:00
Sets the minimum value for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
<method name="set_particle_flag">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 21:28:05 +08:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-07 02:11:48 +08:00
<param index="0" name="particle_flag" type="int" enum="CPUParticles2D.ParticleFlags" />
<param index="1" name="enable" type="bool" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
<description>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 07:35:57 +08:00
Enables or disables the given flag (see [enum ParticleFlags] for options).
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 22:10:09 +08:00
</description>
</method>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="amount" type="int" setter="set_amount" getter="get_amount" default="8">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Number of particles emitted in one emission cycle.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="angle_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's rotation will be animated along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="angle_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum initial rotation applied to each particle, in degrees.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="angle_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member angle_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's angular velocity will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member angular_velocity_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's animation offset will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="anim_offset_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
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].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="anim_offset_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member anim_offset_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="anim_speed_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's animation speed will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="anim_speed_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
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.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="anim_speed_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member anim_speed_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
Add keywords to improve search in the class reference
2024-02-22 01:51:08 +08:00
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color(1, 1, 1, 1)" keywords="colour">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's initial color. If [member texture] is defined, it will be multiplied by this color.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
Random initial color parameter for ParticleMaterial Works with 2D and 3D GPU Particles
2021-11-23 20:50:35 +08:00
<member name="color_initial_ramp" type="Gradient" setter="set_color_initial_ramp" getter="get_color_initial_ramp">
Each particle's initial color will vary along this [GradientTexture1D] (multiplied with [member color]).
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
Fix color properties of particle nodes/material
2021-07-04 08:14:31 +08:00
Each particle's color will vary along this [Gradient] (multiplied with [member color]).
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="damping_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Damping will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="damping_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
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.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="damping_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member damping_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="direction" type="Vector2" setter="set_direction" getter="get_direction" default="Vector2(1, 0)">
doc: Sync classref with current source
2019-07-02 18:04:26 +08:00
Unit vector specifying the particles' emission direction.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles2D.DrawOrder" default="0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Particle draw order. Uses [enum DrawOrder] values.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
<member name="emission_colors" type="PackedColorArray" setter="set_emission_colors" getter="get_emission_colors">
Complete various class references
2020-01-26 13:59:51 +08:00
Sets the [Color]s to modulate particles by when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
<member name="emission_normals" type="PackedVector2Array" setter="set_emission_normals" getter="get_emission_normals">
Complete various class references
2020-01-26 13:59:51 +08:00
Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source Handle removal of Pool*Array types and other recent changes.
2020-02-18 20:59:24 +08:00
<member name="emission_points" type="PackedVector2Array" setter="set_emission_points" getter="get_emission_points">
Complete various class references
2020-01-26 13:59:51 +08:00
Sets the initial positions to spawn particles when using [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-30 03:22:15 +08:00
<member name="emission_rect_extents" type="Vector2" setter="set_emission_rect_extents" getter="get_emission_rect_extents">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 06:04:55 +08:00
The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_RECTANGLE].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles2D.EmissionShape" default="0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Particles will be emitted inside this region. See [enum EmissionShape] for possible values.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-30 03:22:15 +08:00
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
doc: Sync classref with current source Fix a few bugs.
2019-06-18 21:07:31 +08:00
The sphere's radius if [member emission_shape] is set to [constant EMISSION_SHAPE_SPHERE].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting" default="true">
Add detail to emitting docs for particles Highlight when emitting will and won't restart emission
2023-07-21 04:03:59 +08:00
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.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
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.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps" default="0">
Fix small mistakes throughout much of the documentation
2022-10-20 10:09:17 +08:00
The particle system's frame rate is fixed to a value. For example, 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.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta" default="true">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
Better format arguments in variant parser
2019-09-25 01:45:03 +08:00
<member name="gravity" type="Vector2" setter="set_gravity" getter="get_gravity" default="Vector2(0, 980)">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Gravity applied to every particle.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="hue_variation_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's hue will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="hue_variation_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="hue_variation_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member hue_variation_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="initial_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum initial velocity magnitude for each particle. Direction comes from [member direction] and [member spread].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="initial_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member initial_velocity_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime" default="1.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Amount of time each particle will exist.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
added individual particle random lifetime
2019-07-15 12:48:20 +08:00
<member name="lifetime_randomness" type="float" setter="set_lifetime_randomness" getter="get_lifetime_randomness" default="0.0">
Particle lifetime randomness ratio.
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="linear_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's linear acceleration will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="linear_accel_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum linear acceleration applied to each particle in the direction of motion.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="linear_accel_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member linear_accel_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
Use global coordinates for particles by default Particles won't move or rotate anymore with the node (or its parents) by default. This new default behavior is generally more suited to most use cases. Local coordinates can still be enabled on a per-node basis. This affects both 2D and 3D particles, and both CPU and GPU-based particles.
2022-06-09 23:38:07 +08:00
<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" default="false">
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 [CPUParticles2D] 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 [CPUParticles2D] node (and its parents) when it is moved or rotated.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
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.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="orbit_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's orbital velocity will vary along this [Curve].
Implement missing orbit velocity for CPUParticles and CPUParticles2D The relevant code was copied from (GPU) ParticlesMaterial but commented out initially, and never ported. Closes #29580.
2019-06-11 23:47:24 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="orbit_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="orbit_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member orbit_velocity_max].
Implement missing orbit velocity for CPUParticles and CPUParticles2D The relevant code was copied from (GPU) ParticlesMaterial but commented out initially, and never ported. Closes #29580.
2019-06-11 23:47:24 +08:00
</member>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 07:35:57 +08:00
<member name="particle_flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
Align Y axis of particle with the direction of its velocity.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Particle system starts as if it had already run for this many seconds.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="radial_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's radial acceleration will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="radial_accel_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="radial_accel_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member radial_accel_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="randomness" type="float" setter="set_randomness_ratio" getter="get_randomness_ratio" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Emission lifetime randomness ratio.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="scale_amount_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's scale will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="scale_amount_max" type="float" setter="set_param_max" getter="get_param_max" default="1.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum initial scale applied to each particle.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="scale_amount_min" type="float" setter="set_param_min" getter="get_param_min" default="1.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member scale_amount_max].
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="scale_curve_x" type="Curve" setter="set_scale_curve_x" getter="get_scale_curve_x">
Fill random docs
2022-10-07 03:59:48 +08:00
Each particle's horizontal scale will vary along this [Curve].
[member split_scale] must be enabled.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="scale_curve_y" type="Curve" setter="set_scale_curve_y" getter="get_scale_curve_y">
Fill random docs
2022-10-07 03:59:48 +08:00
Each particle's vertical scale will vary along this [Curve].
[member split_scale] must be enabled.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="speed_scale" type="float" setter="set_speed_scale" getter="get_speed_scale" default="1.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Particle system's running speed scaling ratio. A value of [code]0[/code] can be used to pause the particles.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="split_scale" type="bool" setter="set_split_scale" getter="get_split_scale" default="false">
Fill random docs
2022-10-07 03:59:48 +08:00
If [code]true[/code], the scale curve will be split into x and y components. See [member scale_curve_x] and [member scale_curve_y].
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 18:38:01 +08:00
<member name="spread" type="float" setter="set_spread" getter="get_spread" default="45.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 21:24:23 +08:00
Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source
2019-07-16 02:42:47 +08:00
<member name="tangential_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Each particle's tangential acceleration will vary along this [Curve].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
<member name="tangential_accel_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
</member>
<member name="tangential_accel_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-07 03:59:48 +08:00
Minimum equivalent of [member tangential_accel_max].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 16:59:06 +08:00
<member name="texture" type="Texture2D" setter="set_texture" getter="get_texture">
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 07:04:47 +08:00
Particle texture. If [code]null[/code], particles will be squares.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</member>
</members>
Add `finished` signal to CPUParticles
2023-05-09 16:18:08 +08:00
<signals>
<signal name="finished">
<description>
Emitted when all active particles have finished processing. When [member one_shot] is disabled, particles will process continuously, so this is never emitted.
</description>
</signal>
</signals>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<constants>
<constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Particles are drawn in the order emitted.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
Added docs for DRAW_ORDER_REVERSE_LIFETIME constant and minor XR log improvement
2023-10-06 00:41:05 +08:00
Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front.
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 06:04:55 +08:00
</constant>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set initial velocity properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set angular velocity properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set orbital velocity properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set linear acceleration properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set radial acceleration properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set tangential acceleration properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_DAMPING" value="6" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set damping properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_ANGLE" value="7" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set angle properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_SCALE" value="8" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set scale properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set hue variation properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set animation speed properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-14 01:46:27 +08:00
Use with [method set_param_min], [method set_param_max], and [method set_param_curve] to set animation offset properties.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="PARAM_MAX" value="12" enum="Parameter">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Represents the size of the [enum Parameter] enum.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 07:35:57 +08:00
<constant name="PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="ParticleFlags">
Use with [method set_particle_flag] to set [member particle_flag_align_y].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 07:35:57 +08:00
<constant name="PARTICLE_FLAG_ROTATE_Y" value="1" enum="ParticleFlags">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 06:04:55 +08:00
Present for consistency with 3D particle nodes, not used in 2D.
Implement missing orbit velocity for CPUParticles and CPUParticles2D The relevant code was copied from (GPU) ParticlesMaterial but commented out initially, and never ported. Closes #29580.
2019-06-11 23:47:24 +08:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 07:35:57 +08:00
<constant name="PARTICLE_FLAG_DISABLE_Z" value="2" enum="ParticleFlags">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 06:04:55 +08:00
Present for consistency with 3D particle nodes, not used in 2D.
Implement missing orbit velocity for CPUParticles and CPUParticles2D The relevant code was copied from (GPU) ParticlesMaterial but commented out initially, and never ported. Closes #29580.
2019-06-11 23:47:24 +08:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 07:35:57 +08:00
<constant name="PARTICLE_FLAG_MAX" value="3" enum="ParticleFlags">
Represents the size of the [enum ParticleFlags] enum.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
All particles will be emitted from a single point.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
change emit shape circle to sphere in CPUParticles2D
2019-06-18 02:59:31 +08:00
<constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape">
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-28 06:28:53 +08:00
Particles will be emitted in the volume of a sphere flattened to two dimensions.
</constant>
<constant name="EMISSION_SHAPE_SPHERE_SURFACE" value="2" enum="EmissionShape">
doc: Sync classref with current source Fix a few bugs.
2019-06-18 21:07:31 +08:00
Particles will be emitted on the surface of a sphere flattened to two dimensions.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-28 06:28:53 +08:00
<constant name="EMISSION_SHAPE_RECTANGLE" value="3" enum="EmissionShape">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 08:13:37 +08:00
Particles will be emitted in the area of a rectangle.
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-28 06:28:53 +08:00
<constant name="EMISSION_SHAPE_POINTS" value="4" enum="EmissionShape">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 06:04:55 +08:00
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-28 06:28:53 +08:00
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="5" enum="EmissionShape">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 06:04:55 +08:00
Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors].
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-28 06:28:53 +08:00
<constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape">
doc: Timer.autostart resets to false on start Fixes #35289.
2020-01-19 17:18:09 +08:00
Represents the size of the [enum EmissionShape] enum.
Validate input in (CPU)Particles set_emission_shape() Fixes #29777. Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 17:59:01 +08:00
</constant>
doc: Sync classref with current source
2018-08-30 04:25:11 +08:00
</constants>
</class>
Reference in New Issue Copy Permalink