class-description NEWS COMMUNITY STORE TUTORIALS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE TUTORIALS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectRefCountedResourceMaterial ParticleProcessMaterial
Holds a particle configuration for GPUParticles2D or GPUParticles3D nodes.

ParticleProcessMaterial defines particle properties and behavior. It is used in the process_material 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.

 Enum Parameter<>():Enum

PARAM_INITIAL_LINEAR_VELOCITY = 0

Use with set_param_min, set_param_max, and set_param_texture to set initial velocity properties.


PARAM_ANGULAR_VELOCITY = 1

Use with set_param_min, set_param_max, and set_param_texture to set angular velocity properties.


PARAM_ORBIT_VELOCITY = 2

Use with set_param_min, set_param_max, and set_param_texture to set orbital velocity properties.


PARAM_LINEAR_ACCEL = 3

Use with set_param_min, set_param_max, and set_param_texture to set linear acceleration properties.


PARAM_RADIAL_ACCEL = 4

Use with set_param_min, set_param_max, and set_param_texture to set radial acceleration properties.


PARAM_TANGENTIAL_ACCEL = 5

Use with set_param_min, set_param_max, and set_param_texture to set tangential acceleration properties.


PARAM_DAMPING = 6

Use with set_param_min, set_param_max, and set_param_texture to set damping properties.


PARAM_ANGLE = 7

Use with set_param_min, set_param_max, and set_param_texture to set angle properties.


PARAM_SCALE = 8

Use with set_param_min, set_param_max, and set_param_texture to set scale properties.


PARAM_HUE_VARIATION = 9

Use with set_param_min, set_param_max, and set_param_texture to set hue variation properties.


PARAM_ANIM_SPEED = 10

Use with set_param_min, set_param_max, and set_param_texture to set animation speed properties.


PARAM_ANIM_OFFSET = 11

Use with set_param_min, set_param_max, and set_param_texture to set animation offset properties.


PARAM_RADIAL_VELOCITY = 15

Use with set_param_min, set_param_max, and set_param_texture to set radial velocity properties.


PARAM_DIRECTIONAL_VELOCITY = 16

Use with set_param_min, set_param_max, and set_param_texture to set directional velocity properties.


PARAM_SCALE_OVER_VELOCITY = 17

Use with set_param_min, set_param_max, and set_param_texture to set scale over velocity properties.


PARAM_MAX = 18

Represents the size of the Parameter enum.


PARAM_TURB_VEL_INFLUENCE = 13

Use with set_param_min and set_param_max to set the turbulence minimum und maximum influence on each particles velocity.


PARAM_TURB_INIT_DISPLACEMENT = 14

Use with set_param_min and set_param_max to set the turbulence minimum and maximum displacement of the particles spawn position.


PARAM_TURB_INFLUENCE_OVER_LIFE = 12

Use with set_param_texture to set the turbulence influence over the particles life time.

 Enum ParticleFlags<>():Enum

PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY = 0

Use with set_particle_flag to set particle_flag_align_y.


PARTICLE_FLAG_ROTATE_Y = 1

Use with set_particle_flag to set particle_flag_rotate_y.


PARTICLE_FLAG_DISABLE_Z = 2

Use with set_particle_flag to set particle_flag_disable_z.


PARTICLE_FLAG_DAMPING_AS_FRICTION = 3

There is currently no description for this enum. Please help us by contributing one!


PARTICLE_FLAG_MAX = 4

Represents the size of the ParticleFlags enum.

 Enum EmissionShape<>():Enum

EMISSION_SHAPE_POINT = 0

All particles will be emitted from a single point.


EMISSION_SHAPE_SPHERE = 1

Particles will be emitted in the volume of a sphere.


EMISSION_SHAPE_SPHERE_SURFACE = 2

Particles will be emitted on the surface of a sphere.


EMISSION_SHAPE_BOX = 3

Particles will be emitted in the volume of a box.


EMISSION_SHAPE_POINTS = 4

Particles will be emitted at a position determined by sampling a random point on the emission_point_texture. Particle color will be modulated by emission_color_texture.


EMISSION_SHAPE_DIRECTED_POINTS = 5

Particles will be emitted at a position determined by sampling a random point on the emission_point_texture. Particle velocity and rotation will be set based on emission_normal_texture. Particle color will be modulated by emission_color_texture.


