Trade-offs and warnings
Consult the linked header for this operation’s ownership, lifetime and failure behavior.
EPOK RUNTIME
Method · 1 overload
Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.
Starts effect as part of the gameplay api module.
static effects::Handle play_effect(ObjectId component)Starts effect as part of the gameplay api module.
| Parameter | Type | Meaning |
|---|---|---|
component | ObjectId | Not documented; consult the linked header. |
Returns: effects::Handle. Consult the linked header for its meaning.
#include "gameplay_api.hpp"
// Assume these named values have been initialized with valid data:
// ObjectId component
auto result = epok::PlaybackLibrary::play_effect(component);Consult the linked header for this operation’s ownership, lifetime and failure behavior.
Declared in runtime/gameplay_api.hpp:505
burst_effectPerforms `burst effect` as part of the gameplay api module.Methodeffect_sequencePerforms `effect sequence` as part of the gameplay api module.Methodeffect_statePerforms `effect state` as part of the gameplay api module.Methodpause_effectPauses effect as part of the gameplay api module.Methodpause_sequencePauses sequence as part of the gameplay api module.Methodplay_sequenceStarts sequence as part of the gameplay api module.Methodresume_effectResumes effect as part of the gameplay api module.Methodresume_sequenceResumes sequence as part of the gameplay api module.Methodsequence_statePerforms `sequence state` as part of the gameplay api module.Methodstop_effectStops effect as part of the gameplay api module.Methodstop_sequenceStops sequence as part of the gameplay api module.Method