Epok Engine

EPOK RUNTIME

Particle Effect Runtime

particle_effect_runtime.hpp · runtime effects and their deterministic playback state

Module

runtime effects and their deterministic playback state.

Header
particle_effect_runtime.hpp
Include
#include "particle_effect_runtime.hpp"
Stability
Engine internal

Include this module

C++ include
#include "particle_effect_runtime.hpp"

Types

AssetStruct declared by the particle-effect-runtime module for runtime effects and their deterministic playback state.StructLayerDefinitionStruct declared by the particle-effect-runtime module for runtime effects and their deterministic playback state.StructLayerInitializerType alias declared by the particle-effect-runtime module for runtime effects and their deterministic playback state.Type aliasPoolOne fixed effect pool uses the shared sequence director.ClassStateEnum declared by the particle-effect-runtime module for runtime effects and their deterministic playback state.EnumStatsStruct declared by the particle-effect-runtime module for runtime effects and their deterministic playback state.Struct

Functions and methods

~PoolReleases the resources owned by `epok::effects::Pool`.destructoradvanceCall after the director, before the single particle simulation step.MethodburstPerforms `burst` as part of runtime effects and their deterministic playback state.Methodcancel_ownerPerforms `cancel owner` as part of runtime effects and their deterministic playback state.MethodemittersPerforms `emitters` as part of runtime effects and their deterministic playback state.Function templatelayerPerforms `layer` as part of runtime effects and their deterministic playback state.Methodlighting_ownerPerforms `lighting owner` as part of runtime effects and their deterministic playback state.MethodmovePerforms `move` as part of runtime effects and their deterministic playback state.MethodobserveCapture completion before gameplay can reuse a completed director slot.Methodoperator=Performs `operator =` as part of runtime effects and their deterministic playback state.MethodpausePauses pause as part of runtime effects and their deterministic playback state.MethodPoolConstructs `epok::effects::Pool` for runtime effects and their deterministic playback state.constructorprepareCall before the shared director advances.MethodresetResets reset as part of runtime effects and their deterministic playback state.MethodsequencePerforms `sequence` as part of runtime effects and their deterministic playback state.MethodsnapshotPerforms `snapshot` as part of runtime effects and their deterministic playback state.MethodspawnPerforms `spawn` as part of runtime effects and their deterministic playback state.MethodspritesPerforms `sprites` as part of runtime effects and their deterministic playback state.Function templatestatePerforms `state` as part of runtime effects and their deterministic playback state.MethodstopStops stop as part of runtime effects and their deterministic playback state.MethodtintPerforms `tint` as part of runtime effects and their deterministic playback state.Method

Fields, variables and values

activeExposes `active` on `epok::effects::Stats` for runtime effects and their deterministic playback state.Fieldactive_layersExposes `active_layers` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldcancelledExposes `cancelled` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldCancelledNamed value `Cancelled` in `epok::effects::State`.Enum valuecapacityExposes `capacity` on the `epok::effects` namespace for runtime effects and their deterministic playback state.Variableclamped_ticksExposes `clamped_ticks` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldcolumnsExposes `columns` on `epok::effects::LayerDefinition` for runtime effects and their deterministic playback state.FieldcompletedExposes `completed` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldCompletedNamed value `Completed` in `epok::effects::State`.Enum valueDrainingNamed value `Draining` in `epok::effects::State`.Enum valuedroppedExposes `dropped` on `epok::effects::Stats` for runtime effects and their deterministic playback state.Fielddropped_burstsExposes `dropped_bursts` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldemitterExposes `emitter` on `epok::effects::LayerDefinition` for runtime effects and their deterministic playback state.Fieldframe_ticksExposes `frame_ticks` on `epok::effects::LayerDefinition` for runtime effects and their deterministic playback state.FieldframesExposes `frames` on `epok::effects::LayerDefinition` for runtime effects and their deterministic playback state.FieldidExposes `id` on `epok::effects::Asset` for runtime effects and their deterministic playback state.FieldinitialExposes `initial` on `epok::effects::LayerDefinition` for runtime effects and their deterministic playback state.FieldInvalidNamed value `Invalid` in `epok::effects::State`.Enum valuelayer_capacityExposes `layer_capacity` on the `epok::effects` namespace for runtime effects and their deterministic playback state.Variablelayer_countExposes `layer_count` on `epok::effects::Asset` for runtime effects and their deterministic playback state.FieldlayersExposes `layers` on `epok::effects::Asset` for runtime effects and their deterministic playback state.FieldpeakExposes `peak` on `epok::effects::Stats` for runtime effects and their deterministic playback state.Fieldpeak_layersExposes `peak_layers` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldPlayingNamed value `Playing` in `epok::effects::State`.Enum valueseedExposes `seed` on `epok::effects::Asset` for runtime effects and their deterministic playback state.FieldslotExposes `slot` on `epok::effects::LayerDefinition` for runtime effects and their deterministic playback state.FieldspawnedExposes `spawned` on `epok::effects::Stats` for runtime effects and their deterministic playback state.FieldstatsExposes `stats` on `epok::effects::Pool` for runtime effects and their deterministic playback state.FieldtimelineExposes `timeline` on `epok::effects::Asset` for runtime effects and their deterministic playback state.Field