EPOK RUNTIME
Character Animation
character_animation.hpp · configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples
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
configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.
Include this module
C++ include
#include "character_animation.hpp"Types
LocomotionClipsStruct declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.StructLocomotionSampleStruct declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.StructLocomotionSelectionStruct declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.StructLocomotionStateEnum declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.EnumLocomotionStatusEnum declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.EnumLocomotionTuningStruct declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.StructRuntimeStruct declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.StructSkeletalLocomotionComponentClass declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.ClassSpriteLocomotion2DComponentClass declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.ClassUpdateScopeStruct declared by the character-animation module for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.StructFunctions and methods
~UpdateScopeReleases the resources owned by `epok::locomotion::UpdateScope`.destructoralivePerforms `alive` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Functionanimation_appliedPerforms `animation applied` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodanimation_appliedPerforms `animation applied` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodappliedPerforms `applied` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodbegin_playBegins play as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodbegin_playBegins play as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodchoosePerforms `choose` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Functionclass_idPerforms `class id` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodclass_idPerforms `class id` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodcomponentPerforms `component` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Function templateend_playEnds play as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodend_playEnds play as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodfreshPerforms `fresh` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodmovingPerforms `moving` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Functionon_disablePerforms `on disable` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodon_disablePerforms `on disable` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodreportPerforms `report` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodresetResets reset as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodresetResets reset as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodresetResets reset as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodsamplePerforms `sample` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodsamplePerforms `sample` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodselect_animationPerforms `select animation` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodselect_animationPerforms `select animation` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodselectionPerforms `selection` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Functionset_enabledSets enabled as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Methodset_enabledSets enabled as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodtickPerforms `tick` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodtickPerforms `tick` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodupdateUpdates update as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodupdateUpdates update as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.MethodUpdateScopeConstructs `epok::locomotion::UpdateScope` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.constructorvalidPerforms `valid` as part of configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FunctionFields, variables and values
animate_airExposes `animate_air` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldAppliedNamed value `Applied` in `epok::LocomotionStatus`.Enum valueautomatic_tickExposes `automatic_tick` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldautomatic_tickExposes `automatic_tick` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldbankExposes `bank` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldBusyNamed value `Busy` in `epok::LocomotionStatus`.Enum valuechangedExposes `changed` on `epok::LocomotionSample` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldclipExposes `clip` on `epok::LocomotionSample` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldclipExposes `clip` on `epok::LocomotionSelection` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldclipsExposes `clips` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldclipsExposes `clips` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fielddistance_drivenExposes `distance_driven` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fielddistance_drivenExposes `distance_driven` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldenabledExposes `enabled` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldenabledExposes `enabled` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldface_motionExposes `face_motion` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldidleExposes `idle` on `epok::LocomotionClips` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldIdleNamed value `Idle` in `epok::LocomotionState`.Enum valueidle_speedExposes `idle_speed` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldInvalidConfigurationNamed value `InvalidConfiguration` in `epok::LocomotionStatus`.Enum valueInvalidMotorNamed value `InvalidMotor` in `epok::LocomotionStatus`.Enum valueInvalidOwnerNamed value `InvalidOwner` in `epok::LocomotionStatus`.Enum valueInvalidVisualNamed value `InvalidVisual` in `epok::LocomotionStatus`.Enum valuejump_downExposes `jump_down` on `epok::LocomotionClips` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldjump_upExposes `jump_up` on `epok::LocomotionClips` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldJumpDownNamed value `JumpDown` in `epok::LocomotionState`.Enum valueJumpUpNamed value `JumpUp` in `epok::LocomotionState`.Enum valuelandExposes `land` on `epok::LocomotionClips` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldLandNamed value `Land` in `epok::LocomotionState`.Enum valueloopingExposes `looping` on `epok::LocomotionSelection` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldmanualExposes `manual` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldmax_rateExposes `max_rate` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldmin_rateExposes `min_rate` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldMissingClipNamed value `MissingClip` in `epok::LocomotionStatus`.Enum valuemotorExposes `motor` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldmotorExposes `motor` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldmotorExposes `motor` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldNoStepNamed value `NoStep` in `epok::LocomotionStatus`.Enum valuephaseExposes `phase` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldrateExposes `rate` on `epok::LocomotionSample` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldrateExposes `rate` on `epok::LocomotionSelection` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldrunExposes `run` on `epok::LocomotionClips` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldRunNamed value `Run` in `epok::LocomotionState`.Enum valuerun_cycle_speedExposes `run_cycle_speed` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldrun_enterExposes `run_enter` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldrun_exitExposes `run_exit` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldsampleExposes `sample` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldstateExposes `state` on `epok::LocomotionSample` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldstateExposes `state` on `epok::LocomotionSelection` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldstatic_class_idExposes `static_class_id` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Variablestatic_class_idExposes `static_class_id` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.VariablestatusExposes `status` on `epok::LocomotionSample` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Fieldtick_groupExposes `tick_group` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Variabletick_groupExposes `tick_group` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.VariabletuningExposes `tuning` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldtuningExposes `tuning` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldupdatingExposes `updating` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldvalueExposes `value` on `epok::locomotion::UpdateScope` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldvisualExposes `visual` on `epok::locomotion::Runtime` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldvisualExposes `visual` on `epok::SkeletalLocomotionComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldvisualExposes `visual` on `epok::SpriteLocomotion2DComponent` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldwalkExposes `walk` on `epok::LocomotionClips` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.FieldWalkNamed value `Walk` in `epok::LocomotionState`.Enum valuewalk_cycle_speedExposes `walk_cycle_speed` on `epok::LocomotionTuning` for configurable skeletal and sprite locomotion drivers with extensible selection and shared motor samples.Field