Epok Engine

EPOK RUNTIME

epok::UtilityVectorLibrary::vector_tween_start

Method · 1 overload

Method

Performs `vector tween start` as part of the gameplay api module.

Belongs to
epok::UtilityVectorLibrary
Header
gameplay_api.hpp
Overloads
1

Declaration

static
Declaration
static GameplayVector3TweenState vector_tween_start(GameplayVector3 from,GameplayVector3 to,Fixed seconds,Ease easing)

Performs `vector tween start` as part of the gameplay api module.

ParameterTypeMeaning
fromGameplayVector3Value supplied for from. Keep referenced or pointed-to data valid for the complete call.
toGameplayVector3Value supplied for to. 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.
easingEaseValue supplied for easing. 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

auto result = epok::UtilityVectorLibrary::vector_tween_start(from, to, seconds, easing);

Why use it

It provides direct, allocation-conscious access to the gameplay api 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/gameplay_api.hpp:233

Related members