EPOK RUNTIME

epok::Tween::schedule

Method · 1 overload

Method

`wait` holds the first leg back without shortening it.

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

Declaration

bool schedule(Fixed a,Fixed b,Fixed seconds,Ease mode,Fixed wait,TweenLoop loop,uint32_t legs)

`wait` holds the first leg back without shortening it.

Parameter	Type	Meaning
`a`	`Fixed`	Value supplied for a. Keep referenced or pointed-to data valid for the complete call.
`b`	`Fixed`	Value supplied for b. 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.
`mode`	`Ease`	Value supplied for mode. Keep referenced or pointed-to data valid for the complete call.
`wait`	`Fixed`	Value supplied for wait. 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: bool. 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 a
// Fixed b
// Fixed seconds
// Ease mode
// Fixed wait
// TweenLoop loop
// uint32_t legs

epok::Tween& object = /* obtain a valid instance */;

auto result = object.schedule(a, b, seconds, mode, wait, loop, legs);

Why use it

The boolean result makes success, availability or state explicit without exceptions. The asynchronous shape lets the frame loop continue while hardware or queued work completes.

Trade-offs and warnings

Check the return value; `false` is part of normal control flow for many PSX resource operations. Captured data and buffers must remain valid until the callback or task has completed.

Declared in runtime/utility.hpp:61

Related members