EPOK RUNTIME

epok::gameplay_vector_tween

Function · 1 overload

Function

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

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

Declaration

inline GameplayVector3TweenState gameplay_vector_tween(GameplayVector3 from,GameplayVector3 to,Tween timing)

Performs `gameplay vector tween` 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.
`timing`	`Tween`	Value supplied for timing. 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
// Tween timing

auto result = epok::gameplay_vector_tween(from, to, timing);

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

Related members

aabb_may_touchPerforms `aabb may touch` as part of bounded AABB collision queries and movement.Function template aabb_overlapPerforms `aabb overlap` as part of bounded AABB collision queries and movement.Function template aabb2d_containsPerforms `aabb2d contains` as part of the world2d module.Function aabb2d_overlapPerforms `aabb2d overlap` as part of the world2d module.Function aabb2d_touchPerforms `aabb2d touch` as part of the world2d module.Function aabb2d_translatedPerforms `aabb2d translated` as part of the world2d module.Function activate_texture_bankPerforms `activate texture bank` as part of the epok module.Function active_cameraPerforms `active camera` as part of the epok module.Function actor_for_slotPerforms `actor for slot` as part of the actor tables module.Function allocate_actor_dataPerforms `allocate actor data` as part of the epok module.Function attach_componentSpatial attachment between components of the same domain.Function audio_initializePerforms `audio initialize` as part of SPU sound playback and voice ownership.Function