Skip to main content

Crate hanabi_effect_graph

Crate hanabi_effect_graph 

Source
Expand description

Edit-time effect graph asset and its bake to a runtime EffectAsset.

EffectGraphAsset is a stable-identity, serializable graph the editor mutates directly and saves to disk. An EffectAsset is a derived bake output of it (see bake), used for preview and runtime.

This crate is egui- and editor-agnostic so it can be used in two ways:

Modules§

bake
Baking an EffectGraph into a runtime bevy_hanabi::EffectAsset.
demo
A native EffectGraph equivalent of the programmatic demo effect.
import
Best-effort import of a baked EffectAsset into an EffectGraph.
model
Data types of the EffectGraph model.
modifier_names
User-facing display names for bevy_hanabi modifiers.
modifier_ops
Modifier list mutation primitives.
modifier_registry
Discovers modifier types and their factories via AppTypeRegistry.
processor
Bakes .hnb EffectGraphAsset files into runtime EffectAssets.
schema
Reflection-derived field schema for modifier nodes.
validation
Effect-graph validation checks.

Structs§

EffectGraphLoader
Loads .hnb RON files into an EffectGraphAsset.
EffectGraphPlugin
Registers EffectGraphAsset and its EffectGraphLoader.

Enums§

EffectGraphLoaderError
Errors produced while loading an EffectGraphAsset.
ModifierGroup
Which of the three modifier lists a modifier lives in.

Constants§

MAGIC_HEADER
Leading marker line stamped on every .hnb file for content detection.

Functions§

from_ron_bytes
Parse an EffectGraphAsset from RON bytes.
to_ron_string
Serialize an EffectGraphAsset to pretty RON for writing a .hnb file.