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 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.
 Enum DrawOrder<>():Enum

DRAW_ORDER_INDEX:null = 0
Particles are drawn in the order emitted.


DRAW_ORDER_LIFETIME:null = 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:null = 2
Particles are drawn in order of depth.
 Enum Parameter<>():Enum

PARAM_INITIAL_LINEAR_VELOCITY:null = 0
Use with set_param_min, set_param_max, and set_param_curve to set initial velocity properties.


PARAM_ANGULAR_VELOCITY:null = 1
Use with set_param_min, set_param_max, and set_param_curve to set angular velocity properties.


PARAM_ORBIT_VELOCITY:null = 2
Use with set_param_min, set_param_max, and set_param_curve to set orbital velocity properties.


PARAM_LINEAR_ACCEL:null = 3
Use with set_param_min, set_param_max, and set_param_curve to set linear acceleration properties.


PARAM_RADIAL_ACCEL:null = 4
Use with set_param_min, set_param_max, and set_param_curve to set radial acceleration properties.


PARAM_TANGENTIAL_ACCEL:null = 5
Use with set_param_min, set_param_max, and set_param_curve to set tangential acceleration properties.


PARAM_DAMPING:null = 6
Use with set_param_min, set_param_max, and set_param_curve to set damping properties.


PARAM_ANGLE:null = 7
Use with set_param_min, set_param_max, and set_param_curve to set angle properties.


PARAM_SCALE:null = 8
Use with set_param_min, set_param_max, and set_param_curve to set scale properties.


PARAM_HUE_VARIATION:null = 9
Use with set_param_min, set_param_max, and set_param_curve to set hue variation properties.


PARAM_ANIM_SPEED:null = 10
Use with set_param_min, set_param_max, and set_param_curve to set animation speed properties.


PARAM_ANIM_OFFSET:null = 11
Use with set_param_min, set_param_max, and set_param_curve to set animation offset properties.


PARAM_MAX:null = 12
Represents the size of the Parameter enum.
 Enum ParticleFlags<>():Enum

PARTICLE_FLAG_ALIGN_Y_TO_VELOCITY:null = 0
Use with set_particle_flag to set particle_flag_align_y.


PARTICLE_FLAG_ROTATE_Y:null = 1
Use with set_particle_flag to set particle_flag_rotate_y.


PARTICLE_FLAG_DISABLE_Z:null = 2
Use with set_particle_flag to set particle_flag_disable_z.


PARTICLE_FLAG_MAX:null = 3
Represents the size of the ParticleFlags enum.
 Enum EmissionShape<>():Enum

EMISSION_SHAPE_POINT:null = 0
All particles will be emitted from a single point.


EMISSION_SHAPE_SPHERE:null = 1
Particles will be emitted in the volume of a sphere.


EMISSION_SHAPE_SPHERE_SURFACE:null = 2
Particles will be emitted on the surface of a sphere.


EMISSION_SHAPE_BOX:null = 3
Particles will be emitted in the volume of a box.


EMISSION_SHAPE_POINTS:null = 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:null = 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:null = 6
Particles will be emitted in a ring or cylinder.


EMISSION_SHAPE_MAX:null = 7
Represents the size of the EmissionShape enum.
 Signal finished<>():Signal
Emitted when all active particles have finished processing. When one_shot is disabled, particles will process continuously, so this is never emitted.

set get int amount<>():int set get
Number of particles emitted in one emission cycle.

set get Curve angle_curve<>():Curve set get
Each particle's rotation will be animated along this Curve. Should be a unit Curve.

set get float angle_max<>():float set get
Maximum angle.

set get float angle_min<>():float set get
Minimum angle.

set get Curve angular_velocity_curve<>():Curve set get
Each particle's angular velocity (rotation speed) will vary along this Curve over its lifetime. Should be a unit Curve.

set get float angular_velocity_max<>():float set get
Maximum initial angular velocity (rotation speed) applied to each particle in degrees per second.

set get float angular_velocity_min<>():float set get
Minimum initial angular velocity (rotation speed) applied to each particle in degrees per second.

set get Curve anim_offset_curve<>():Curve set get
Each particle's animation offset will vary along this Curve. Should be a unit Curve.

set get float anim_offset_max<>():float set get
Maximum animation offset.

set get float anim_offset_min<>():float set get
Minimum animation offset.

