Character Controller API reference

This page contains an overview of some key APIs of the Character Controller package.

Aspects	Description
KinematicCharacterAspect	The aspect containing all base character data, update steps, and utilities.

Interfaces	Description
IKinematicCharacterProcessor	Interface for implementing various customizable functions within the character update. Users are expected to create character aspects that implements this interface in order to create their own custom character implementation. The Standard Characters use this as well.

Authorings	Description
TrackedTransformAuthoring	Used to add a TrackedTransform component on entities that can be a character "parent".

Components	Description
KinematicCharacterProperties	Contains the character data that defines how it behaves. Nothing in the character update will write to this component; it only reads from it.
KinematicCharacterBody	Contains the character data that may get written to by the character update.
StoredKinematicCharacterData	Stores key character data before the character update (data that a character A might need to access on a character B). This allows deterministic parallel execution of the character update.
KinematicCharacterHit	DynamicBuffer containing all hits that were detected during the character update.
StatefulKinematicCharacterHit	DynamicBuffer containing all hits that were detected during the character update, but with state information (Enter/Exit/Stay).
KinematicCharacterDeferredImpulse	DynamicBuffer containing impulses added during the character update (to be processed later in a single-threaded system)
KinematicVelocityProjectionHit	DynamicBuffer containing only the hits that participate in velocity projection.
TrackedTransform	Tracks the previous & current transform of a root entity. This is used for entities that can be a character "parent".

Systems	Description
KinematicCharacterPhysicsUpdateGroup	Provides a sensible default update point for fixed-rate character physics update systems (used by Standard Characters).
KinematicCharacterDeferredImpulsesSystem	Handles applying impulses stored in the KinematicCharacterDeferredImpulse buffer, after the character update.
StoreKinematicCharacterBodyPropertiesSystem	Handles storing character data in the StoredKinematicCharacterData component. This allows deterministic parallel execution of the character update.
TrackedTransformFixedSimulationSystem	Handles storing "previous transform" data in all TrackedTransform components.
CharacterInterpolationRememberTransformSystem	Handles remembering the "previous transform" used for interpolation calculations.
CharacterInterpolationSystem	Handles interpolating the character visual transform.

Utilities	Description
KinematicCharacterUtilities	Contains various functions related to character queries, character entity creation, character baking, and others.
CharacterControlUtilities	Contains various functions related to controlling the character velocity & rotation.
MathUtilities	Contains various math helper functions.
PhysicsUtilities	Contains various physics helper functions.