deki-particles 1.3.0
Deki package reference
deki-particles

Modular particle emitter (gravity, drag, velocity, lifetime modifiers)

Repository: github.com/dekiengine/deki-particles · Latest release: 1.2.0 · Needs engine 1.2.0+ · Requires: deki-nodegraph, deki-rendering, deki-2d

Install: DekiEditor --packages-add deki-particles <project>, or add it in the Package Manager. Part of Deki; the engine's own components and the C++ API are documented there.

Shown in the editor as Particles.

Components

Component Category Description
ParticleEmitterComponent Particles Spawns and draws particles, following a particle graph asset.

Feature flags

Compile-time features the package exposes (package.json):

Feature Define Default
Particle Emitter DEKI_FEATURE_PARTICLE_EMITTER on

Component reference

ParticleEmitterComponent

Spawns and draws particles, following a particle graph asset.

Inspector name: Particle Emitter Component · Category: Particles · Type GUID: b1e0e1a0-1111-4002-9002-000000000010

Property Type Default Constraints Description
sprite AssetRef (Sprite) ""
graph AssetRef (ParticleGraph) ""
maxParticles int32 64 0 to 4096
playOnAwake bool true
looping bool true
worldSpace bool true

Inherits sortingOrder, ignoreClip, pixelSnap, alphaMode from RendererComponent.


Generated from the package's reflection metadata by the Deki documentation build (engine 1.3.0). Reflected property names are the keys scene files use; a rename ships with an alias, see COMPATIBILITY.md.