set get Curve anim_speed_curve<>():Curve set get
Each particle's animation speed will vary along this Curve. Should be a unit Curve.

set get float anim_speed_max<>():float set get
Maximum particle animation speed.

set get float anim_speed_min<>():float set get
Minimum particle animation speed.

set get Color color<>():Color set get
Each particle's initial color.

Note: color multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, [member 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.
 set get Gradient color_initial_ramp<>():Gradient set get
Each particle's initial color will vary along this Gradient (multiplied with color).

Note: 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] 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.
 set get Gradient color_ramp<>():Gradient set get
Each particle's color will vary along this Gradient over its lifetime (multiplied with color).

Note: color_ramp multiplies the particle mesh's vertex colors. To have a visible effect on a BaseMaterial3D, [member 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.
 set get Curve damping_curve<>():Curve set get
Damping will vary along this Curve. Should be a unit Curve.

set get float damping_max<>():float set get
Maximum damping.

set get float damping_min<>():float set get
Minimum damping.

set get Vector3 direction<>():Vector3 set get
Unit vector specifying the particles' emission direction.

set get int draw_order<>():int set get
Particle draw order.

set get Vector3 emission_box_extents<>():Vector3 set get
The rectangle's extents if emission_shape is set to EMISSION_SHAPE_BOX.

