EPOK RUNTIME

epok::UtilityLibrary::tween_start

Method · 1 overload

Method

Performs `tween start` as part of the utility module.

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

Declaration

static

Declaration

static GameplayTweenState tween_start(Fixed from,Fixed to,Fixed seconds,Ease easing)

Performs `tween start` as part of the utility module.

Parameter	Type	Meaning
`from`	`Fixed`	Value supplied for from. Keep referenced or pointed-to data valid for the complete call.
`to`	`Fixed`	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.

Returns: GameplayTweenState. Check the value before continuing when it represents success, availability or a resource handle.

Example

C++ example

#include "utility.hpp"

// Assume these named values have been initialized with valid data:
// Fixed from
// Fixed to
// Fixed seconds
// Ease easing

auto result = epok::UtilityLibrary::tween_start(from, to, seconds, easing);

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:174

Related members

easeThe easing catalogue on its own, for curves applied to something that is not a tween.Method event_queue_clearPerforms `event queue clear` as part of the utility module.Method event_queue_emitPerforms `event queue emit` as part of the utility module.Method event_queue_pollPerforms `event queue poll` as part of the utility module.Method tween_advancePerforms `tween advance` as part of the utility module.Method tween_cancelPerforms `tween cancel` as part of the utility module.Method tween_scheduleThe full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.Method tween_valuePerforms `tween value` as part of the utility module.Method