EMISSION_SHAPE_RING = 6

Particles will be emitted in a ring or cylinder.


EMISSION_SHAPE_MAX = 7

Represents the size of the EmissionShape enum.

 Enum SubEmitterMode<>():Enum

SUB_EMITTER_DISABLED = 0

There is currently no description for this enum. Please help us by contributing one!


SUB_EMITTER_CONSTANT = 1

There is currently no description for this enum. Please help us by contributing one!


SUB_EMITTER_AT_END = 2

There is currently no description for this enum. Please help us by contributing one!


SUB_EMITTER_AT_COLLISION = 3

There is currently no description for this enum. Please help us by contributing one!


SUB_EMITTER_MAX = 4

Represents the size of the SubEmitterMode enum.

 Enum CollisionMode<>():Enum

COLLISION_DISABLED = 0

No collision for particles. Particles will go through GPUParticlesCollision3D nodes.


COLLISION_RIGID = 1

RigidBody3D-style collision for particles using GPUParticlesCollision3D nodes.


COLLISION_HIDE_ON_CONTACT = 2

Hide particles instantly when colliding with a GPUParticlesCollision3D node. This can be combined with a subemitter that uses the COLLISION_RIGID collision mode to "replace" the parent particle with the subemitter on impact.


COLLISION_MAX = 3

Represents the size of the CollisionMode enum.

 Texture2D alpha_curve<>():Texture2D

The alpha value of each particle's color will be multiplied by this CurveTexture over its lifetime.

 Texture2D angle_curve<>():Texture2D

Each particle's rotation will be animated along this CurveTexture.

 float angle_max<>():float

Maximum initial rotation applied to each particle, in degrees.

Only applied when particle_flag_disable_z or particle_flag_rotate_y are true or the BaseMaterial3D being used to draw the particle is using BaseMaterial3D.BILLBOARD_PARTICLES.

 float angle_min<>():float

Minimum equivalent of angle_max.

 Texture2D angular_velocity_curve<>():Texture2D

Each particle's angular velocity (rotation speed) will vary along this CurveTexture over its lifetime.

 float angular_velocity_max<>():float

Maximum initial angular velocity (rotation speed) applied to each particle in degrees per second.

Only applied when particle_flag_disable_z or particle_flag_rotate_y are true or the BaseMaterial3D being used to draw the particle is using BaseMaterial3D.BILLBOARD_PARTICLES.

 float angular_velocity_min<>():float

Minimum equivalent of angular_velocity_max.

 Texture2D anim_offset_curve<>():Texture2D

Each particle's animation offset will vary along this CurveTexture.

 float anim_offset_max<>():float

Maximum animation offset that corresponds to frame index in the texture. 0 is the first frame, 1 is the last one. See CanvasItemMaterial.particles_animation.

 float anim_offset_min<>():float

Minimum equivalent of anim_offset_max.

 Texture2D anim_speed_curve<>():Texture2D

Each particle's animation speed will vary along this CurveTexture.

 float anim_speed_max<>():float

Maximum particle animation speed. Animation speed of 1 means that the particles will make full 0 to 1 offset cycle during lifetime, 2 means 2 cycles etc.

With animation speed greater than 1, remember to enable CanvasItemMaterial.particles_anim_loop property if you want the animation to repeat.

 float anim_speed_min<>():float

Minimum equivalent of anim_speed_max.

 bool attractor_interaction_enabled<>():bool

If true, interaction with particle attractors is enabled. In 3D, attraction only occurs within the area defined by the GPUParticles3D node's GPUParticles3D.visibility_aabb.

 float collision_bounce<>():float

The particles' bounciness. Values range from 0 (no bounce) to 1 (full bounciness). Only effective if collision_mode is COLLISION_RIGID.

 float collision_friction<>():float

The particles' friction. Values range from 0 (frictionless) to 1 (maximum friction). Only effective if collision_mode is COLLISION_RIGID.

 CollisionMode collision_mode<>():CollisionMode

The particles' collision mode.

Note: 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. In 3D, collisions only occur within the area defined by the GPUParticles3D node's GPUParticles3D.visibility_aabb.

Note: 2D Particles can only collide with LightOccluder2D nodes, not PhysicsBody2D nodes.

 bool collision_use_scale<>():bool