set get PackedColorArray emission_colors<>():PackedColorArray set get
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, [member 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.
 set get PackedVector3Array emission_normals<>():PackedVector3Array set get
Sets the direction the particles will be emitted in when using EMISSION_SHAPE_DIRECTED_POINTS.

set get PackedVector3Array emission_points<>():PackedVector3Array set get
Sets the initial positions to spawn particles when using EMISSION_SHAPE_POINTS or EMISSION_SHAPE_DIRECTED_POINTS.

set get Vector3 emission_ring_axis<>():Vector3 set get
The axis of the ring when using the emitter EMISSION_SHAPE_RING.

set get float emission_ring_cone_angle<>():float set get
The angle of the cone when using the emitter EMISSION_SHAPE_RING. The default angle of 90 degrees results in a ring, while an angle of 0 degrees results in a cone. Intermediate values will result in a ring where one end is larger than the other.

Note: Depending on emission_ring_height, the angle may be clamped if the ring's end is reached to form a perfect cone.
 set get float emission_ring_height<>():float set get
The height of the ring when using the emitter EMISSION_SHAPE_RING.

set get float emission_ring_inner_radius<>():float set get
The inner radius of the ring when using the emitter EMISSION_SHAPE_RING.

set get float emission_ring_radius<>():float set get
The radius of the ring when using the emitter EMISSION_SHAPE_RING.

set get int emission_shape<>():int set get
Particles will be emitted inside this region.

set get float emission_sphere_radius<>():float set get
The sphere's radius if EmissionShape is set to EMISSION_SHAPE_SPHERE.

set get bool emitting<>():bool set get
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.

set get float explosiveness<>():float set get
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.

set get int fixed_fps<>():int set get
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.

set get float flatness<>():float set get
Amount of spread in Y/Z plane. A value of 1 restricts particles to X/Z plane.

set get bool fract_delta<>():bool set get
If true, results in fractional delta calculation which has a smoother particles display effect.

set get Vector3 gravity<>():Vector3 set get
Gravity applied to every particle.

set get Curve hue_variation_curve<>():Curve set get
Each particle's hue will vary along this Curve. Should be a unit Curve.

set get float hue_variation_max<>():float set get
Maximum hue variation.

set get float hue_variation_min<>():float set get
Minimum hue variation.

set get float initial_velocity_max<>():float set get
Maximum value of the initial velocity.

set get float initial_velocity_min<>():float set get
Minimum value of the initial velocity.

set get float lifetime<>():float set get
Amount of time each particle will exist.

set get float lifetime_randomness<>():float set get
Particle lifetime randomness ratio.

set get Curve linear_accel_curve<>():Curve set get
Each particle's linear acceleration will vary along this Curve. Should be a unit Curve.

set get float linear_accel_max<>():float set get
Maximum linear acceleration.

set get float linear_accel_min<>():float set get
Minimum linear acceleration.

set get bool local_coords<>():bool set get
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.

set get Mesh mesh<>():Mesh set get
The Mesh used for each particle. If null, particles will be spheres.

set get bool one_shot<>():bool set get
If true, only one emission cycle occurs. If set true during a cycle, emission will stop at the cycle's end.

set get Curve orbit_velocity_curve<>():Curve set get
Each particle's orbital velocity will vary along this Curve. Should be a unit Curve.

set get float orbit_velocity_max<>():float set get
Maximum orbit velocity.

set get float orbit_velocity_min<>():float set get
Minimum orbit velocity.

set get bool particle_flag_align_y<>():bool set get
Align Y axis of particle with the direction of its velocity.

set get bool particle_flag_disable_z<>():bool set get
If true, particles will not move on the Z axis.

set get bool particle_flag_rotate_y<>():bool set get
If true, particles rotate around Y axis by angle_min.

set get float preprocess<>():float set get
Particle system starts as if it had already run for this many seconds.

set get Curve radial_accel_curve<>():Curve set get
Each particle's radial acceleration will vary along this Curve. Should be a unit Curve.

set get float radial_accel_max<>():float set get
Maximum radial acceleration.

set get float radial_accel_min<>():float set get
Minimum radial acceleration.

set get float randomness<>():float set get
Emission lifetime randomness ratio.

set get Curve scale_amount_curve<>():Curve set get
Each particle's scale will vary along this Curve. Should be a unit Curve.

set get float scale_amount_max<>():float set get
Maximum scale.

set get float scale_amount_min<>():float set get
Minimum scale.

set get Curve scale_curve_x<>():Curve set get
Curve for the scale over life, along the x axis.

set get Curve scale_curve_y<>():Curve set get
Curve for the scale over life, along the y axis.

set get Curve scale_curve_z<>():Curve set get
Curve for the scale over life, along the z axis.

set get int seed<>():int set get
Sets the random seed used by the particle system. Only effective if use_fixed_seed is true.

set get float speed_scale<>():float set get
Particle system's running speed scaling ratio. A value of 0 can be used to pause the particles.

set get bool split_scale<>():bool set get
If set to true, three different scale curves can be specified, one per scale axis.

set get float spread<>():float set get
Each particle's initial direction range from +spread to -spread degrees. Applied to X/Z plane and Y/Z planes.

set get Curve tangential_accel_curve<>():Curve set get
Each particle's tangential acceleration will vary along this Curve. Should be a unit Curve.

set get float tangential_accel_max<>():float set get
Maximum tangent acceleration.

set get float tangential_accel_min<>():float set get
Minimum tangent acceleration.

set get bool use_fixed_seed<>():bool set get
If true, particles will use the same seed for every simulation using the seed defined in seed. This is useful for situations where the visual outcome should be consistent across replays, for example when using Movie Maker mode.

set get AABB visibility_aabb<>():AABB set get
The AABB that determines the node's region which needs to be visible on screen for the particle system to be active.

Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The AABB can be grown via code or with the Particles → Generate AABB editor tool.
 AABB capture_aabb<>():AABB
Returns the axis-aligned bounding box that contains all the particles that are active in the current frame.

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<>( int param=, param:int=, ):Curve
Returns the Curve of the parameter specified by Parameter.

float get_param_max<>( int param=, param:int=, ):float
Returns the maximum value range for the given parameter.

float get_param_min<>( int param=, param:int=, ):float
Returns the minimum value range for the given parameter.

bool get_particle_flag<>( int particle_flag=, particle_flag:int=, ):bool
Returns the enabled state of the given particle flag.

void request_particles_process<>( float process_time=, process_time:float=, ):void
Requests the particles to process for extra process time during a single frame.

Useful for particle playback, if used in combination with use_fixed_seed or by calling restart with parameter keep_seed set to true.
 void restart<>( bool keep_seed=false, keep_seed:bool=false, ):void
Restarts the particle emitter.

If keep_seed is true, the current random seed will be preserved. Useful for seeking and playback.
 void set_param_curve<>( int param=, param:int=, Curve curve=, curve:Curve=, ):void
Sets the Curve of the parameter specified by Parameter. Should be a unit Curve.

void set_param_max<>( int param=, param:int=, float value=, value:float=, ):void
Sets the maximum value for the given parameter.

void set_param_min<>( int param=, param:int=, float value=, value:float=, ):void
Sets the minimum value for the given parameter.

void set_particle_flag<>( int particle_flag=, particle_flag:int=, bool enable=, enable:bool=, ):void
Enables or disables the given particle flag.




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