Epok Engine

EPOK RUNTIME

epok::Tween::restore

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

Performs `restore` as part of the utility module.

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

Declaration

Declaration
void restore(Fixed a,Fixed b,Fixed seconds,Fixed progress,Ease mode,bool active,bool completion,Fixed wait=0.0,TweenLoop loop=TweenLoop::None,uint32_t legs=1,bool reverse=false)

Performs `restore` as part of the utility module.

ParameterTypeMeaning
aFixedNot documented; consult the linked header.
bFixedNot documented; consult the linked header.
secondsFixedNot documented; consult the linked header.
progressFixedNot documented; consult the linked header.
modeEaseNot documented; consult the linked header.
activeboolNot documented; consult the linked header.
completionboolNot documented; consult the linked header.
waitFixedNot documented; consult the linked header.
loopTweenLoopNot documented; consult the linked header.
legsuint32_tNot documented; consult the linked header.
reverseboolNot documented; consult the linked header.

Returns: Nothing (void).

Example sketch

C++ example
#include "utility.hpp"

// Assume these named values have been initialized with valid data:
// Fixed a
// Fixed b
// Fixed seconds
// Fixed progress
// Ease mode
// bool active
// bool completion
// Fixed wait
// TweenLoop loop
// uint32_t legs
// bool reverse

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

object.restore(a, b, seconds, progress, mode, active, completion, wait, loop, legs, reverse);

Trade-offs and warnings

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

Declared in runtime/utility.hpp:97

Related members