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. |
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". |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.