asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/CPUParticles.xml

380 lines
22 KiB
XML
Raw Normal View History

doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.5-beta
2021-11-05 15:02:42 +01:00
<class name="CPUParticles" inherits="GeometryInstance" version="3.5">
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<brief_description>
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
CPU-based 3D particle emitter.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</brief_description>
<description>
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
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.
Document the requirement to update GPU particle visibility This also updates some option names in the editor for consistency and accuracy. See #44955.
2021-01-06 19:15:03 +01:00
[b]Note:[/b] Unlike [Particles], the visibility rect is generated on-the-fly and doesn't need to be configured by the user.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
<tutorials>
</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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="particles" type="Node" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Sets this node's properties to match a given [Particles] node with an assigned [ParticlesMaterial].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
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 16:10:09 +02:00
<method name="get_param" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="param" type="int" enum="CPUParticles.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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Returns the base value 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 16:10:09 +02:00
</description>
</method>
<method name="get_param_curve" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Curve" />
<argument index="0" name="param" type="int" enum="CPUParticles.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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01: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 16:10:09 +02:00
</description>
</method>
<method name="get_param_randomness" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="float" />
<argument index="0" name="param" type="int" enum="CPUParticles.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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Returns the randomness factor 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 16:10:09 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument index="0" name="flag" type="int" enum="CPUParticles.Flags" />
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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Returns the enabled state of the given flag (see [enum Flags] 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 16:10:09 +02:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
<description>
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Restarts the particle emitter.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</description>
</method>
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 16:10:09 +02:00
<method name="set_param">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter" />
<argument 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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Sets the base value 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 16:10:09 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter" />
<argument 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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01: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 16:10:09 +02:00
</description>
</method>
<method name="set_param_randomness">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="param" type="int" enum="CPUParticles.Parameter" />
<argument index="1" name="randomness" 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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Sets the randomness factor 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 16:10:09 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="flag" type="int" enum="CPUParticles.Flags" />
<argument 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 16:10:09 +02:00
<description>
doc: Misc updates for AnimationNode* and others - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
2020-01-23 11:14:14 +01:00
Enables or disables the given flag (see [enum Flags] 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 16:10:09 +02:00
</description>
</method>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="amount" type="int" setter="set_amount" getter="get_amount" default="8">
Document that changing the particle amount resets emission See #16352.
2020-12-11 01:35:46 +01:00
The number of particles emitted in one emission cycle (corresponding to the [member lifetime]).
[b]Note:[/b] Changing [member amount] will reset the particle emission, therefore removing all particles that were already emitted before changing [member amount].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="angle" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Initial rotation applied to each particle, in degrees.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="angle_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's rotation will be animated along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="angle_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Rotation randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="angular_velocity" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Initial angular velocity applied to each particle. Sets the speed of rotation of the particle.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="angular_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's angular velocity will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="angular_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Angular velocity randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="anim_offset" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particle animation offset.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="anim_offset_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's animation offset will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="anim_offset_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Animation offset randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="anim_speed" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particle animation speed.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="anim_speed_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's animation speed will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="anim_speed_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Animation speed randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
Fix color properties of particle nodes/material (cherry picked from commit 3a4a2198edbdd5222eac2746881ceda3b96fbe48)
2021-07-04 02:14:31 +02:00
Each particle's initial color. To have particle display color in a [SpatialMaterial] make sure to set [member SpatialMaterial.vertex_color_use_as_albedo] to [code]true[/code].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="color_ramp" type="Gradient" setter="set_color_ramp" getter="get_color_ramp">
Fix color properties of particle nodes/material (cherry picked from commit 3a4a2198edbdd5222eac2746881ceda3b96fbe48)
2021-07-04 02:14:31 +02:00
Each particle's color will vary along this [GradientTexture] over its lifetime (multiplied with [member color]).
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="damping" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
The rate at which particles lose velocity.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="damping_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Damping will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="damping_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Damping randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-02 12:04:26 +02:00
<member name="direction" type="Vector3" setter="set_direction" getter="get_direction" default="Vector3( 1, 0, 0 )">
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 12:38:01 +02:00
<member name="draw_order" type="int" setter="set_draw_order" getter="get_draw_order" enum="CPUParticles.DrawOrder" default="0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Particle draw order. Uses [enum DrawOrder] values.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 00:04:55 +02:00
The rectangle's extents if [member emission_shape] is set to [constant EMISSION_SHAPE_BOX].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
Added ring emitter for 3D particles This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. ring_emitter_axis: the axis along which the ring/cylinder will be constructed 2. ring_emitter_radius: outer radius of the ring/cylinder 3. ring_emitter_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. ring_emitter_height: height of the ring/cylinder emitter. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2021-04-11 18:08:28 +02:00
<member name="emission_colors" type="PoolColorArray" setter="set_emission_colors" getter="get_emission_colors">
Complete various class references
2020-01-26 06:59:51 +01: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_normals" type="PoolVector3Array" setter="set_emission_normals" getter="get_emission_normals">
Complete various class references
2020-01-26 06:59:51 +01:00
Sets the direction the particles will be emitted in when using [constant EMISSION_SHAPE_DIRECTED_POINTS].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
Added ring emitter for 3D particles This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. ring_emitter_axis: the axis along which the ring/cylinder will be constructed 2. ring_emitter_radius: outer radius of the ring/cylinder 3. ring_emitter_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. ring_emitter_height: height of the ring/cylinder emitter. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2021-04-11 18:08:28 +02:00
<member name="emission_points" type="PoolVector3Array" setter="set_emission_points" getter="get_emission_points">
Complete various class references
2020-01-26 06:59:51 +01: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
Added ring emitter for 3D particles This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. ring_emitter_axis: the axis along which the ring/cylinder will be constructed 2. ring_emitter_radius: outer radius of the ring/cylinder 3. ring_emitter_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. ring_emitter_height: height of the ring/cylinder emitter. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2021-04-11 18:08:28 +02:00
<member name="emission_ring_axis" type="Vector3" setter="set_emission_ring_axis" getter="get_emission_ring_axis">
The axis for the ring shaped emitter when using [constant EMISSION_SHAPE_RING].
</member>
<member name="emission_ring_height" type="float" setter="set_emission_ring_height" getter="get_emission_ring_height">
The height for the ring shaped emitter when using [constant EMISSION_SHAPE_RING].
</member>
<member name="emission_ring_inner_radius" type="float" setter="set_emission_ring_inner_radius" getter="get_emission_ring_inner_radius">
The inner radius for the ring shaped emitter when using [constant EMISSION_SHAPE_RING].
</member>
<member name="emission_ring_radius" type="float" setter="set_emission_ring_radius" getter="get_emission_ring_radius">
The radius for the ring shaped emitter when using [constant EMISSION_SHAPE_RING].
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="CPUParticles.EmissionShape" default="0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Particles will be emitted inside this region. See [enum EmissionShape] for possible values.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
The sphere's radius if [enum EmissionShape] is set to [constant EMISSION_SHAPE_SPHERE].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="emitting" type="bool" setter="set_emitting" getter="is_emitting" default="true">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], particles are being emitted.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps" default="0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
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.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
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 01:04:47 +02:00
Align Y axis of particle with the direction of its velocity.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="flag_disable_z" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], particles will not move on the z axis.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="flag_rotate_y" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
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 01:04:47 +02:00
If [code]true[/code], particles rotate around Y axis by [member angle].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="flatness" type="float" setter="set_flatness" getter="get_flatness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Amount of [member spread] in Y/Z plane. A value of [code]1[/code] restricts particles to X/Z plane.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02:00
If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="gravity" type="Vector3" setter="set_gravity" getter="get_gravity" default="Vector3( 0, -9.8, 0 )">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Gravity applied to every particle.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="hue_variation" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Initial hue variation applied to each particle.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="hue_variation_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's hue will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="hue_variation_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Hue variation randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="initial_velocity" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="initial_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Initial velocity randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime" default="1.0">
Document that changing the particle amount resets emission See #16352.
2020-12-11 01:35:46 +01:00
The amount of time each particle will exist (in seconds).
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
added individual particle random lifetime
2019-07-15 06:48:20 +02:00
<member name="lifetime_randomness" type="float" setter="set_lifetime_randomness" getter="get_lifetime_randomness" default="0.0">
Particle lifetime randomness ratio.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="linear_accel" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Linear acceleration applied to each particle in the direction of motion.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="linear_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's linear acceleration will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="linear_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Linear acceleration randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates" default="true">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="mesh" type="Mesh" setter="set_mesh" getter="get_mesh">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
The [Mesh] used for each particle. If [code]null[/code], particles will be spheres.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="orbit_velocity" type="float" setter="set_param" getter="get_param">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 00:04:55 +02:00
Orbital velocity applied to each particle. Makes the particles circle around origin in the local XY plane. Specified in number of full rotations around origin per second.
This property is only available when [member flag_disable_z] is [code]true[/code].
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 17:47:24 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="orbit_velocity_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02: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 17:47:24 +02:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 21:22:15 +02:00
<member name="orbit_velocity_random" type="float" setter="set_param_randomness" getter="get_param_randomness">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Orbital velocity randomness ratio.
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 17:47:24 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 02:13:37 +02:00
Particle system starts as if it had already run for this many seconds.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="radial_accel" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Radial acceleration applied to each particle. Makes particle accelerate away from origin.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="radial_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's radial acceleration will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="radial_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Radial acceleration randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02:00
Emission lifetime randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="scale_amount" type="float" setter="set_param" getter="get_param" default="1.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Initial scale applied to each particle.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="scale_amount_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's scale will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="scale_amount_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Scale randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02:00
Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees. Applied to X/Z plane and Y/Z planes.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="tangential_accel" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
<member name="tangential_accel_curve" type="Curve" setter="set_param_curve" getter="get_param_curve">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Each particle's tangential acceleration will vary along this [Curve].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="tangential_accel_random" type="float" setter="set_param_randomness" getter="get_param_randomness" default="0.0">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 15:24:23 +02:00
Tangential acceleration randomness ratio.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</member>
</members>
<constants>
<constant name="DRAW_ORDER_INDEX" value="0" enum="DrawOrder">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particles are drawn in the order emitted.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="DRAW_ORDER_LIFETIME" value="1" enum="DrawOrder">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particles are drawn in order of remaining lifetime.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="DRAW_ORDER_VIEW_DEPTH" value="2" enum="DrawOrder">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particles are drawn in order of depth.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set initial velocity properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set angular velocity properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set orbital velocity properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set linear acceleration properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set radial acceleration properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set tangential acceleration properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_DAMPING" value="6" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set damping properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_ANGLE" value="7" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set angle properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_SCALE" value="8" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set scale properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set hue variation properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set animation speed properties.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_param], [method set_param_randomness], and [method set_param_curve] to set animation offset properties.
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 17:47:24 +02:00
</constant>
<constant name="PARAM_MAX" value="12" enum="Parameter">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Represents the size of the [enum Parameter] enum.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_particle_flag] to set [member flag_align_y].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="FLAG_ROTATE_Y" value="1" enum="Flags">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_particle_flag] to set [member flag_rotate_y].
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
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 17:47:24 +02:00
<constant name="FLAG_DISABLE_Z" value="2" enum="Flags">
doc: Sync classref with current source
2019-07-15 20:42:47 +02:00
Use with [method set_particle_flag] to set [member flag_disable_z].
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 17:47:24 +02:00
</constant>
doc: Sync classref with current source
2018-11-10 14:21:34 +01:00
<constant name="FLAG_MAX" value="3" enum="Flags">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Represents the size of the [enum Flags] enum.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
All particles will be emitted from a single point.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particles will be emitted in the volume of a sphere.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 02:13:37 +02:00
Particles will be emitted in the volume of a box.
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 00:04:55 +02: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 00:04:55 +02: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 Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constant>
Added ring emitter for 3D particles This commits adds a new emitter type for particles material and 3D CPU particles. The new emitter is called "ring" and it can emit either in a ring or cylinder fashion. This adds the following properties for the emitter: 1. ring_emitter_axis: the axis along which the ring/cylinder will be constructed 2. ring_emitter_radius: outer radius of the ring/cylinder 3. ring_emitter_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. ring_emitter_height: height of the ring/cylinder emitter. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2021-04-11 18:08:28 +02:00
<constant name="EMISSION_SHAPE_RING" value="5" enum="EmissionShape">
Particles will be emitted in a ring or cylinder.
</constant>
<constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape">
Validate input in (CPU)Particles set_emission_shape() Fixes #29777. Co-authored-by: Cameron Reikes <cameronreikes@gmail.com>
2020-01-16 10:59:01 +01:00
Represents the size of the [enum EmissionShape] enum.
</constant>
doc: Sync classref with current source Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
</constants>
</class>
Reference in a new issue Copy permalink