Epok Engine

EPOK RUNTIME

epok::locomotion::choose

Function · 1 overload

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.

Function

Performs `choose` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.

Belongs to
epok::locomotion
Header
character_animation.hpp
Overloads
1

Declaration

Declaration
inline LocomotionState choose(LocomotionState state,bool grounded,Fixed vertical,Fixed speed,bool finished,bool jumped,const LocomotionTuning& tuning)

Performs `choose` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.

ParameterTypeMeaning
stateLocomotionStateNot documented; consult the linked header.
groundedboolNot documented; consult the linked header.
verticalFixedNot documented; consult the linked header.
speedFixedNot documented; consult the linked header.
finishedboolNot documented; consult the linked header.
jumpedboolNot documented; consult the linked header.
tuningconst LocomotionTuning &Not documented; consult the linked header.

Returns: LocomotionState. Consult the linked header for its meaning.

Example sketch

C++ example
#include "character_animation.hpp"

// Assume these named values have been initialized with valid data:
// LocomotionState state
// bool grounded
// Fixed vertical
// Fixed speed
// bool finished
// bool jumped
// const LocomotionTuning & tuning

auto result = epok::locomotion::choose(state, grounded, vertical, speed, finished, jumped, tuning);

Trade-offs and warnings

Consult the linked header for this operation’s ownership, lifetime and failure behavior.

Declared in runtime/character_animation.hpp:38

Related members