Epok Engine

EPOK RUNTIME

epok::UtilityLibrary::tween_cancel

Method · 1 overload

Method

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

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

Declaration

static
Declaration
static GameplayTweenState tween_cancel(GameplayTweenState state)

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

ParameterTypeMeaning
stateGameplayTweenStateValue supplied for state. 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:
// GameplayTweenState state

auto result = epok::UtilityLibrary::tween_cancel(state);

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

Related members