If true, GPUParticles3D.collision_base_size is multiplied by the particle's effective scale (see scale_min, scale_max, scale_curve, and scale_over_velocity_curve).

 Color color<>():Color

Each particle's initial color. If the GPUParticles2D's texture is defined, it will be multiplied by this color.

Note: color multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, color will have no visible effect.

 Texture2D color_initial_ramp<>():Texture2D

Each particle's initial color will vary along this GradientTexture1D (multiplied with color).

Note: color_initial_ramp multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, color_initial_ramp will have no visible effect.

 Texture2D color_ramp<>():Texture2D

Each particle's color will vary along this GradientTexture1D over its lifetime (multiplied with color).

Note: color_ramp multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, color_ramp will have no visible effect.

 Texture2D damping_curve<>():Texture2D

Damping will vary along this CurveTexture.

 float damping_max<>():float

The maximum rate at which particles lose velocity. For example value of 100 means that the particle will go from 100 velocity to 0 in 1 second.

 float damping_min<>():float

Minimum equivalent of damping_max.

 Vector3 direction<>():Vector3

Unit vector specifying the particles' emission direction.

 Texture2D directional_velocity_curve<>():Texture2D

A curve that specifies the velocity along each of the axes of the particle system along its lifetime.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 float directional_velocity_max<>():float

Maximum directional velocity value, which is multiplied by directional_velocity_curve.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 float directional_velocity_min<>():float

Minimum directional velocity value, which is multiplied by directional_velocity_curve.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 Vector3 emission_box_extents<>():Vector3

The box's extents if emission_shape is set to EMISSION_SHAPE_BOX.

 Texture2D emission_color_texture<>():Texture2D

Particle color will be modulated by color determined by sampling this texture at the same point as the emission_point_texture.

Note: emission_color_texture multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, BaseMaterial3D.vertex_color_use_as_albedo must be true. For a ShaderMaterial, ALBEDO *= COLOR.rgb; must be inserted in the shader's fragment() function. Otherwise, emission_color_texture will have no visible effect.

 Texture2D emission_curve<>():Texture2D

Each particle's color will be multiplied by this CurveTexture over its lifetime.

Note: This property won't have a visible effect unless the render material is marked as unshaded.

 Texture2D emission_normal_texture<>():Texture2D

Particle velocity and rotation will be set by sampling this texture at the same point as the emission_point_texture. Used only in 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.

 int emission_point_count<>():int

The number of emission points if emission_shape is set to EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.

 Texture2D emission_point_texture<>():Texture2D

Particles will be emitted at positions determined by sampling this texture at a random position. Used with EMISSION_SHAPE_POINTS and 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.

 Vector3 emission_ring_axis<>():Vector3

The axis of the ring when using the emitter EMISSION_SHAPE_RING.

 float emission_ring_height<>():float

The height of the ring when using the emitter EMISSION_SHAPE_RING.

 float emission_ring_inner_radius<>():float

The inner radius of the ring when using the emitter EMISSION_SHAPE_RING.

 float emission_ring_radius<>():float

The radius of the ring when using the emitter EMISSION_SHAPE_RING.

 EmissionShape emission_shape<>():EmissionShape

Particles will be emitted inside this region. Use EmissionShape constants for values.

 Vector3 emission_shape_offset<>():Vector3

The offset for the emission_shape, in local space.

 Vector3 emission_shape_scale<>():Vector3

The scale of the emission_shape, in local space.

 float emission_sphere_radius<>():float

The sphere's radius if emission_shape is set to EMISSION_SHAPE_SPHERE.

 float flatness<>():float

Amount of spread along the Y axis.

 Vector3 gravity<>():Vector3

Gravity applied to every particle.

 Texture2D hue_variation_curve<>():Texture2D

Each particle's hue will vary along this CurveTexture.

 float hue_variation_max<>():float

Maximum initial hue variation applied to each particle. It will shift the particle color's hue.

 float hue_variation_min<>():float

Minimum equivalent of hue_variation_max.

 float inherit_velocity_ratio<>():float

Percentage of the velocity of the respective GPUParticles2D or GPUParticles3D inherited by each particle when spawning.

 float initial_velocity_max<>():float

Maximum initial velocity magnitude for each particle. Direction comes from direction and spread.

 float initial_velocity_min<>():float

