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 ObjectNodeCanvasItemNode2D CPUParticles2D
A CPU-based 2D particle emitter.

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

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

 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.

 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.

 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

Present for consistency with 3D particle nodes, not used in 2D.


PARTICLE_FLAG_DISABLE_Z = 2

Present for consistency with 3D particle nodes, not used in 2D.


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 flattened to two dimensions.


EMISSION_SHAPE_SPHERE_SURFACE = 2

Particles will be emitted on the surface of a sphere flattened to two dimensions.


EMISSION_SHAPE_RECTANGLE = 3

Particles will be emitted in the area of a rectangle.


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

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. Should be a unit Curve.

 float angle_max<>():float

Maximum initial rotation applied to each particle, in degrees.

 float angle_min<>():float

Minimum equivalent of angle_max.

 Curve angular_velocity_curve<>():Curve

Each particle's angular velocity will vary along this Curve. Should be a unit Curve.

 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 equivalent of angular_velocity_max.

 Curve anim_offset_curve<>():Curve

Each particle's animation offset will vary along this Curve. Should be a unit Curve.

 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.

 Curve anim_speed_curve<>():Curve

Each particle's animation speed will vary along this Curve. Should be a unit Curve.

 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.

 Color color<>():Color

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

 Gradient color_initial_ramp<>():Gradient

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

 Gradient color_ramp<>():Gradient

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

 Curve damping_curve<>():Curve

Damping will vary along this Curve. Should be a unit Curve.

 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.

 Vector2 direction<>():Vector2

Unit vector specifying the particles' emission direction.

 DrawOrder draw_order<>():DrawOrder

Particle draw order. Uses DrawOrder values.

 PackedColorArray emission_colors<>():PackedColorArray

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

Note: The returned array is copied and any changes to it will not update the original property value. See PackedColorArray for more details.

 PackedVector2Array emission_normals<>():PackedVector2Array

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

Note: The returned array is copied and any changes to it will not update the original property value. See PackedVector2Array for more details.

 PackedVector2Array emission_points<>():PackedVector2Array

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

Note: The returned array is copied and any changes to it will not update the original property value. See PackedVector2Array for more details.

 Vector2 emission_rect_extents<>():Vector2

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

 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 emission_shape 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 simulation of the particle system itself.

 bool fract_delta<>():bool

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

 Vector2 gravity<>():Vector2

Gravity applied to every particle.

 Curve hue_variation_curve<>():Curve

Each particle's hue will vary along this Curve. Should be a unit Curve.

 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 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<>():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. Should be a unit Curve.

 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.

 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 CPUParticles2D node (and its parents) when it is moved or rotated. If false, particles use global coordinates; they will not move or rotate along the CPUParticles2D node (and its parents) when it is moved or rotated.

 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. Should be a unit Curve.

 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.

 float orbit_velocity_min<>():float

Minimum equivalent of orbit_velocity_max.

 bool particle_flag_align_y<>():bool

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

 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. Should be a unit Curve.

 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.

 float randomness<>():float

Emission lifetime randomness ratio.

 Curve scale_amount_curve<>():Curve

Each particle's scale will vary along this Curve. Should be a unit Curve.

 float scale_amount_max<>():float

Maximum initial scale applied to each particle.

 float scale_amount_min<>():float

Minimum equivalent of scale_amount_max.

 Curve scale_curve_x<>():Curve

Each particle's horizontal scale will vary along this Curve. Should be a unit Curve.

split_scale must be enabled.

 Curve scale_curve_y<>():Curve

Each particle's vertical scale will vary along this Curve. Should be a unit Curve.

split_scale must be enabled.

 int seed<>():int

Sets the random seed used by the particle system. Only effective if use_fixed_seed is true.

 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 true, the scale curve will be split into x and y components. See scale_curve_x and scale_curve_y.

 float spread<>():float

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

 Curve tangential_accel_curve<>():Curve

Each particle's tangential acceleration will vary along this Curve. Should be a unit Curve.

 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.

 Texture2D texture<>():Texture2D

Particle texture. If null, particles will be squares.

 bool use_fixed_seed<>():bool

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.

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

Sets this node's properties to match a given GPUParticles2D 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 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<>( Parameter param=, param:Parameter=, Curve curve=, curve:Curve=, ):void

Sets the Curve of the parameter specified by Parameter. Should be a unit Curve.

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