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

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

431 lines
31 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:05 +02:00
<class name="ParticleProcessMaterial" inherits="Material" 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 22:42:36 +02:00
<brief_description>
Improve the top docs sections of VFX classes
2023-06-24 13:19:58 +02:00
Holds a particle configuration for [GPUParticles2D] or [GPUParticles3D] 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 22:42:36 +02:00
</brief_description>
<description>
Improve the top docs sections of VFX classes
2023-06-24 13:19:58 +02:00
[ParticleProcessMaterial] defines particle properties and behavior. It is used in the [code]process_material[/code] of the [GPUParticles2D] and [GPUParticles3D] nodes. Some of this material's properties are applied to each particle when emitted, while others can have a [CurveTexture] or a [GradientTexture1D] applied to vary numerical or color values over the lifetime of the 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 22:42:36 +02:00
</description>
<tutorials>
</tutorials>
<methods>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<method name="get_param_max" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="float" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="param" type="int" enum="ParticleProcessMaterial.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>
Fix usage of "Return" in the docs
2022-01-02 18:32:49 +01:00
Returns the maximum value range for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<method name="get_param_min" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="float" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="param" type="int" enum="ParticleProcessMaterial.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>
Fix usage of "Return" in the docs
2022-01-02 18:32:49 +01:00
Returns the minimum value range for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02: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.
2021-07-30 15:28:05 +02:00
<return type="Texture2D" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="param" type="int" enum="ParticleProcessMaterial.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: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
Returns the [Texture2D] 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 16:10:09 +02:00
</description>
</method>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<method name="get_particle_flag" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="particle_flag" type="int" enum="ParticleProcessMaterial.ParticleFlags" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
Returns [code]true[/code] if the specified particle flag is enabled. See [enum ParticleFlags] for options.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<method name="set_param_max">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="param" type="int" enum="ParticleProcessMaterial.Parameter" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="1" name="value" type="float" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Sets the maximum value range for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
</description>
</method>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<method name="set_param_min">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="param" type="int" enum="ParticleProcessMaterial.Parameter" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="1" name="value" type="float" />
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02:00
<description>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Sets the minimum value range for the given parameter.
DocData: Re-expose parametric setters and getters Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-27 16:10:09 +02: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.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="param" type="int" enum="ParticleProcessMaterial.Parameter" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="1" name="texture" type="Texture2D" />
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: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
Sets the [Texture2D] 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 16:10:09 +02:00
</description>
</method>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<method name="set_particle_flag">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<param index="0" name="particle_flag" type="int" enum="ParticleProcessMaterial.ParticleFlags" />
Rename the argument tag to param in XML documentation
2022-08-06 20:11:48 +02:00
<param index="1" name="enable" type="bool" />
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<description>
If [code]true[/code], enables the specified particle flag. See [enum ParticleFlags] for options.
</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 22:42:36 +02:00
</methods>
<members>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="angle_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="angle_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum initial rotation applied to each particle, in degrees.
Only applied when [member particle_flag_disable_z] or [member particle_flag_rotate_y] are [code]true[/code] or the [BaseMaterial3D] being used to draw the particle is using [constant BaseMaterial3D.BILLBOARD_PARTICLES].
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="angle_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member angle_max].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="angular_velocity_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
Document RigidBody2D/3D and particles' angular velocity units
2021-12-11 17:38:55 +01:00
Each particle's angular velocity (rotation speed) will vary along this [CurveTexture] over its lifetime.
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="angular_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Document RigidBody2D/3D and particles' angular velocity units
2021-12-11 17:38:55 +01:00
Maximum initial angular velocity (rotation speed) applied to each particle in [i]degrees[/i] per second.
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Only applied when [member particle_flag_disable_z] or [member particle_flag_rotate_y] are [code]true[/code] or the [BaseMaterial3D] being used to draw the particle is using [constant BaseMaterial3D.BILLBOARD_PARTICLES].
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="angular_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member angular_velocity_max].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="anim_offset_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="anim_offset_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum animation offset that corresponds to frame index in the texture. [code]0[/code] is the first frame, [code]1[/code] is the last one. See [member CanvasItemMaterial.particles_animation].
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="anim_offset_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member anim_offset_max].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="anim_speed_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="anim_speed_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Misc improvements to various docs
2021-11-30 22:32:23 +01:00
Maximum particle animation speed. Animation speed of [code]1[/code] means that the particles will make full [code]0[/code] to [code]1[/code] offset cycle during lifetime, [code]2[/code] means [code]2[/code] cycles etc.
With animation speed greater than [code]1[/code], remember to enable [member CanvasItemMaterial.particles_anim_loop] property if you want the animation to repeat.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
</member>
<member name="anim_speed_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member anim_speed_max].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
<member name="attractor_interaction_enabled" type="bool" setter="set_attractor_interaction_enabled" getter="is_attractor_interaction_enabled" default="true">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
True if the interaction with particle attractors is enabled.
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
</member>
Add "Hide on Contact" collision mode to ParticlesMaterial This can be used to make particles disappear when colliding, rather than bouncing around or sticking to surfaces. This is useful for rain particles which should not be able to go through floors/ceilings, but shouldn't stick to surfaces either.
2022-05-20 23:59:13 +02:00
<member name="collision_bounce" type="float" setter="set_collision_bounce" getter="get_collision_bounce">
The particles' bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness). Only effective if [member collision_mode] is [constant COLLISION_RIGID].
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
</member>
Add "Hide on Contact" collision mode to ParticlesMaterial This can be used to make particles disappear when colliding, rather than bouncing around or sticking to surfaces. This is useful for rain particles which should not be able to go through floors/ceilings, but shouldn't stick to surfaces either.
2022-05-20 23:59:13 +02:00
<member name="collision_friction" type="float" setter="set_collision_friction" getter="get_collision_friction">
The particles' friction. Values range from [code]0[/code] (frictionless) to [code]1[/code] (maximum friction). Only effective if [member collision_mode] is [constant COLLISION_RIGID].
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
</member>
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<member name="collision_mode" type="int" setter="set_collision_mode" getter="get_collision_mode" enum="ParticleProcessMaterial.CollisionMode" default="0">
Add "Hide on Contact" collision mode to ParticlesMaterial This can be used to make particles disappear when colliding, rather than bouncing around or sticking to surfaces. This is useful for rain particles which should not be able to go through floors/ceilings, but shouldn't stick to surfaces either.
2022-05-20 23:59:13 +02:00
The particles' collision mode.
Add documentation for GpuParticles2D collisions
2023-01-23 22:16:35 +01:00
[b]Note:[/b] 3D Particles can only collide with [GPUParticlesCollision3D] nodes, not [PhysicsBody3D] nodes. To make particles collide with various objects, you can add [GPUParticlesCollision3D] nodes as children of [PhysicsBody3D] nodes.
[b]Note:[/b] 2D Particles can only collide with [LightOccluder2D] nodes, not [PhysicsBody2D] nodes.
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
</member>
<member name="collision_use_scale" type="bool" setter="set_collision_use_scale" getter="is_collision_using_scale" default="false">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Should collision take scale into account.
doc: Sync classref with current source
2020-10-12 10:57:54 +02:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02: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
2022-08-29 16:16:42 +02:00
Each particle's initial color. If the [GPUParticles2D]'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 [BaseMaterial3D], [member BaseMaterial3D.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 22:42:36 +02:00
</member>
Random initial color parameter for ParticleMaterial Works with 2D and 3D GPU Particles
2021-11-23 13:50:35 +01:00
<member name="color_initial_ramp" type="Texture2D" setter="set_color_initial_ramp" getter="get_color_initial_ramp">
Each particle's initial color will vary along this [GradientTexture1D] (multiplied with [member color]).
Document 3D particle color properties requiring vertex color as albedo
2022-08-29 16:16:42 +02:00
[b]Note:[/b] [member color_initial_ramp] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.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 parameter for ParticleMaterial Works with 2D and 3D GPU Particles
2021-11-23 13:50:35 +01:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="color_ramp" type="Texture2D" setter="set_color_ramp" getter="get_color_ramp">
Rename `GradientTexture` to `GradientTexture1D` 1. Explicit and unambiguous when comparing to `GradientTexture2D` 2. Consistent with other class names where 1D is used in the engine.
2021-11-07 13:35:45 +01:00
Each particle's color will vary along this [GradientTexture1D] over its lifetime (multiplied with [member color]).
Document 3D particle color properties requiring vertex color as albedo
2022-08-29 16:16:42 +02:00
[b]Note:[/b] [member color_ramp] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="damping_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="damping_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
The maximum rate at which particles lose velocity. For example value of [code]100[/code] means that the particle will go from [code]100[/code] velocity to [code]0[/code] in [code]1[/code] second.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
</member>
<member name="damping_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member damping_max].
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 22:42:36 +02:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +02:00
<member name="direction" type="Vector3" setter="set_direction" getter="get_direction" default="Vector3(1, 0, 0)">
doc: Sync classref with current source
2019-07-02 12:04:26 +02:00
Unit vector specifying the particles' emission direction.
</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">
Validate `code` tags for class and member references This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
2023-10-02 20:11:43 +02:00
The box's extents if [member emission_shape] 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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="emission_color_texture" type="Texture2D" setter="set_emission_color_texture" getter="get_emission_color_texture">
clarified and filled out particles material doc
2019-01-06 21:52:15 +01: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
2022-08-29 16:16:42 +02:00
[b]Note:[/b] [member emission_color_texture] multiplies the particle mesh's vertex colors. To have a visible effect on a [BaseMaterial3D], [member BaseMaterial3D.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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="emission_normal_texture" type="Texture2D" setter="set_emission_normal_texture" getter="get_emission_normal_texture">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 12:34:26 +02: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 22:42:36 +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_point_count" type="int" setter="set_emission_point_count" getter="get_emission_point_count">
Validate `code` tags for class and member references This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
2023-10-02 20:11:43 +02:00
The number of emission points if [member emission_shape] 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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="emission_point_texture" type="Texture2D" setter="set_emission_point_texture" getter="get_emission_point_texture">
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 12:34:26 +02: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 22:42:36 +02:00
</member>
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. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 15:45:21 +02:00
<member name="emission_ring_axis" type="Vector3" setter="set_emission_ring_axis" getter="get_emission_ring_axis">
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>
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<member name="emission_shape" type="int" setter="set_emission_shape" getter="get_emission_shape" enum="ParticleProcessMaterial.EmissionShape" default="0">
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01: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 22:42:36 +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">
Validate `code` tags for class and member references This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
2023-10-02 20:11:43 +02:00
The sphere's radius if [member emission_shape] 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 22:42:36 +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">
Fix ParticlesMaterial spread
2021-03-25 17:33:33 +01: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 22:42:36 +02:00
</member>
Better format arguments in variant parser
2019-09-24 19:45:03 +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.
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="hue_variation_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="hue_variation_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum initial hue variation applied to each particle. It will shift the particle color's hue.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
</member>
<member name="hue_variation_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member hue_variation_max].
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="initial_velocity_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum initial velocity magnitude for each particle. Direction comes from [member direction] and [member spread].
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="initial_velocity_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member initial_velocity_max].
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 22:42:36 +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">
Correct description of ParticleProcessMaterial.lifetime_randomness
2023-06-27 13:15:57 +02:00
Particle lifetime randomness ratio. The equation for the lifetime of a particle is [code]lifetime * (1.0 - randf() * lifetime_randomness)[/code]. For example, a [member lifetime_randomness] of [code]0.4[/code] scales the lifetime between [code]0.6[/code] to [code]1.0[/code] of its original value.
added individual particle random lifetime
2019-07-15 06:48:20 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="linear_accel_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="linear_accel_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum 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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="linear_accel_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Fill random docs
2022-10-06 21:59:48 +02:00
Minimum equivalent of [member linear_accel_max].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="orbit_velocity_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="orbit_velocity_max" type="float" setter="set_param_max" getter="get_param_max">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.
Only available when [member particle_flag_disable_z] is [code]true[/code].
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
</member>
<member name="orbit_velocity_min" type="float" setter="set_param_min" getter="get_param_min">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member orbit_velocity_max].
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 22:42:36 +02:00
</member>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<member name="particle_flag_align_y" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
Align Y axis of particle with the direction of its velocity.
</member>
<member name="particle_flag_disable_z" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
If [code]true[/code], particles will not move on the z axis.
</member>
<member name="particle_flag_rotate_y" type="bool" setter="set_particle_flag" getter="get_particle_flag" default="false">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
If [code]true[/code], particles rotate around Y axis by [member angle_min].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="radial_accel_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="radial_accel_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.
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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="radial_accel_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member radial_accel_max].
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 22:42:36 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="scale_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Each particle's scale will vary along this [CurveTexture]. If a [CurveXYZTexture] is supplied instead, the scale will be separated per-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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="scale_max" type="float" setter="set_param_max" getter="get_param_max" default="1.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum initial scale applied to each particle.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
</member>
<member name="scale_min" type="float" setter="set_param_min" getter="get_param_min" default="1.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member scale_max].
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 22:42:36 +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">
Fix ParticlesMaterial spread
2021-03-25 17:33:33 +01: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 22:42:36 +02:00
</member>
particles: add amount property to sub property collision.
2022-09-24 14:22:37 +02:00
<member name="sub_emitter_amount_at_collision" type="int" setter="set_sub_emitter_amount_at_collision" getter="get_sub_emitter_amount_at_collision">
Sub particle amount on collision.
Maximum amount set in the sub particles emitter.
</member>
doc: Sync classref with current source Bind missing enums.
2020-09-11 12:22:10 +02:00
<member name="sub_emitter_amount_at_end" type="int" setter="set_sub_emitter_amount_at_end" getter="get_sub_emitter_amount_at_end">
</member>
<member name="sub_emitter_frequency" type="float" setter="set_sub_emitter_frequency" getter="get_sub_emitter_frequency">
</member>
<member name="sub_emitter_keep_velocity" type="bool" setter="set_sub_emitter_keep_velocity" getter="get_sub_emitter_keep_velocity" default="false">
</member>
Rename ParticlesMaterial to ParticleProcessMaterial Also affects their file names, related classes and documentation.
2022-08-18 11:09:22 +02:00
<member name="sub_emitter_mode" type="int" setter="set_sub_emitter_mode" getter="get_sub_emitter_mode" enum="ParticleProcessMaterial.SubEmitterMode" default="0">
doc: Sync classref with current source Bind missing enums.
2020-09-11 12:22:10 +02:00
</member>
doc: Sync classref with current source Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
2020-02-12 09:59:06 +01:00
<member name="tangential_accel_curve" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</member>
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
<member name="tangential_accel_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
</member>
<member name="tangential_accel_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Restore and improve some ParticlesMaterial docs
2022-07-01 15:09:41 +02:00
Minimum equivalent of [member tangential_accel_max].
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 22:42:36 +02:00
</member>
Rename ParticlesMaterial.turbulence_active to turbulence_enabled
2022-08-02 15:41:14 +02:00
<member name="turbulence_enabled" type="bool" setter="set_turbulence_enabled" getter="get_turbulence_enabled" default="false">
Document high performance cost of turbulence in ParticleProcessMaterial - Mention that GPUParticlesAttractorVectorField3D can be used as an alternative to turbulence in 3D.
2023-04-30 00:38:13 +02:00
If [code]true[/code], enables turbulence for the particle system. Turbulence can be used to vary particle movement according to its position (based on a 3D noise pattern). In 3D, [GPUParticlesAttractorVectorField3D] with [NoiseTexture3D] can be used as an alternative to turbulence that works in world space and with multiple particle systems reacting in the same way.
[b]Note:[/b] Enabling turbulence has a high performance cost on the GPU. Only enable turbulence on a few particle systems at once at most, and consider disabling it when targeting mobile/web platforms.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
</member>
Added default values to particle turbulence.
2022-08-02 09:21:04 +02:00
<member name="turbulence_influence_max" type="float" setter="set_param_max" getter="get_param_max" default="0.1">
Fixed minor typo in turbulence documentation
2023-03-03 10:41:41 +01:00
Maximum turbulence influence on each particle.
The actual amount of turbulence influence on each particle is calculated as a random value between [member turbulence_influence_min] and [member turbulence_influence_max] and multiplied by the amount of turbulence influence from [member turbulence_influence_over_life].
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
</member>
Added default values to particle turbulence.
2022-08-02 09:21:04 +02:00
<member name="turbulence_influence_min" type="float" setter="set_param_min" getter="get_param_min" default="0.1">
Fixed minor typo in turbulence documentation
2023-03-03 10:41:41 +01:00
Minimum turbulence influence on each particle.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
The actual amount of turbulence influence on each particle is calculated as a random value between [member turbulence_influence_min] and [member turbulence_influence_max] and multiplied by the amount of turbulence influence from [member turbulence_influence_over_life].
</member>
<member name="turbulence_influence_over_life" type="Texture2D" setter="set_param_texture" getter="get_param_texture">
Each particle's amount of turbulence will be influenced along this [CurveTexture] over its life time.
</member>
Added default values to particle turbulence.
2022-08-02 09:21:04 +02:00
<member name="turbulence_initial_displacement_max" type="float" setter="set_param_max" getter="get_param_max" default="0.0">
Document high performance cost of turbulence in ParticleProcessMaterial - Mention that GPUParticlesAttractorVectorField3D can be used as an alternative to turbulence in 3D.
2023-04-30 00:38:13 +02:00
Maximum displacement of each particle's spawn position by the turbulence.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between [member turbulence_initial_displacement_min] and [member turbulence_initial_displacement_max].
</member>
Added default values to particle turbulence.
2022-08-02 09:21:04 +02:00
<member name="turbulence_initial_displacement_min" type="float" setter="set_param_min" getter="get_param_min" default="0.0">
Document high performance cost of turbulence in ParticleProcessMaterial - Mention that GPUParticlesAttractorVectorField3D can be used as an alternative to turbulence in 3D.
2023-04-30 00:38:13 +02:00
Minimum displacement of each particle's spawn position by the turbulence.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between [member turbulence_initial_displacement_min] and [member turbulence_initial_displacement_max].
</member>
Added default values to particle turbulence.
2022-08-02 09:21:04 +02:00
<member name="turbulence_noise_scale" type="float" setter="set_turbulence_noise_scale" getter="get_turbulence_noise_scale" default="9.0">
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
This value controls the overall scale/frequency of the turbulence noise pattern.
A small scale will result in smaller features with more detail while a high scale will result in smoother noise with larger features.
</member>
Reworked Particle Turbulence - Rebased.
2023-05-17 12:10:24 +02:00
<member name="turbulence_noise_speed" type="Vector3" setter="set_turbulence_noise_speed" getter="get_turbulence_noise_speed" default="Vector3(0, 0, 0)">
A scrolling velocity for the turbulence field. This sets a directional trend for the pattern to move in over time.
The default value of [code]Vector3(0, 0, 0)[/code] turns off the scrolling.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
</member>
Reworked Particle Turbulence - Rebased.
2023-05-17 12:10:24 +02:00
<member name="turbulence_noise_speed_random" type="float" setter="set_turbulence_noise_speed_random" getter="get_turbulence_noise_speed_random" default="0.2">
The in-place rate of change of the turbulence field. This defines how quickly the noise pattern varies over time.
A value of 0.0 will result in a fixed pattern.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
</member>
Added default values to particle turbulence.
2022-08-02 09:21:04 +02:00
<member name="turbulence_noise_strength" type="float" setter="set_turbulence_noise_strength" getter="get_turbulence_noise_strength" default="1.0">
Reworked Particle Turbulence - Rebased.
2023-05-17 12:10:24 +02:00
The turbulence noise strength. Increasing this will result in a stronger, more contrasting, flow pattern.
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
</member>
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 22:42:36 +02:00
</members>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_INITIAL_LINEAR_VELOCITY" value="0" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_ANGULAR_VELOCITY" value="1" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_ORBIT_VELOCITY" value="2" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_LINEAR_ACCEL" value="3" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_RADIAL_ACCEL" value="4" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_TANGENTIAL_ACCEL" value="5" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_DAMPING" value="6" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_ANGLE" value="7" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_SCALE" value="8" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_HUE_VARIATION" value="9" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_ANIM_SPEED" value="10" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="PARAM_ANIM_OFFSET" value="11" enum="Parameter">
moved particle parameters to minmax and split scale axis This commit adds quite a chunk of modifications to particles - particle (value + randomness) now use min and max instead - passing a curveXYZtexture is now possible and will scale particles per-axis - CPUParticle3D have an optional parameter to split the scale curve per-axis
2021-07-13 19:46:27 +02:00
Use with [method set_param_min], [method set_param_max], 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 22:42:36 +02:00
</constant>
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
<constant name="PARAM_MAX" value="15" enum="Parameter">
Bind missing FLAG_DISABLE_Z enum value in ParticlesMaterial Fixes #29419.
2019-06-03 11:18:09 +02: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 22:42:36 +02:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<constant name="PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY" value="0" enum="ParticleFlags">
Use with [method set_particle_flag] to set [member particle_flag_align_y].
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 22:42:36 +02:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<constant name="PARTICLE_FLAG_ROTATE_Y" value="1" enum="ParticleFlags">
Use with [method set_particle_flag] to set [member particle_flag_rotate_y].
Bind missing FLAG_DISABLE_Z enum value in ParticlesMaterial Fixes #29419.
2019-06-03 11:18:09 +02:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<constant name="PARTICLE_FLAG_DISABLE_Z" value="2" enum="ParticleFlags">
Use with [method set_particle_flag] to set [member particle_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 22:42:36 +02:00
</constant>
Rename Particles/ParticlesMaterial "Flags" enum to "ParticleFlags" "Flags" was a bit too ambiguous, and in 3D it hid GeometryInstance.Flags
2020-12-05 00:35:57 +01:00
<constant name="PARTICLE_FLAG_MAX" value="3" enum="ParticleFlags">
Represents the size of the [enum ParticleFlags] 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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="EMISSION_SHAPE_POINT" value="0" enum="EmissionShape">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-27 23:28:53 +01:00
<constant name="EMISSION_SHAPE_SPHERE_SURFACE" value="2" enum="EmissionShape">
Particles will be emitted on the surface of a sphere.
</constant>
<constant name="EMISSION_SHAPE_BOX" value="3" enum="EmissionShape">
[DOCS] Update ParticlesMaterial, Particles class ref
2017-10-03 21:30:32 +02: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 22:42:36 +02:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-27 23:28:53 +01:00
<constant name="EMISSION_SHAPE_POINTS" value="4" enum="EmissionShape">
clarified and filled out particles material doc
2019-01-06 21:52:15 +01: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 22:42:36 +02:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-27 23:28:53 +01:00
<constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="5" enum="EmissionShape">
clarified and filled out particles material doc
2019-01-06 21:52:15 +01: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 22:42:36 +02:00
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-27 23:28:53 +01:00
<constant name="EMISSION_SHAPE_RING" value="6" enum="EmissionShape">
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. emission_ring_axis: the axis along which the ring/cylinder will be constructed 2. emission_ring_radius: outer radius of the ring/cylinder 3. emission_ring_inner_radius: inner radius of the cylinder. when set to zero, particles will emit in the full volume. 4. emission_ring_height: height of the ring/cylinder emitter.
2021-07-11 15:45:21 +02:00
Particles will be emitted in a ring or cylinder.
</constant>
Fixed sphere emission shape to emit particles in a spheres volume and added "Sphere Surface" to keep the old behaviour.
2021-11-27 23:28:53 +01:00
<constant name="EMISSION_SHAPE_MAX" value="7" 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>
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
<constant name="PARAM_TURB_VEL_INFLUENCE" value="13" enum="Parameter">
Use with [method set_param_min] and [method set_param_max] to set the turbulence minimum und maximum influence on each particles velocity.
</constant>
<constant name="PARAM_TURB_INIT_DISPLACEMENT" value="14" enum="Parameter">
Use with [method set_param_min] and [method set_param_max] to set the turbulence minimum and maximum displacement of the particles spawn position.
</constant>
<constant name="PARAM_TURB_INFLUENCE_OVER_LIFE" value="12" enum="Parameter">
Use with [method set_param_texture] to set the turbulence influence over the particles life time.
</constant>
doc: Sync classref with current source Bind missing enums.
2020-09-11 12:22:10 +02:00
<constant name="SUB_EMITTER_DISABLED" value="0" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_CONSTANT" value="1" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_AT_END" value="2" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_AT_COLLISION" value="3" enum="SubEmitterMode">
</constant>
<constant name="SUB_EMITTER_MAX" value="4" enum="SubEmitterMode">
Turbulence Noise for Particle Material
2021-11-26 15:18:46 +01:00
Represents the size of the [enum SubEmitterMode] enum.
doc: Sync classref with current source Bind missing enums.
2020-09-11 12:22:10 +02:00
</constant>
Add "Hide on Contact" collision mode to ParticlesMaterial This can be used to make particles disappear when colliding, rather than bouncing around or sticking to surfaces. This is useful for rain particles which should not be able to go through floors/ceilings, but shouldn't stick to surfaces either.
2022-05-20 23:59:13 +02:00
<constant name="COLLISION_DISABLED" value="0" enum="CollisionMode">
No collision for particles. Particles will go through [GPUParticlesCollision3D] nodes.
</constant>
<constant name="COLLISION_RIGID" value="1" enum="CollisionMode">
Restore RigidBody2/3D, SoftBody names in physics
2022-08-25 19:35:52 +02:00
[RigidBody3D]-style collision for particles using [GPUParticlesCollision3D] nodes.
Add "Hide on Contact" collision mode to ParticlesMaterial This can be used to make particles disappear when colliding, rather than bouncing around or sticking to surfaces. This is useful for rain particles which should not be able to go through floors/ceilings, but shouldn't stick to surfaces either.
2022-05-20 23:59:13 +02:00
</constant>
<constant name="COLLISION_HIDE_ON_CONTACT" value="2" enum="CollisionMode">
Hide particles instantly when colliding with a [GPUParticlesCollision3D] node. This can be combined with a subemitter that uses the [constant COLLISION_RIGID] collision mode to "replace" the parent particle with the subemitter on impact.
</constant>
<constant name="COLLISION_MAX" value="3" enum="CollisionMode">
Represents the size of the [enum CollisionMode] 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 22:42:36 +02:00
</constants>
</class>
Reference in a new issue Copy permalink