Table of Contents

Class Particle

Namespace
BasilEngine.Components
Assembly
BasilEngine.dll
[NativeHeader("Bindings/ManagedParticle.hpp")]
public class Particle : Component
Inheritance
Particle
Inherited Members

Properties

acceleration

Constant acceleration applied to particles.

public Vector3 acceleration { get; set; }

Property Value

Vector3

activeCount

Number of currently active particles.

public int activeCount { get; }

Property Value

int

autoPlay

Automatically starts playback when the component is enabled.

public bool autoPlay { get; set; }

Property Value

bool

blend

Blending mode used when rendering particles.

public Particle.BlendMode blend { get; set; }

Property Value

Particle.BlendMode

depthWrite

Whether particles write to the depth buffer.

public bool depthWrite { get; set; }

Property Value

bool

duration

Duration in seconds before the system stops emitting.

public float duration { get; set; }

Property Value

float

emissionRate

Number of particles emitted per second.

public float emissionRate { get; set; }

Property Value

float

emissionType

Shape from which particles are emitted.

public Particle.EmissionType emissionType { get; set; }

Property Value

Particle.EmissionType

emitterSize

Size of the emitter when using box emission.

public Vector3 emitterSize { get; set; }

Property Value

Vector3

endColor

Color particles transition to over their lifetime.

public Vector4 endColor { get; set; }

Property Value

Vector4

endSize

Final particle size at the end of its lifetime.

public float endSize { get; set; }

Property Value

float

isAlive

Indicates whether any particles are alive.

public bool isAlive { get; }

Property Value

bool

isPlaying

Indicates whether the system is currently emitting.

public bool isPlaying { get; }

Property Value

bool

looping

Whether the system restarts automatically after finishing.

public bool looping { get; set; }

Property Value

bool

maxLifetime

Maximum lifetime of spawned particles.

public float maxLifetime { get; set; }

Property Value

float

maxParticles

Maximum number of particles alive at once.

public int maxParticles { get; set; }

Property Value

int

minLifetime

Minimum lifetime of spawned particles.

public float minLifetime { get; set; }

Property Value

float

renderLayer

Render layer mask applied to particles.

public uint renderLayer { get; set; }

Property Value

uint

rotationSpeed

Rotation speed applied over the particle's lifetime.

public float rotationSpeed { get; set; }

Property Value

float

sphereRadius

Radius when using spherical emission.

public float sphereRadius { get; set; }

Property Value

float

startColor

Initial color of spawned particles.

public Vector4 startColor { get; set; }

Property Value

Vector4

startRotation

Initial rotation of spawned particles in degrees.

public float startRotation { get; set; }

Property Value

float

startSize

Initial particle size.

public float startSize { get; set; }

Property Value

float

startVelocity

Initial velocity assigned to new particles.

public Vector3 startVelocity { get; set; }

Property Value

Vector3

velocityRandomness

Randomness applied to the starting velocity magnitude.

public float velocityRandomness { get; set; }

Property Value

float

Methods

Play()

Starts the particle simulation.

public void Play()

Reset()

Stops and clears all particles.

public void Reset()

Stop()

Stops emission but keeps existing particles alive.

public void Stop()
Edit this page