Epok Engine

EPOK RUNTIME

epok::timeline::Property::active

Method · 1 overload

Method

Performs `active` as part of fixed-step simulation time and frame timing.

Belongs to
epok::timeline::Property
Header
timeline_runtime.hpp
Overloads
1

Declaration

const
Declaration
bool active(int32_t tick,int32_t duration)const

Performs `active` as part of fixed-step simulation time and frame timing.

ParameterTypeMeaning
tickint32_tValue supplied for tick. Keep referenced or pointed-to data valid for the complete call.
durationint32_tValue supplied for duration. Keep referenced or pointed-to data valid for the complete call.

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

Example

C++ example
#include "timeline_runtime.hpp"

// Assume these named values have been initialized with valid data:
// int32_t tick
// int32_t duration

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

auto result = object.active(tick, duration);

Why use it

The method is `const`, so it does not mutate the object through this API surface. The boolean result makes success, availability or state explicit without exceptions.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. This is classified as **Engine internal**. Prefer a higher-level Epok service unless you need this exact control.

Declared in runtime/timeline_runtime.hpp:50

Related members