class-description NEWS COMMUNITY STORE LABS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE LABS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeNode3DVisualInstance3DGeometryInstance3D CPUParticles3D
A CPU-based 3D particle emitter.

CPU-based 3D particle node used to create a variety of particle systems and effects.

See also GPUParticles3D, which provides the same functionality with hardware acceleration, but may not run on older devices.

 finished finished<>():finished

Emitted when all active particles have finished processing. When one_shot is disabled, particles will process continuously, so this is never emitted.

 Enum DrawOrder<>():Enum

DRAW_ORDER_INDEX = 0

Particles are drawn in the order emitted.


DRAW_ORDER_LIFETIME = 1

Particles are drawn in order of remaining lifetime. In other words, the particle with the highest lifetime is drawn at the front.


DRAW_ORDER_VIEW_DEPTH = 2

Particles are drawn in order of depth.

 Enum Parameter<>():Enum

PARAM_INITIAL_LINEAR_VELOCITY = 0

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


PARAM_ANGULAR_VELOCITY = 1

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


PARAM_ORBIT_VELOCITY = 2

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


PARAM_LINEAR_ACCEL = 3

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


PARAM_RADIAL_ACCEL = 4

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


PARAM_TANGENTIAL_ACCEL = 5

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


PARAM_DAMPING = 6

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


PARAM_ANGLE = 7

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


PARAM_SCALE = 8

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


PARAM_HUE_VARIATION = 9

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


PARAM_ANIM_SPEED = 10

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


PARAM_ANIM_OFFSET = 11

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


PARAM_MAX = 12

Represents the size of the Parameter enum.

 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_MAX = 3

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 chosen randomly among emission_points. Particle color will be modulated by emission_colors.


EMISSION_SHAPE_DIRECTED_POINTS = 5

Particles will be emitted at a position chosen randomly among emission_points. Particle velocity and rotation will be set based on emission_normals. Particle color will be modulated by emission_colors.


EMISSION_SHAPE_RING = 6

Particles will be emitted in a ring or cylinder.


EMISSION_SHAPE_MAX = 7

Represents the size of the EmissionShape enum.

 int amount<>():int

Number of particles emitted in one emission cycle.

 Curve angle_curve<>():Curve

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

 float angle_max<>():float

Maximum angle.

 float angle_min<>():float

Minimum angle.

 Curve angular_velocity_curve<>():Curve

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

 float angular_velocity_max<>():float

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

 float angular_velocity_min<>():float

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

 Curve anim_offset_curve<>():Curve

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

 float anim_offset_max<>():float

Maximum animation offset.

 float anim_offset_min<>():float

Minimum animation offset.

 Curve anim_speed_curve<>():Curve

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

 float anim_speed_max<>():float

Maximum particle animation speed.

 float anim_speed_min<>():float

Minimum particle animation speed.

 Color color<>():Color

Each particle's initial 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.

 Gradient color_initial_ramp<>():Gradient

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.

 Gradient color_ramp<>():Gradient

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.

 Curve damping_curve<>():Curve

Damping will vary along this Curve.

 float damping_max<>():float

Maximum damping.

 float damping_min<>():float

Minimum damping.

 Vector3 direction<>():Vector3

Unit vector specifying the particles' emission direction.

 DrawOrder draw_order<>():DrawOrder

Particle draw order. Uses DrawOrder values.

 Vector3 emission_box_extents<>():Vector3

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

 PackedColorArray emission_colors<>():PackedColorArray

Sets the Colors to modulate particles by when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.

Note: emission_colors 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_colors will have no visible effect.

 PackedVector3Array emission_normals<>():PackedVector3Array

Sets the direction the particles will be emitted in when using EMISSION_SHAPE_DIRECTED_POINTS.

 PackedVector3Array emission_points<>():PackedVector3Array

Sets the initial positions to spawn particles when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.

 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. See EmissionShape for possible values.

 float emission_sphere_radius<>():float

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

 bool emitting<>():bool

If true, particles are being emitted. emitting can be used to start and stop particles from emitting. However, if one_shot is true setting emitting to true will not restart the emission cycle until after all active particles finish processing. You can use the finished signal to be notified once all active particles finish processing.

 float explosiveness<>():float