Minimum equivalent of initial_velocity_max.

 float lifetime_randomness<>():float

Particle lifetime randomness ratio. The equation for the lifetime of a particle is lifetime * (1.0 - randf() * lifetime_randomness). For example, a lifetime_randomness of 0.4 scales the lifetime between 0.6 to 1.0 of its original value.

 Texture2D linear_accel_curve<>():Texture2D

Each particle's linear acceleration will vary along this CurveTexture.

 float linear_accel_max<>():float

Maximum linear acceleration applied to each particle in the direction of motion.

 float linear_accel_min<>():float

Minimum equivalent of linear_accel_max.

 Texture2D orbit_velocity_curve<>():Texture2D

Each particle's orbital velocity will vary along this CurveTexture.

Note: For 3D orbital velocity, use a CurveXYZTexture.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 float orbit_velocity_max<>():float

Maximum orbital velocity applied to each particle. Makes the particles circle around origin. Specified in number of full rotations around origin per second.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 float orbit_velocity_min<>():float

Minimum equivalent of orbit_velocity_max.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 bool particle_flag_align_y<>():bool

Align Y axis of particle with the direction of its velocity.

 bool particle_flag_damping_as_friction<>():bool

Changes the behavior of the damping properties from a linear deceleration to a deceleration based on speed percentage.

 bool particle_flag_disable_z<>():bool

If true, particles will not move on the z axis.

 bool particle_flag_rotate_y<>():bool

If true, particles rotate around Y axis by angle_min.

 Texture2D radial_accel_curve<>():Texture2D

Each particle's radial acceleration will vary along this CurveTexture.

 float radial_accel_max<>():float

Maximum radial acceleration applied to each particle. Makes particle accelerate away from the origin or towards it if negative.

 float radial_accel_min<>():float

Minimum equivalent of radial_accel_max.

 Texture2D radial_velocity_curve<>():Texture2D

A CurveTexture that defines the velocity over the particle's lifetime away (or toward) the velocity_pivot.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 float radial_velocity_max<>():float

Maximum radial velocity applied to each particle. Makes particles move away from the velocity_pivot, or toward it if negative.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 float radial_velocity_min<>():float

Minimum radial velocity applied to each particle. Makes particles move away from the velocity_pivot, or toward it if negative.

Note: Animated velocities will not be affected by damping, use velocity_limit_curve instead.

 Texture2D scale_curve<>():Texture2D

Each particle's scale will vary along this CurveTexture. If a CurveXYZTexture is supplied instead, the scale will be separated per-axis.

 float scale_max<>():float

Maximum initial scale applied to each particle.

 float scale_min<>():float

Minimum equivalent of scale_max.

 Texture2D scale_over_velocity_curve<>():Texture2D

Either a CurveTexture or a CurveXYZTexture that scales each particle based on its velocity.

 float scale_over_velocity_max<>():float

Maximum velocity value reference for scale_over_velocity_curve.

scale_over_velocity_curve will be interpolated between scale_over_velocity_min and scale_over_velocity_max.

 float scale_over_velocity_min<>():float

Minimum velocity value reference for scale_over_velocity_curve.

scale_over_velocity_curve will be interpolated between scale_over_velocity_min and scale_over_velocity_max.

 float spread<>():float

Each particle's initial direction range from +spread to -spread degrees.

 int sub_emitter_amount_at_collision<>():int

The amount of particles to spawn from the subemitter node when a collision occurs. When combined with COLLISION_HIDE_ON_CONTACT on the main particles material, this can be used to achieve effects such as raindrops hitting the ground.

Note: This value shouldn't exceed GPUParticles2D.amount or GPUParticles3D.amount defined on the subemitter node (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.

 int sub_emitter_amount_at_end<>():int

The amount of particles to spawn from the subemitter node when the particle expires.

Note: This value shouldn't exceed GPUParticles2D.amount or GPUParticles3D.amount defined on the subemitter node (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.

 float sub_emitter_frequency<>():float

The frequency at which particles should be emitted from the subemitter node. One particle will be spawned every sub_emitter_frequency seconds.

Note: This value shouldn't exceed GPUParticles2D.amount or GPUParticles3D.amount defined on the subemitter node (not the main node), relative to the subemitter's particle lifetime. If the number of particles is exceeded, no new particles will spawn from the subemitter until enough particles have expired.

 bool sub_emitter_keep_velocity<>():bool

