DOCS // pyrofx

Emitters

A spec takes any number of [[emitters]]: spheres, boxes, discs, rings or points that add fuel, heat, smoke or dust. Key position_m and rotation_deg to move and turn them.

Contents4 sections
  1. Example
  2. Fields
  3. Obstacles
  4. Questions

Example

The impact example: a hot flash and a cold cone of thrown earth (a third ring emitter throws the ground skirt):

impact.pyro.toml (excerpt)
# The flash. Little fuel and a short burn, so its heat does not carry the dust up as a column.
[[emitters]]
shape = "sphere"
position_m = [0, 0.3, 0]
size_m = 0.4
start_s = 0.0
end_s = 0.06
fuel = 3
temperature_k = 1900
smoke = 2.0
velocity_mps = 6
direction = "radial"

# Earth thrown up and outward in a wide cone.
[[emitters]]
shape = "sphere"
position_m = [0, 0.25, 0]
size_m = 0.4
start_s = 0.0
end_s = 0.15
fuel = 0
temperature_k = 293
dust = 12
velocity_mps = 11
direction = "up"
spread_deg = 120
jitter = 0.6
IMPACTFINAL
First frame of the impact bake
Impact, 3.5 x 2.8 m, compiled with Spatial Compiler. Spec →

Hot gas lifts dust, so keep a flash small and short when dust should fall.

Fields

Fields marked (t) take keys over time.

FieldMeaningDefault
shapesphere, box, disc, ring or pointssphere
position_mCenter (t). Keys move it; fast moves leave an unbroken trail.[0, 0.5, 0]
size_mRadius for a sphere, disc or ring; half-extents for a box (t)0.5
rotation_degRotation about X, then Y, then Z (t)[0, 0, 0]
start_s, end_sWhen it emits; end_s = 1000 for a steady source0, 0.2
fuelFuel added per second, as a 0 to 1 concentration (t)4.0
temperature_kTemperature of what it emits (t)1800
smokeSmoke added per second, independent of burning (t)0
dustDust added per second: heavy, cold, takes the ground color (t)0
velocity_mpsSpeed of emitted gas (t). 0 adds gas without pushing air.6
directionradial, up, or a vector in the emitter's own frame (t)radial
spread_degCone half-angle around direction (t)180
jitterRandom variation of speed and position, 0 to 1 (t)0.3
inherit_velocityShare of the source’s speed passed on: 0 trails, 1 throws forward0
lumpinessUnevenness, 0 to 1 (t); 0 is a smooth dome0.5

Obstacles

Keep emitters clear of obstacles. An emitter that pokes through a wall burns on both sides.

See Model-shaped emitters.

Questions

What shapes can a pyrofx emitter use?

An emitter can use sphere, box, disc, ring or points shapes to add fuel, heat, smoke or dust.

How do I keep dust from rising with a flash in pyrofx?

Keep the flash emitter small with little fuel and a short burn so its heat does not lift the dust.

What happens if a pyrofx emitter pokes through an obstacle?

An emitter that pokes through a wall burns on both sides, so keep emitters clear of obstacles.