Epok Engine

EPOK RUNTIME

epok::timeline::Director::play

Method · 2 overloads

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 fixed-step simulation time and frame timing.

Belongs to
epok::timeline::Director
Header
timeline_runtime.hpp
Overloads
2

Declaration 1 of 2

Declaration
Handle play(const Asset& asset,BoundTarget owner,const BoundTarget* targets,uint32_t scene)

Starts play as part of fixed-step simulation time and frame timing.

ParameterTypeMeaning
assetconst Asset &Not documented; consult the linked header.
ownerBoundTargetNot documented; consult the linked header.
targetsconst BoundTarget *Not documented; consult the linked header.
sceneuint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "timeline_runtime.hpp"

// Assume these named values have been initialized with valid data:
// const Asset & asset
// BoundTarget owner
// const BoundTarget * targets
// uint32_t scene

epok::timeline::Director& object = /* obtain a valid instance */;

auto result = object.play(asset, owner, targets, scene);

Trade-offs and warnings

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

Declared in runtime/timeline_runtime.hpp:221

Declaration 2 of 2

Declaration
Handle play(const Asset& asset,DataHandle owner,const DataHandle* targets,uint32_t scene)

Starts play as part of fixed-step simulation time and frame timing.

ParameterTypeMeaning
assetconst Asset &Not documented; consult the linked header.
ownerDataHandleNot documented; consult the linked header.
targetsconst DataHandle *Not documented; consult the linked header.
sceneuint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "timeline_runtime.hpp"

// Assume these named values have been initialized with valid data:
// const Asset & asset
// DataHandle owner
// const DataHandle * targets
// uint32_t scene

epok::timeline::Director& object = /* obtain a valid instance */;

auto result = object.play(asset, owner, targets, scene);

Trade-offs and warnings

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

Declared in runtime/timeline_runtime.hpp:215

Related members