If true, the subemitter inherits the parent particle's velocity when it spawns.

 SubEmitterMode sub_emitter_mode<>():SubEmitterMode

The particle subemitter mode (see GPUParticles2D.sub_emitter and GPUParticles3D.sub_emitter).

 Texture2D tangential_accel_curve<>():Texture2D

Each particle's tangential acceleration will vary along this CurveTexture.

 float tangential_accel_max<>():float

Maximum tangential acceleration applied to each particle. Tangential acceleration is perpendicular to the particle's velocity giving the particles a swirling motion.

 float tangential_accel_min<>():float

Minimum equivalent of tangential_accel_max.

 bool turbulence_enabled<>():bool

If true, 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.

Note: 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.

 float turbulence_influence_max<>():float

Maximum turbulence influence on each particle.

The actual amount of turbulence influence on each particle is calculated as a random value between turbulence_influence_min and turbulence_influence_max and multiplied by the amount of turbulence influence from turbulence_influence_over_life.

 float turbulence_influence_min<>():float

Minimum turbulence influence on each particle.

The actual amount of turbulence influence on each particle is calculated as a random value between turbulence_influence_min and turbulence_influence_max and multiplied by the amount of turbulence influence from turbulence_influence_over_life.

 Texture2D turbulence_influence_over_life<>():Texture2D

Each particle's amount of turbulence will be influenced along this CurveTexture over its life time.

 float turbulence_initial_displacement_max<>():float

Maximum displacement of each particle's spawn position by the turbulence.

The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between turbulence_initial_displacement_min and turbulence_initial_displacement_max.

 float turbulence_initial_displacement_min<>():float

Minimum displacement of each particle's spawn position by the turbulence.

The actual amount of displacement will be a factor of the underlying turbulence multiplied by a random value between turbulence_initial_displacement_min and turbulence_initial_displacement_max.

 float turbulence_noise_scale<>():float

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.

 Vector3 turbulence_noise_speed<>():Vector3

A scrolling velocity for the turbulence field. This sets a directional trend for the pattern to move in over time.

The default value of Vector3(0, 0, 0) turns off the scrolling.

 float turbulence_noise_speed_random<>():float

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.

 float turbulence_noise_strength<>():float

The turbulence noise strength. Increasing this will result in a stronger, more contrasting, flow pattern.

 Texture2D velocity_limit_curve<>():Texture2D

A CurveTexture that defines the maximum velocity of a particle during its lifetime.

 Vector3 velocity_pivot<>():Vector3

A pivot point used to calculate radial and orbital velocity of particles.

 Vector2 get_param<>( Parameter param=, param:Parameter=, ):Vector2

Returns the minimum and maximum values of the given param as a vector.

The x component of the returned vector corresponds to minimum and the y component corresponds to maximum.

 float get_param_max<>( Parameter param=, param:Parameter=, ):float

Returns the maximum value range for the given parameter.

 float get_param_min<>( Parameter param=, param:Parameter=, ):float

Returns the minimum value range for the given parameter.

 Texture2D get_param_texture<>( Parameter param=, param:Parameter=, ):Texture2D

Returns the Texture2D used by the specified parameter.

 bool get_particle_flag<>( ParticleFlags particle_flag=, particle_flag:ParticleFlags=, ):bool

Returns true if the specified particle flag is enabled. See ParticleFlags for options.

 void set_param<>( Parameter param=, param:Parameter=, Vector2 value=, value:Vector2=, ):void

Sets the minimum and maximum values of the given param.

The x component of the argument vector corresponds to minimum and the y component corresponds to maximum.

 void set_param_max<>( Parameter param=, param:Parameter=, float value=, value:float=, ):void

Sets the maximum value range for the given parameter.

 void set_param_min<>( Parameter param=, param:Parameter=, float value=, value:float=, ):void

Sets the minimum value range for the given parameter.

 void set_param_texture<>( Parameter param=, param:Parameter=, Texture2D texture=, texture:Texture2D=, ):void

Sets the Texture2D for the specified Parameter.

 void set_particle_flag<>( ParticleFlags particle_flag=, particle_flag:ParticleFlags=, bool enable=, enable:bool=, ):void

If true, enables the specified particle flag. See ParticleFlags for options.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...