Epok Engine

EPOK RUNTIME

epok::UtilityLibrary::tween_schedule

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

The full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.

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

Declaration

static
Declaration
static GameplayTweenState tween_schedule(Fixed from,Fixed to,Fixed seconds,Ease easing,Fixed delay_seconds,TweenLoop loop,uint32_t legs)

The full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.

ParameterTypeMeaning
fromFixedNot documented; consult the linked header.
toFixedNot documented; consult the linked header.
secondsFixedNot documented; consult the linked header.
easingEaseNot documented; consult the linked header.
delay_secondsFixedNot documented; consult the linked header.
loopTweenLoopNot documented; consult the linked header.
legsuint32_tNot documented; consult the linked header.

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

Example sketch

C++ example
#include "utility.hpp"

// Assume these named values have been initialized with valid data:
// Fixed from
// Fixed to
// Fixed seconds
// Ease easing
// Fixed delay_seconds
// TweenLoop loop
// uint32_t legs

auto result = epok::UtilityLibrary::tween_schedule(from, to, seconds, easing, delay_seconds, loop, legs);

Trade-offs and warnings

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

Declared in runtime/utility.hpp:181

Related members