Struct ParticleEmitter 

pub struct ParticleEmitter {

    pub rate: f32,
    pub burst: i32,
    pub lifetime: f32,
    pub lifetime_variation: f32,
    pub speed: f32,
    pub speed_variation: f32,
    pub spread: f32,
    pub gravity: f32,
    pub drag: f32,
    pub size_start: f32,
    pub size_end: f32,
    pub color_start: [f32; 4],
    pub color_end: [f32; 4],
    pub glow: f32,
    pub shape: EmitterShape,
    pub shape_size: f32,
    pub texture: String,
    pub looping: bool,
    pub duration: f32,
    pub max_particles: i32,
    pub seed: i32,
    pub stretch: f32,
    pub collide_floor: bool,
    pub floor_height: f32,
    pub splash: i32,
    pub follow_camera: bool,
    pub soft: f32,
    /* private fields */
}

A particle emitter.

Fields

rate: f32

Particles per second.

burst: i32

Particles released at once when the emitter starts.

lifetime: f32

Seconds a particle lives.

lifetime_variation: f32

Random +/- on the lifetime, 0..1.

speed: f32

Initial speed in metres per second.

speed_variation: f32

Random +/- on the speed, 0..1.

spread: f32

Spread of the launch direction around “up” (the emitter’s local Y), in degrees.

gravity: f32

Acceleration in m/s^2 (negative Y falls, positive Y rises like smoke).

drag: f32

Air resistance: velocity lost per second, 0..1+.

size_start: f32

Size of a particle at birth, metres.

size_end: f32

Size at the end of its life.

color_start: [f32; 4]

Colour at birth (RGBA).

color_end: [f32; 4]

Colour at the end of life (RGBA).

glow: f32

Brightness multiplier (glow), values above 1 make them shine.

shape: EmitterShape

Where particles are born.

shape_size: f32

Size of the emission area (radius of a sphere / disc / cone base, half-extent of a box).

texture: String

Particle image (a soft puff or spark with alpha). Empty = a soft round dot.

looping: bool

Keep emitting forever; off = one run of duration seconds.

duration: f32

Length of one run when not looping.

max_particles: i32

Upper limit of simultaneous particles.

seed: i32

Random seed.

stretch: f32

Stretches particles along their motion (rain streaks, sparks): extra length per m/s.

collide_floor: bool

Particles die when they fall below floor_height (world Y).

floor_height: f32

World height of the floor for collide_floor.

splash: i32

Little splash particles born where a particle hits the floor.

follow_camera: bool

The emitter keeps itself above the active camera (rain or snow around the player).

soft: f32

Soft fade where particles cut into surfaces, in metres (0 = hard edges).

Implementations

impl ParticleEmitter

pub fn preset(name: &str) -> Self

Ready-made emitters: “fire”, “smoke”, “sparks”, “snow”, “rain”, “heavy_rain”, “drizzle”, “magic”, “dust”, “explosion”, “fog”, “mist”, “steam”, “embers”, “fireflies”, “leaves”, “bubbles”, “campfire_smoke”, “dust_storm”.

pub fn alive(&self) -> usize

Particles alive right now.

pub fn restart(&mut self)

Restarts the emitter (a new burst, a new run).

Trait Implementations

impl Clone for ParticleEmitter

fn clone(&self) -> ParticleEmitter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for ParticleEmitter

const NAME: &'static str = "ParticleEmitter"

Stable, globally unique name; keep it identical in the host and script library.

const KEY: u64 = _

Storage key derived from [Self::NAME]. Normally should not be overridden.

impl Component for ParticleEmitter

fn fields(&mut self) -> Vec<Field<'_>>

Mutable field descriptors used by the Inspector and script property serialization.

const REMOVABLE: bool = true

Whether the user may remove it in the inspector.

impl Default for ParticleEmitter

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParticleEmitter

where ParticleEmitter: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ParticleEmitter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.