Epok Engine

EPOK RUNTIME

epok::Tween::cycles_remaining

Method · 1 overload

Method

Performs `cycles remaining` as part of the utility module.

Belongs to
epok::Tween
Header
utility.hpp
Overloads
1

Declaration

const
Declaration
uint32_t cycles_remaining()const

Performs `cycles remaining` as part of the utility module.

This overload takes no parameters.

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

Example

C++ example
#include "utility.hpp"

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

auto result = object.cycles_remaining();

Why use it

The method is `const`, so it does not mutate the object through this API surface.

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/utility.hpp:96

Related members

advanceWhole completed legs are counted by one division, so a long delta cannot spin here and an unbounded ping-pong keeps the correct leg parity.MethodalphaThe eased interpolation parameter.MethodcancelPerforms `cancel` as part of the utility module.Methodcompletion_pendingPerforms `completion pending` as part of the utility module.Methoddelay_valuePerforms `delay value` as part of the utility module.Methodduration_valuePerforms `duration value` as part of the utility module.Methodease_kindPerforms `ease kind` as part of the utility module.Methodelapsed_valuePerforms `elapsed value` as part of the utility module.Methodend_valueEnds value as part of the utility module.Methodloop_modePerforms `loop mode` as part of the utility module.MethodplayingStarts ing as part of the utility module.MethodratioPerforms `ratio` as part of the utility module.Method