Epok Engine

EPOK RUNTIME

epok::bp::Timeline::play

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.

Method

Starts play as part of compiled Blueprint execution and object interaction.

Belongs to
epok::bp::Timeline
Header
blueprint_runtime.hpp
Overloads
1

Declaration

Declaration
bool play(ObjectId source, uint32_t scene_generation = 0, bool loop = false)

Starts play as part of compiled Blueprint execution and object interaction.

ParameterTypeMeaning
sourceObjectIdNot documented; consult the linked header.
scene_generationuint32_tNot documented; consult the linked header.
loopboolNot documented; consult the linked header.

Returns: bool. Consult the linked header for its meaning.

Example sketch

C++ example
#include "blueprint_runtime.hpp"

// Assume these named values have been initialized with valid data:
// ObjectId source
// uint32_t scene_generation
// bool loop

epok::bp::Timeline& object = /* obtain a valid instance */;

auto result = object.play(source, scene_generation, loop);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/blueprint_runtime.hpp:213

Related members