Epok Engine

EPOK RUNTIME

epok::CharacterMotor3DComponent

Class

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.

Class

Class declared by the character3d module for shared world-unit character commands, collision locomotion and motion samples.

Namespace
epok
Header
character3d.hpp
Include
#include "character3d.hpp"
Module
character3d
Source
runtime/character3d.hpp:98
Inherits from
ActorComponent

Basic usage

This generated sketch illustrates syntax for reaching the type; adapt it to the actual API contract. Open a member below for an operation-specific example.

C++ example
#include "character3d.hpp"

epok::CharacterMotor3DComponent& value = /* obtain a valid instance from your game */;

Fields and constants

air_responseExposes `air_response` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldautomatic_tickExposes `automatic_tick` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldcollision_maskExposes `collision_mask` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.FieldgravityExposes `gravity` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldground_responseExposes `ground_response` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldground_stickExposes `ground_stick` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldjump_speedExposes `jump_speed` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldmeasure_speedExposes `measure_speed` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldstatic_class_idExposes `static_class_id` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Variablestep_heightExposes `step_height` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Fieldtick_groupExposes `tick_group` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Variableturn_rateExposes `turn_rate` on `epok::CharacterMotor3DComponent` for shared world-unit character commands, collision locomotion and motion samples.Field

Public methods

begin_playBegins play as part of shared world-unit character commands, collision locomotion and motion samples.Methodclass_idPerforms `class id` as part of shared world-unit character commands, collision locomotion and motion samples.Methodclear_velocityClears velocity as part of shared world-unit character commands, collision locomotion and motion samples.Methodend_playEnds play as part of shared world-unit character commands, collision locomotion and motion samples.MethodmotionPerforms `motion` as part of shared world-unit character commands, collision locomotion and motion samples.Methodon_disablePerforms `on disable` as part of shared world-unit character commands, collision locomotion and motion samples.Methodreset_motionResets motion as part of shared world-unit character commands, collision locomotion and motion samples.Methodset_facingAssign project-controlled facing without applying a second turn policy.MethodsimulatePerforms `simulate` as part of shared world-unit character commands, collision locomotion and motion samples.Methodsimulate_sharedPerforms `simulate shared` as part of shared world-unit character commands, collision locomotion and motion samples.MethodstopStops stop as part of shared world-unit character commands, collision locomotion and motion samples.MethodsubmitPerforms `submit` as part of shared world-unit character commands, collision locomotion and motion samples.MethodtickPerforms `tick` as part of shared world-unit character commands, collision locomotion and motion samples.Method