Epok Engine

EPOK RUNTIME

Utility

utility.hpp · the utility module

Declarations are extracted from the pinned headers. Examples and general guidance are generated sketches, not verified complete programs; consult the linked source and guides for the actual contract.

Module

the utility module.

Header
utility.hpp
Include
#include "utility.hpp"
Stability
Epok runtime API

Include this module

C++ include
#include "utility.hpp"

Types

Functions and methods

addAdds add as part of the utility module.MethodaddAdds add as part of the utility module.MethodadvancePerforms `advance` as part of the utility module.Function templateadvanceWhole completed legs are counted by one division, so a long delta cannot spin here and an unbounded ping-pong keeps the correct leg parity.MethodalphaThe eased interpolation parameter.MethodcancelPerforms `cancel` as part of the utility module.MethodcancelPerforms `cancel` as part of the utility module.MethodclearClears clear as part of the utility module.MethodclearClears clear as part of the utility module.MethodclearClears clear as part of the utility module.Methodcompletion_pendingPerforms `completion pending` as part of the utility module.MethodcurrentPerforms `current` as part of the utility module.Methodcycles_remainingPerforms `cycles remaining` as part of the utility module.Methoddelay_valuePerforms `delay value` as part of the utility module.Methodduration_valuePerforms `duration value` as part of the utility module.MethodeaseQ12 easing.FunctioneaseThe easing catalogue on its own, for curves applied to something that is not a tween.Methodease_kindPerforms `ease kind` as part of the utility module.Methodelapsed_valuePerforms `elapsed value` as part of the utility module.MethodemitPerforms `emit` as part of the utility module.Methodend_valueEnds value as part of the utility module.Methodevent_queue_clearPerforms `event queue clear` as part of the utility module.Methodevent_queue_emitPerforms `event queue emit` as part of the utility module.Methodevent_queue_pollPerforms `event queue poll` as part of the utility module.Methodgameplay_eventPerforms `gameplay event` as part of the utility module.Functiongameplay_event_queuePerforms `gameplay event queue` as part of the utility module.Functiongameplay_focusPerforms `gameplay focus` as part of the utility module.Functiongameplay_tweenPerforms `gameplay tween` as part of the utility module.Functiongameplay_tween_statePerforms `gameplay tween state` as part of the utility module.FunctionlayoutPerforms `layout` as part of the utility module.Methodlayout_listList layout in native HUD pixels; anchoring remains the RectTransform system.FunctionlerpPerforms `lerp` as part of the utility module.Functionloop_modePerforms `loop mode` as part of the utility module.MethodmovePerforms `move` as part of the utility module.MethodmovePerforms `move` as part of the utility module.MethodnavigatePerforms `navigate` as part of the utility module.Function templatenavigatePerforms `navigate` as part of the utility module.MethodplayingStarts ing as part of the utility module.MethodplayingStarts ing as part of the utility module.MethodpollPolls poll as part of the utility module.MethodratioPerforms `ratio` as part of the utility module.MethodrestorePerforms `restore` as part of the utility module.MethodrestorePerforms `restore` as part of the utility module.Methodreversed_legPerforms `reversed leg` as part of the utility module.Methodschedule`wait` holds the first leg back without shortening it.MethodsizePerforms `size` as part of the utility module.MethodsizePerforms `size` as part of the utility module.MethodsnapshotPerforms `snapshot` as part of the utility module.MethodsnapshotPerforms `snapshot` as part of the utility module.MethodstartStarts start as part of the utility module.MethodstartStarts start as part of the utility module.Methodstart_valueStarts value as part of the utility module.Methodtake_completionPerforms `take completion` as part of the utility module.Methodtake_completionPerforms `take completion` as part of the utility module.Methodtween_advancePerforms `tween advance` as part of the utility module.Methodtween_cancelPerforms `tween cancel` as part of the utility module.Methodtween_scheduleThe full plan: `delay_seconds` holds the first leg back, `loop` and `legs` decide the replay, and `legs` 0 loops without end.Methodtween_startPerforms `tween start` as part of the utility module.Methodtween_valuePerforms `tween value` as part of the utility module.Methodutility_actor_dataPerforms `utility actor data` as part of the utility module.Functionutility_actor_idPerforms `utility actor id` as part of the utility module.FunctionvaluePerforms `value` as part of the utility module.Method

Fields, variables and values

