Epok Engine

EPOK RUNTIME

epok::timeline::play

Function · 1 overload

Function

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

Belongs to
epok::timeline
Header
timeline_service.hpp
Overloads
1

Declaration

Declaration
inline Handle play(DataHandle owner)

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

ParameterTypeMeaning
ownerDataHandleValue supplied for owner. Keep referenced or pointed-to data valid for the complete call.

Returns: Handle. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example
#include "timeline_service.hpp"

// Assume these named values have been initialized with valid data:
// DataHandle owner

auto result = epok::timeline::play(owner);

Why use it

It provides direct, allocation-conscious access to fixed-step simulation time and frame timing. No exception-based error path is implied by the signature.

Trade-offs and warnings

Call it only in the lifecycle phase described by the module. Validate indices, capacities and object state before use.

Declared in runtime/timeline_service.hpp:33

Related members