How rapidly particles in an emission cycle are emitted. If greater than 0, there will be a gap in emissions before the next cycle begins.

 int fixed_fps<>():int

The particle system's frame rate is fixed to a value. For example, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself.

 float flatness<>():float

Amount of spread in Y/Z plane. A value of 1 restricts particles to X/Z plane.

 bool fract_delta<>():bool

If true, results in fractional delta calculation which has a smoother particles display effect.

 Vector3 gravity<>():Vector3

Gravity applied to every particle.

 Curve hue_variation_curve<>():Curve

Each particle's hue will vary along this Curve.

 float hue_variation_max<>():float

Maximum hue variation.

 float hue_variation_min<>():float

Minimum hue variation.

 float initial_velocity_max<>():float

Maximum value of the initial velocity.

 float initial_velocity_min<>():float

Minimum value of the initial velocity.

 float lifetime<>():float

Amount of time each particle will exist.

 float lifetime_randomness<>():float

Particle lifetime randomness ratio.

 Curve linear_accel_curve<>():Curve

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

 float linear_accel_max<>():float

Maximum linear acceleration.

 float linear_accel_min<>():float

Minimum linear acceleration.

 bool local_coords<>():bool

If true, particles use the parent node's coordinate space (known as local coordinates). This will cause particles to move and rotate along the CPUParticles3D node (and its parents) when it is moved or rotated. If false, particles use global coordinates; they will not move or rotate along the CPUParticles3D node (and its parents) when it is moved or rotated.

 Mesh mesh<>():Mesh

The Mesh used for each particle. If null, particles will be spheres.

 bool one_shot<>():bool

If true, only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle's end.

 Curve orbit_velocity_curve<>():Curve

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

 float orbit_velocity_max<>():float

Maximum orbit velocity.

 float orbit_velocity_min<>():float

Minimum orbit velocity.

 bool particle_flag_align_y<>():bool

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

 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.

 float preprocess<>():float

Particle system starts as if it had already run for this many seconds.

 Curve radial_accel_curve<>():Curve

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

 float radial_accel_max<>():float

Maximum radial acceleration.

 float radial_accel_min<>():float

Minimum radial acceleration.

 float randomness<>():float

Emission lifetime randomness ratio.

 Curve scale_amount_curve<>():Curve

Each particle's scale will vary along this Curve.

 float scale_amount_max<>():float

Maximum scale.

 float scale_amount_min<>():float

Minimum scale.

 Curve scale_curve_x<>():Curve

Curve for the scale over life, along the x axis.

 Curve scale_curve_y<>():Curve

Curve for the scale over life, along the y axis.

 Curve scale_curve_z<>():Curve

Curve for the scale over life, along the z axis.

 float speed_scale<>():float

Particle system's running speed scaling ratio. A value of 0 can be used to pause the particles.

 bool split_scale<>():bool

If set to true, three different scale curves can be specified, one per scale axis.

 float spread<>():float

Each particle's initial direction range from +spread to -spread degrees. Applied to X/Z plane and Y/Z planes.

 Curve tangential_accel_curve<>():Curve

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

 float tangential_accel_max<>():float

Maximum tangent acceleration.

 float tangential_accel_min<>():float

Minimum tangent acceleration.

 void convert_from_particles<>( Node particles=, particles:Node=, ):void

Sets this node's properties to match a given GPUParticles3D node with an assigned ParticleProcessMaterial.

 Curve get_param_curve<>( Parameter param=, param:Parameter=, ):Curve

Returns the Curve of the parameter specified by Parameter.

 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.

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

Returns the enabled state of the given particle flag (see ParticleFlags for options).

 void restart<>():void

Restarts the particle emitter.

 void set_param_curve<>( Parameter param=, param:Parameter=, Curve curve=, curve:Curve=, ):void

Sets the Curve of the parameter specified by Parameter.

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

Sets the maximum value for the given parameter.

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

Sets the minimum value for the given parameter.

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

Enables or disables the given 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...