acceptedExposes `accepted` on `epok::EventQueueMutation` for the utility module.FieldcompletedExposes `completed` on `epok::TweenAdvanceSample` for the utility module.Fieldcompletion_pendingExposes `completion_pending` on `epok::GameplayTweenState` for the utility module.FieldcountExposes `count` on `epok::FocusSnapshot` for the utility module.FieldcountExposes `count` on `epok::GameplayEventQueue4` for the utility module.FieldcurrentExposes `current` on `epok::FocusSnapshot` for the utility module.Fieldcycles_remainingExposes `cycles_remaining` on `epok::GameplayTweenState` for the utility module.FielddelayExposes `delay` on `epok::GameplayTweenState` for the utility module.FielddroppedExposes `dropped` on `epok::EventQueue` for the utility module.FielddroppedExposes `dropped` on `epok::GameplayEventQueue4` for the utility module.FielddurationExposes `duration` on `epok::GameplayTweenState` for the utility module.FielddurationExposes `duration` on `epok::SequenceStep` for the utility module.FieldeasingExposes `easing` on `epok::GameplayTweenState` for the utility module.FieldelapsedExposes `elapsed` on `epok::GameplayTweenState` for the utility module.FieldeventExposes `event` on `epok::EventQueuePoll` for the utility module.FieldeventExposes `event` on `epok::SequenceStep` for the utility module.FieldfromExposes `from` on `epok::GameplayTweenState` for the utility module.FieldInCircNamed value `InCirc` in `epok::Ease`.Enum valueInCubicNamed value `InCubic` in `epok::Ease`.Enum valueInOutCircNamed value `InOutCirc` in `epok::Ease`.Enum valueInOutCubicNamed value `InOutCubic` in `epok::Ease`.Enum valueInOutQuadNamed value `InOutQuad` in `epok::Ease`.Enum valueInOutQuartNamed value `InOutQuart` in `epok::Ease`.Enum valueInOutQuintNamed value `InOutQuint` in `epok::Ease`.Enum valueInQuadNamed value `InQuad` in `epok::Ease`.Enum valueInQuartNamed value `InQuart` in `epok::Ease`.Enum valueInQuintNamed value `InQuint` in `epok::Ease`.Enum valueitem0Exposes `item0` on `epok::GameplayEventQueue4` for the utility module.Fielditem1Exposes `item1` on `epok::GameplayEventQueue4` for the utility module.Fielditem2Exposes `item2` on `epok::GameplayEventQueue4` for the utility module.Fielditem3Exposes `item3` on `epok::GameplayEventQueue4` for the utility module.FieldkindExposes `kind` on `epok::GameplayEventSample` for the utility module.FieldkindExposes `kind` on `epok::QueueEvent` for the utility module.FieldLinearNamed value `Linear` in `epok::Ease`.Enum valueloopExposes `loop` on `epok::GameplayTweenState` for the utility module.FieldNoneNamed value `None` in `epok::TweenLoop`.Enum valueOutCircNamed value `OutCirc` in `epok::Ease`.Enum valueOutCubicNamed value `OutCubic` in `epok::Ease`.Enum valueOutQuadNamed value `OutQuad` in `epok::Ease`.Enum valueOutQuartNamed value `OutQuart` in `epok::Ease`.Enum valueOutQuintNamed value `OutQuint` in `epok::Ease`.Enum valuePingPongNamed value `PingPong` in `epok::TweenLoop`.Enum valueRestartNamed value `Restart` in `epok::TweenLoop`.Enum valuereversedExposes `reversed` on `epok::GameplayTweenState` for the utility module.FieldrunningExposes `running` on `epok::GameplayTweenState` for the utility module.FieldSmoothStepNamed value `SmoothStep` in `epok::Ease`.Enum valuesourceExposes `source` on `epok::GameplayEventSample` for the utility module.FieldsourceExposes `source` on `epok::QueueEvent` for the utility module.FieldstateExposes `state` on `epok::EventQueueMutation` for the utility module.FieldstateExposes `state` on `epok::EventQueuePoll` for the utility module.FieldstateExposes `state` on `epok::TweenAdvanceSample` for the utility module.FieldtoExposes `to` on `epok::GameplayTweenState` for the utility module.FieldvalidExposes `valid` on `epok::EventQueuePoll` for the utility module.FieldvalidExposes `valid` on `epok::FocusSnapshot` for the utility module.FieldvalueExposes `value` on `epok::GameplayEventSample` for the utility module.FieldvalueExposes `value` on `epok::QueueEvent` for the utility module.FieldvalueExposes `value` on `epok::TweenAdvanceSample` for the utility module.Field