jengine-particles
Particle system package for jEngine — 2D particle emitters and simulation.
| Kind | Built-in: linked into the stock runtime and editor viewport |
| Source | packages/jengine-particles |
| Version | 0.1.0 |
| Entry point | jengine_particles::ParticlesPackage |
Using it
Section titled “Using it”The stock runtime, web build and editor viewport are compiled with this package, so there is
nothing to link. A project that has a settings.enabled_packages list must name it there, since
that list is an allow-list once it exists; a project without the key gets every built-in.
{ "settings": { "enabled_packages": ["jengine-particles"] } }Its components are also core components, so v1 and v2 scenes both carry them.
Components
Section titled “Components”| Scene key | Rust type | |
|---|---|---|
particle_emitter | ParticleEmitter | also registered by core |
Scenes that use it
Section titled “Scenes that use it”projects/arcade-classics/assets/scenes/breakout.sceneprojects/arcade-classics/assets/scenes/lemonrow.sceneprojects/arcade-classics/assets/scenes/pong.sceneprojects/car-classics/assets/scenes/climb.sceneprojects/car-classics/assets/scenes/hunter.sceneprojects/car-classics/assets/scenes/kart.sceneprojects/car-classics/assets/scenes/micro.sceneprojects/car-classics/assets/scenes/micro_online.sceneprojects/car-classics/assets/scenes/outrun.sceneprojects/car-classics/assets/scenes/parking.sceneprojects/car-classics/assets/scenes/pursuit.sceneprojects/car-classics/assets/scenes/rally.scene- …and 211 more
From packages/jengine-particles/README.md.
Particle emitters: fire, smoke, sparks, rain.
This is a built-in package: the native runtime, the web runtime and the
editor viewport are compiled with it. It registers the component; the
simulation is core’s particles::tick_particles, which every runtime calls
once a frame, so emitters behave the same everywhere.
What it registers
Section titled “What it registers”| Component | Is |
|---|---|
particle_emitter | An emitter: emission_rate, max_particles, lifetime, speed, angle, start / end colour and size, gravity_modifier, emit_shape, blend_mode, world_space, z_order - and the newer fields: drag, turbulence, colour and size curves, stretch, collision with colliders and sub_emitters. |
particle_emitter is also a core component, so it works in v1 and v2
scenes. An emitter can name a shared definition instead of carrying every
field: { "particle_source": "particles/fire.particle" } loads one.
For hundreds of thousands of particles drawn by the GPU, use core’s
gpu_particles component instead.
From scripts
Section titled “From scripts”Scripts use core’s Particles namespace in every runtime:
Particles.emit_burst, Particles.set_active, Particles.set_rate,
Particles.get_count, and Particles.set(e, field, value) for any emitter
field by name. See the Particles guide.
The package’s own particle_* script descriptors are metadata only; no
runtime installs them as globals.