Why use it
The asynchronous shape lets the frame loop continue while hardware or queued work completes.
EPOK RUNTIME
epok::UtilityVectorLibrary::vector_tween_schedule
Method · 1 overload
Method
Performs `vector tween schedule` as part of the gameplay api module.
Declaration
staticDeclaration
static GameplayVector3TweenState vector_tween_schedule(GameplayVector3 from,GameplayVector3 to,Fixed seconds,Ease easing,Fixed delay_seconds,TweenLoop loop,uint32_t legs)Performs `vector tween schedule` as part of the gameplay api module.
| Parameter | Type | Meaning |
|---|---|---|
from | GameplayVector3 | Value supplied for from. Keep referenced or pointed-to data valid for the complete call. |
to | GameplayVector3 | Value supplied for to. Keep referenced or pointed-to data valid for the complete call. |
seconds | Fixed | Value supplied for seconds. Keep referenced or pointed-to data valid for the complete call. |
easing | Ease | Value supplied for easing. Keep referenced or pointed-to data valid for the complete call. |
delay_seconds | Fixed | Value supplied for delay_seconds. Keep referenced or pointed-to data valid for the complete call. |
loop | TweenLoop | Value supplied for loop. Keep referenced or pointed-to data valid for the complete call. |
legs | uint32_t | Value supplied for legs. Keep referenced or pointed-to data valid for the complete call. |
Returns: GameplayVector3TweenState. Check the value before continuing when it represents success, availability or a resource handle.
Example
C++ example
#include "gameplay_api.hpp"
// Assume these named values have been initialized with valid data:
// GameplayVector3 from
// GameplayVector3 to
// Fixed seconds
// Ease easing
// Fixed delay_seconds
// TweenLoop loop
// uint32_t legs
auto result = epok::UtilityVectorLibrary::vector_tween_schedule(from, to, seconds, easing, delay_seconds, loop, legs);Trade-offs and warnings
Captured data and buffers must remain valid until the callback or task has completed.
Declared in runtime/gameplay_api.hpp:234
Related members
vector_tween_advancePerforms `vector tween advance` as part of the gameplay api module.Methodvector_tween_cancelPerforms `vector tween cancel` as part of the gameplay api module.Methodvector_tween_startPerforms `vector tween start` as part of the gameplay api module.Methodvector_tween_valuePerforms `vector tween value` as part of the gameplay api module.Method