-
Notifications
You must be signed in to change notification settings - Fork 1
🧩 ParticleSystem
The ParticleSystem component manages the emission, update, and destruction of multiple particles.
It defines when and where particles are spawned, and applies a user-defined configuration function (behavior lambda) to each one.
Typical use cases include explosions, fire, smoke, sparks, or magical effects.
When Emit is active, the system periodically spawns new particles inside the defined emitArea.
Each new particle is configured using the provided behavior lambda, then added to the scene and updated every frame.
Particles automatically expire once their lifetime ends, at which point they are destroyed and removed from the system.
A debug visualization is also available, rendering the emission area as an outline in the scene.
ParticleSystem()Creates a new ParticleSystem with no emission. Emission begins only after Emit is called.
-
Time delay: Interval between consecutive particle emissions. -
ShapePtr emitArea: Area from which particles are spawned (rect, circle, or polygon). -
bool enableCollision: Whether emitted particles participate in collisions.
void SetDelay(Time delay)Defines the emission interval.
void SetEmitArea(ShapePtr emitArea)Sets the spawn area for new particles.
void Emit()Starts emitting particles.
void Stop()Stops emission and resets timer.
The Particle entity represents a lightweight physics-driven object with a limited lifetime, typically used for visual effects such as sparks, smoke, or debris.
It exposes basic physical properties (density, friction, restitution, damping, velocity) and can optionally interact with the physics world through collisions.
Particles are managed by a ParticleSystem and are not intended to behave as full gameplay entities.
On every update, the particle reduces its lifetime and updates its transform based on the underlying physics body. Once its lifetime reaches zero, the particle is destroyed and removed from the system.
Particles can receive forces, impulses, velocities, damping, and torque to control their short-lived behavior.
Particle()Creates a new Particle instance with default parameters. The physics body is created when Create is called.
-
Time lifetime: Duration until the particle is automatically destroyed. -
Transform transform: Current world position and rotation of the particle. -
ShapePtr shape: Collision shape of the particle (default: 25×25 rectangle).
void Create(Vector2 position, bool enableCollision)Initializes the particle with a physics body at the given position.
void SetDensity(float density)Updates the body’s mass density.
void SetFriction(float friction)Sets surface friction.
void SetRestitution(float restitution)Sets elasticity for bounces.
void SetRestitutionThreshold(float threshold)Controls minimum collision impulse for restitution.
void ApplyForce(Vector2 force, bool wake)Applies continuous force at the center.
void ApplyLinearForce(Vector2 force, bool wake)Applies an instantaneous impulse.
void SetLinearVelocity(Vector2 velocity)Directly sets velocity.
void SetHorizontalVelocity(float vy) Adjusts only vertical velocity.
void SetVerticalVelocity(float vx)Adjusts only horizontal velocity.
void SetAngularVelocity(float va)Sets rotation speed.
void SetAngularDamping(float ad)Slows down angular motion.
void SetLinearDamping(float ld)Slows down linear motion.
void ApplyAngularImpulse(float impulse)Applies a rotation impulse.
void ApplyTorque(float torque, bool wake)Applies continuous torque.
void SetAngle(float angle)Rotates the body to the given angle.
void SetFixedRotation(bool flag)Locks/unlocks rotation.
void SetLifetime(Time lifetime)Defines how long the particle will live.