🔹Example Controller
This page explains the example character controller
Overview
Character Example Controller handles player movement and input actions, such as:
Crouch, Sprint and Jump
Look and leaning
Items equip, use and unequip
Climbing and vaulting
To function properly, it requires Character Controller and Player Input components:
Update Flow
When the game starts, the example controller will try to find CasProp components in the hierarchy — items like torch, axe or barrel — and equip the first found item. It supposses that items are added directly to the character (for example, parented to the right hand).
On Update(), it processes character speed, rotation and movement based on the input values.
This component receives messages from the Player Input to implement custom actions:
OnInteract() — tries to start an interaction.
OnSprint() — tries to start sprinting.
OnCrouch() — toggles current crouching state.
OnLook(InputValue value) — accumulates delta look values.
OnJump() — tries to jump.
OnMove(InputValue value) — updates player Vector2 input direction.
OnAim(InputValue value) — updates camera and active item aiming status.
OnTogglePerspective() — toggles first- and third-person views.
OnChangeShoulder() — toggles between right and left shoulder views.
OnLean(InputValue value) — updates current leaning angle.
Properties
Controller
Time Scale — active time scale value.
Mouse Sensitivity — look input sensitivity multiplier.
Standing
Standing movement properties.
Acceleration — how fast player should accelerate.
Deceleration — how fast player should decelerate.
Walk Speed — normal speed when walking.
Sprint Speed — normal speed when sprinting.
Crouching
Crouch Walk Speed — walking speed when crouched.
In Air
In air parameters.
Jump Height — how far should the character jump.
Fall Delay — time ungrounded before entering the in air state.
Gravity — how strong is the force pulling player back to the ground.
Max Fall Velocity — this will clamp max fall speed.
View
Perspective and rotation mode.
Is First Person — controls active perspective.
Orient Rotation To Movement — aligns rotation with the movement vector. This feature only in third-person mode.
Animation
Lean Angle — max leaning angle.
Steps
Procedural steps played to avoid feet sliding.
Steps Crouch/Uncrouch — played when player is crouching or uncrouching.
Step In Place — played when player is changing items.
Start/Stop Moving — played during movement transitions.
Smoothing
Animation smoothing based on the target velocity (acceleration, deceleration).
Animator Standing — applied when standing.
Animator Crouching — applied when crouching.
Last updated