Epok Engine

EPOK RUNTIME

epok::Tween::restore

Method · 1 overload

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
aFixedValue supplied for a. Keep referenced or pointed-to data valid for the complete call.
bFixedValue supplied for b. Keep referenced or pointed-to data valid for the complete call.
secondsFixedValue supplied for seconds. Keep referenced or pointed-to data valid for the complete call.
progressFixedValue supplied for progress. Keep referenced or pointed-to data valid for the complete call.
modeEaseValue supplied for mode. Keep referenced or pointed-to data valid for the complete call.
activeboolValue supplied for active. Keep referenced or pointed-to data valid for the complete call.
completionboolValue supplied for completion. Keep referenced or pointed-to data valid for the complete call.
waitFixedValue supplied for wait. Keep referenced or pointed-to data valid for the complete call.
loopTweenLoopValue supplied for loop. Keep referenced or pointed-to data valid for the complete call.
legsuint32_tValue supplied for legs. Keep referenced or pointed-to data valid for the complete call.
reverseboolValue supplied for reverse. Keep referenced or pointed-to data valid for the complete call.

Returns: Nothing (void).

Example

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);

Why use it

It provides direct, allocation-conscious access to the utility module. 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/utility.hpp:97

Related members