Skip to content

VfxShimmerEmitterDefinitionData

16.16 Value struct

Class Documentation

Edit documentation

A component emitter: an emitter definition that delegates its behavior to the component graph in its VfxComponents property instead of carrying it as properties. It is the third emitter list on VfxSystemDefinitionData, held by ShimmerEmitterDefinitionData, and keeps only a handful of gates of its own; emission, lifetime, physics, material and geometry all come from the graph. The graph's page describes the slots and the order in which they run, see VfxComponents.

An incomplete graph drops the emitter. While the system is prepared, every entry whose disabled is unset and that passes Filtering must supply a lifetime component, a physics component, a render component, and a geometry component that resolves to a primitive. An entry missing any of those is discarded there and never reaches the running system. The other two emitter lists have no equivalent check, so a misconfigured complex or simple emitter still runs.

Spawn gates. When a system instance spawns, ChanceToNotExist and colorblindVisibility decide whether the emitter is created, as they do for complex emitters. No material overrides are bound for these emitters.

Properties

ChanceToNotExist

F32 = 0
Edit documentation

Probability, 0 to 1, that the emitter is left out of an instance. One random number in 0..1 is drawn per emitter when the system spawns, and the emitter is skipped when this value is greater. The same effect played twice can differ.

Filtering

Pointer<VfxEmitterFiltering> = null
16.20
Edit documentation

Optional conditions on the emitter's existence, see Filtering. For these emitters only spectatorPolicy is tested, once while the system is prepared. An entry that fails it is not built. The keyword lists are not tested.

ParticleScale

Vec3 = [1, 1, 1]
Edit documentation

Per-axis scale, 1 on each axis meaning unscaled. What it scales, and at what point, is not yet identified.

VfxComponents

Pointer<VfxComponents> = null
Edit documentation

The component graph supplying the emitter's entire behavior: lifetime, physics, rendering, geometry, and optionally children and extra components.

Required, and required to be complete. Without a lifetime, physics and render component, and a geometry component that resolves to a primitive, the emitter is discarded while the system is prepared.

colorblindVisibility

U8 = 0
Edit documentation

Filters the emitter by colour palette when the system spawns.

Value Emitter is created
0 always
1 only with the normal palette
2 only with the colourblind palette
3 and above never

disabled

Bool = false
Edit documentation

Skips the emitter. Tested while the system is prepared, so a disabled entry is never built at all rather than being suppressed per spawn.

emitterName

String = ""
Edit documentation

Name of the emitter. Passed to the render component while the draw setup is built, so it reaches the renderer as data rather than serving only as an authoring label.

importance

U8 = 2
Removed in 16.21
Add documentation

No documentation available yet. Click "Add documentation" to contribute!

isUniformScale

Bool = false
Edit documentation

When a child component creates a child system on a bone, the X scale is used for all three axes of the child's scale.

Referenced by 1 class · 1 property