godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/ParticlesMaterial.xml

339 lines
22 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 16:51:38 +00:00
<class name="ParticlesMaterial" inherits="Material" version="3.6" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Particle properties for [Particles] and [Particles2D] nodes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
ParticlesMaterial defines particle properties and behavior. It is used in the [code]process_material[/code] of [Particles] and [Particles2D] emitter nodes.
Some of this material's properties are applied to each particle when emitted, while others can have a [CurveTexture] applied to vary values over the lifetime of the particle.
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
When a randomness ratio is applied to a property it is used to scale that property by a random amount. The random ratio is used to interpolate between [code]1.0[/code] and a random number less than one, the result is multiplied by the property to obtain the randomized property. For example a random ratio of [code]0.4[/code] would scale the original property between [code]0.4-1.0[/code] of its original value.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
</tutorials>
<methods>
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 14:10:09 +00:00
<method name="get_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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="flag" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Returns [code]true[/code] if the specified flag is enabled.
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 14:10:09 +00:00
</description>
</method>
<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 13:28:05 +00:00
<return type="float" />
<argument index="0" name="param" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Returns the value of the specified 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 14:10:09 +00: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 13:28:05 +00:00
<return type="float" />
<argument index="0" name="param" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Returns the randomness ratio associated with the specified 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 14:10:09 +00:00
</description>
</method>
<method name="get_param_texture" 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 13:28:05 +00:00
<return type="Texture" />
<argument index="0" name="param" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Returns the [Texture] used by the specified 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 14:10:09 +00:00
</description>
</method>
<method name="set_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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="flag" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
If [code]true[/code], enables the specified 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 14:10:09 +00:00
</description>
</method>
<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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="param" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Sets the specified [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 14:10:09 +00: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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="param" type="int" enum="ParticlesMaterial.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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Sets the randomness ratio for the specified [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 14:10:09 +00:00
</description>
</method>
<method name="set_param_texture">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="param" type="int" enum="ParticlesMaterial.Parameter" />
<argument index="1" name="texture" type="Texture" />
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 14:10:09 +00:00
<description>
Complete various class references
2020-01-26 05:59:51 +00:00
Sets the [Texture] for the specified [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 14:10:09 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</methods>
<members>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="angle" type="float" setter="set_param" getter="get_param" default="0.0">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Initial rotation applied to each particle, in degrees.
Document that RigidBody angular velocity is in degrees per second This will be changed to radians per second in Godot 4.0, but it can't be changed in 3.x to preserve compatibility with existing projects.
2021-08-23 15:11:25 +00:00
[b]Note:[/b] Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="angle_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's rotation will be animated along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Rotation randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="angular_velocity" type="float" setter="set_param" getter="get_param" default="0.0">
Document that RigidBody angular velocity is in degrees per second This will be changed to radians per second in Godot 4.0, but it can't be changed in 3.x to preserve compatibility with existing projects.
2021-08-23 15:11:25 +00:00
Initial angular velocity applied to each particle in [i]degrees[/i] per second. Sets the speed of rotation of the particle.
[b]Note:[/b] Only applied when [member flag_disable_z] or [member flag_rotate_y] are [code]true[/code] or the [SpatialMaterial] being used to draw the particle is using [constant SpatialMaterial.BILLBOARD_PARTICLES].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="angular_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's angular velocity will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Angular velocity randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="anim_offset" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Particle animation offset.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="anim_offset_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's animation offset will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Animation offset randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="anim_speed" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Particle animation speed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="anim_speed_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's animation speed will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Animation speed randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="color" type="Color" setter="set_color" getter="get_color" default="Color( 1, 1, 1, 1 )">
Document 3D particle color properties requiring vertex color as albedo
2023-05-08 22:52:00 +00:00
Each particle's initial color. If the [Particles2D]'s or [Particles]'s [code]texture[/code] is defined, it will be multiplied by this color.
[b]Note:[/b] [member color] multiplies the particle mesh's vertex colors. To have a visible effect on a [SpatialMaterial], [member SpatialMaterial.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color] will have no visible effect.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Random initial color for all Particle Nodes
2021-12-10 15:35:25 +00:00
<member name="color_initial_ramp" type="Texture" setter="set_color_initial_ramp" getter="get_color_initial_ramp">
Each particle's initial color will vary along this [GradientTexture] (multiplied with [member color]).
Document 3D particle color properties requiring vertex color as albedo
2023-05-08 22:52:00 +00:00
[b]Note:[/b] [member color_initial_ramp] multiplies the particle mesh's vertex colors. To have a visible effect on a [SpatialMaterial], [member SpatialMaterial.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color_initial_ramp] will have no visible effect.
Random initial color for all Particle Nodes
2021-12-10 15:35:25 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="color_ramp" type="Texture" setter="set_color_ramp" getter="get_color_ramp">
Fix color properties of particle nodes/material (cherry picked from commit 3a4a2198edbdd5222eac2746881ceda3b96fbe48)
2021-07-04 00:14:31 +00:00
Each particle's color will vary along this [GradientTexture] over its lifetime (multiplied with [member color]).
Document 3D particle color properties requiring vertex color as albedo
2023-05-08 22:52:00 +00:00
[b]Note:[/b] [member color_ramp] multiplies the particle mesh's vertex colors. To have a visible effect on a [SpatialMaterial], [member SpatialMaterial.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member color_ramp] will have no visible effect.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="damping" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
The rate at which particles lose velocity.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="damping_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Damping will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Damping randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-02 10:04:26 +00: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: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="emission_box_extents" type="Vector3" setter="set_emission_box_extents" getter="get_emission_box_extents">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
The box's extents if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_BOX].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="emission_color_texture" type="Texture" setter="set_emission_color_texture" getter="get_emission_color_texture">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Particle color will be modulated by color determined by sampling this texture at the same point as the [member emission_point_texture].
Document 3D particle color properties requiring vertex color as albedo
2023-05-08 22:52:00 +00:00
[b]Note:[/b] [member emission_color_texture] multiplies the particle mesh's vertex colors. To have a visible effect on a [SpatialMaterial], [member SpatialMaterial.vertex_color_use_as_albedo] [i]must[/i] be [code]true[/code]. For a [ShaderMaterial], [code]ALBEDO *= COLOR.rgb;[/code] must be inserted in the shader's [code]fragment()[/code] function. Otherwise, [member emission_color_texture] will have no visible effect.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="emission_normal_texture" type="Texture" setter="set_emission_normal_texture" getter="get_emission_normal_texture">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
Particle velocity and rotation will be set by sampling this texture at the same point as the [member emission_point_texture]. Used only in [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="emission_point_count" type="int" setter="set_emission_point_count" getter="get_emission_point_count">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
The number of emission points if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_POINTS] or [constant EMISSION_SHAPE_DIRECTED_POINTS].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="emission_point_texture" type="Texture" setter="set_emission_point_texture" getter="get_emission_point_texture">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
Particles will be emitted at positions determined by sampling this texture at a random position. Used with [constant EMISSION_SHAPE_POINTS] and [constant EMISSION_SHAPE_DIRECTED_POINTS]. Can be created automatically from mesh or node by selecting "Create Emission Points from Mesh/Node" under the "Particles" tool in the toolbar.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Fix Ring-Axis parameter being always visible
2021-12-03 15:32:24 +00:00
<member name="emission_ring_axis" type="Vector3" setter="set_emission_ring_axis" getter="get_emission_ring_axis">
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 16:08:28 +00:00
The axis of the ring when using the emitter [constant EMISSION_SHAPE_RING].
</member>
<member name="emission_ring_height" type="float" setter="set_emission_ring_height" getter="get_emission_ring_height">
The height of the ring when using the emitter [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 of the ring when using the emitter [constant EMISSION_SHAPE_RING].
</member>
<member name="emission_ring_radius" type="float" setter="set_emission_ring_radius" getter="get_emission_ring_radius">
The radius of the ring when using the emitter [constant EMISSION_SHAPE_RING].
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticlesMaterial.EmissionShape" default="0">
doc: Markup fixes for enums and constants
2019-12-06 22:09:20 +00:00
Particles will be emitted inside this region. Use [enum EmissionShape] constants for values.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="emission_sphere_radius" type="float" setter="set_emission_sphere_radius" getter="get_emission_sphere_radius">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 10:34:26 +00:00
The sphere's radius if [code]emission_shape[/code] is set to [constant EMISSION_SHAPE_SPHERE].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="flag_align_y" type="bool" setter="set_flag" getter="get_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-21 23:04:47 +00:00
Align Y axis of particle with the direction of its velocity.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="flag_disable_z" type="bool" setter="set_flag" getter="get_flag" default="false">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
If [code]true[/code], particles will not move on the z axis.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="flag_rotate_y" type="bool" setter="set_flag" getter="get_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-21 23:04:47 +00:00
If [code]true[/code], particles rotate around Y axis by [member angle].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="flatness" type="float" setter="set_flatness" getter="get_flatness" default="0.0">
Fix ParticlesMaterial spread
2021-03-25 16:26:23 +00:00
Amount of [member spread] along the Y axis.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Gravity applied to every particle.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="hue_variation" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Initial hue variation applied to each particle.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="hue_variation_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's hue will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Hue variation randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="initial_velocity" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 00:13:37 +00:00
Initial velocity magnitude for each particle. Direction comes from [member spread] and the node's orientation.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Initial velocity randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
added individual particle random lifetime
2019-07-15 04:48:20 +00: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 10:38:01 +00:00
<member name="linear_accel" type="float" setter="set_param" getter="get_param" default="0.0">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 00:13:37 +00:00
Linear acceleration applied to each particle in the direction of motion.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="linear_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's linear acceleration will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Linear acceleration randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="orbit_velocity" type="float" setter="set_param" getter="get_param">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
Document that RigidBody angular velocity is in degrees per second This will be changed to radians per second in Godot 4.0, but it can't be changed in 3.x to preserve compatibility with existing projects.
2021-08-23 15:11:25 +00:00
[b]Note:[/b] Only available when [member flag_disable_z] is [code]true[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00:00
<member name="orbit_velocity_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's orbital velocity will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Remove null default values that can't be determined Applying #30187.
2019-06-29 19:22:15 +00: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 13:24:23 +00:00
Orbital velocity randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="radial_accel" type="float" setter="set_param" getter="get_param" default="0.0">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Radial acceleration applied to each particle. Makes particle accelerate away from origin.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="radial_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's radial acceleration will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Radial acceleration randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scale" type="float" setter="set_param" getter="get_param" default="1.0">
Allow negative scale in Particles and CPUParticles This can be used to make 2D particles look more 3D-y with thoughtful use of scale curve animation.
2021-10-15 16:35:33 +00:00
Initial scale applied to each particle. This can be set to a negative value to flip the particle on all axes.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="scale_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's scale will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="scale_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 13:24:23 +00:00
Scale randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="spread" type="float" setter="set_spread" getter="get_spread" default="45.0">
Fix ParticlesMaterial spread
2021-03-25 16:26:23 +00:00
Each particle's initial direction range from [code]+spread[/code] to [code]-spread[/code] degrees.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="tangential_accel" type="float" setter="set_param" getter="get_param" default="0.0">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="tangential_accel_curve" type="Texture" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Each particle's tangential acceleration will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00: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 13:24:23 +00:00
Tangential acceleration randomness ratio.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="trail_color_modifier" type="GradientTexture" setter="set_trail_color_modifier" getter="get_trail_color_modifier">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Trail particles' color will vary along this [GradientTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="trail_divisor" type="int" setter="set_trail_divisor" getter="get_trail_divisor" default="1">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Emitter will emit [code]amount[/code] divided by [code]trail_divisor[/code] particles. The remaining particles will be used as trail(s).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="trail_size_modifier" type="CurveTexture" setter="set_trail_size_modifier" getter="get_trail_size_modifier">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Trail particles' size will vary along this [CurveTexture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set initial velocity properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angular velocity properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 00:13:37 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set orbital velocity properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set linear acceleration properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set radial acceleration properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set tangential acceleration properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_DAMPING" value="6" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set damping properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_ANGLE" value="7" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set angle properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_SCALE" value="8" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set scale properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
[DOCS] Update CPUParticles[2D] classref
2019-06-14 00:13:37 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set hue variation properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation speed properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_param], [method set_param_randomness], and [method set_param_texture] to set animation offset properties.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="PARAM_MAX" value="12" enum="Parameter">
Bind missing FLAG_DISABLE_Z enum value in ParticlesMaterial Fixes #29419.
2019-06-03 09:18:09 +00:00
Represents the size of the [enum Parameter] enum.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="Flags">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Use with [method set_flag] to set [member flag_align_y].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="FLAG_ROTATE_Y" value="1" enum="Flags">
Bind missing FLAG_DISABLE_Z enum value in ParticlesMaterial Fixes #29419.
2019-06-03 09:18:09 +00:00
Use with [method set_flag] to set [member flag_rotate_y].
</constant>
<constant name="FLAG_DISABLE_Z" value="2" enum="Flags">
Use with [method set_flag] to set [member flag_disable_z].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Sync classref with current source
2018-11-10 13:21:34 +00:00
<constant name="FLAG_MAX" value="3" enum="Flags">
Bind missing FLAG_DISABLE_Z enum value in ParticlesMaterial Fixes #29419.
2019-06-03 09:18:09 +00:00
Represents the size of the [enum Flags] enum.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
All particles will be emitted from a single point.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Particles will be emitted in the volume of a sphere.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 19:30:32 +00:00
Particles will be emitted in the volume of a box.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 22:16:30 +00:00
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape">
clarified and filled out particles material doc
2019-01-06 20:52:15 +00:00
Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00: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 16:08:28 +00: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 09:59:01 +00:00
Represents the size of the [enum EmissionShape] enum.
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</constants>
</class>