ACharacter

class Engine Blueprint Since 1.0

Inherits: UObjectBase › UObjectBaseUtility › UObject › AActor › APawn › ACharacter

#include "GameFramework/Character.h"

Access: public Specifiers: UCLASS

Description

ACharacter extends APawn with a CapsuleComponent for collision, a SkeletalMeshComponent for visual representation, and a CharacterMovementComponent for walking, running, jumping, swimming, and flying. The most commonly used base class for player characters and NPCs.

Caveats & Gotchas

• The RootComponent of ACharacter is the CapsuleComponent. The mesh is a child of the capsule, typically positioned so the capsule feet sit at Z=0.
• Do not override the CapsuleComponent radius/height in blueprints without updating the mesh offset to match.
• CharacterMovementComponent uses network prediction. Understand the predicted/corrected movement model before customizing network movement.
• Jump is handled by CharacterMovementComponent. Call `Jump()` and `StopJumping()` rather than manipulating velocity directly.

Signature

class ACharacter : public APawn

Example

ACharacter constructor C++

AMyCharacter::AMyCharacter()
{
    // Capsule collision
    GetCapsuleComponent()->InitCapsuleSize(42.f, 96.f);

    // Character movement settings
    GetCharacterMovement()->MaxWalkSpeed = 600.f;
    GetCharacterMovement()->JumpZVelocity = 700.f;
    GetCharacterMovement()->AirControl = 0.35f;

    // Camera boom
    CameraBoom = CreateDefaultSubobject<USpringArmComponent>(TEXT("CameraBoom"));
    CameraBoom->SetupAttachment(GetRootComponent());
    CameraBoom->TargetArmLength = 400.f;
    CameraBoom->bUsePawnControlRotation = true;

    // Camera
    FollowCamera = CreateDefaultSubobject<UCameraComponent>(TEXT("FollowCamera"));
    FollowCamera->SetupAttachment(CameraBoom, USpringArmComponent::SocketName);
}

Functions (151)

Lifecycle 8 Transform 3 Components 6 Collision 3 Damage 1 Input 1 Networking 69 Navigation 2 Utility 7 Animation 6 Crouch 2 Jump 8 Movement 32 Root Motion 3

Lifecycle

8 ▼

Access	Type	Name	Description
public	function	ACharacter::BeginPlay	Called when the game starts or when the character is spawned into the world.
public	function	ACharacter::PawnClientRestart	Called on the owning client when the pawn is restarted, typically after possession or respawn.
public	function	ACharacter::PossessedBy	Called on the server when a controller takes possession of this Character.
public	function	ACharacter::PostInitializeComponents	Called after all components have been initialized.
public	function	ACharacter::Restart	Called by the Controller when the pawn is restarted after being possessed.
public	function	ACharacter::TurnOff	Disables the Character by stopping its movement, disabling tick, and turning off input.
public	function	ACharacter::UnPossessed	Called on the server when the controller releases possession of this Character.
public	function	ACharacter::ClearCrossLevelReferences	Called during level streaming to null out any references this Character holds to objects in other levels being unloaded.

Transform

3 ▼

Access	Type	Name	Description
public	function	ACharacter::GetBaseRotationOffset	Returns the cached rotation offset of the mesh from the capsule rotation as a quaternion.
public	function	ACharacter::GetBaseRotationOffsetRotator	Returns the cached mesh rotation offset from the capsule as an FRotator.
public	function	ACharacter::GetBaseTranslationOffset	Returns the cached translation offset of the mesh relative to the capsule center.

Components

6 ▼

Access	Type	Name	Description
public	function	ACharacter::GetCapsuleComponent	Returns the CapsuleComponent used for movement collision.
public	function	ACharacter::GetCharacterMovement	Returns the character's `UCharacterMovementComponent`.
public	function	ACharacter::GetMesh	Returns the character's skeletal mesh component (the Mesh subobject).
public	function	ACharacter::GetMovementComponent	Returns the movement component for this character as a UPawnMovementComponent pointer.
public	function	ACharacter::CacheInitialMeshOffset	Caches the mesh's offset from the capsule so network smoothing can use it as the interpolation target.
public	function	ACharacter::FindComponentByClass	Returns the first component of the given class attached to this character.

Collision

3 ▼

Access	Type	Name	Description
public	function	ACharacter::GetSimpleCollisionCylinder	Returns the radius and half-height of the character's capsule component, used as the simplified collision shape.
public	function	ACharacter::NotifyActorBeginOverlap	Called when another actor begins overlapping this character.
public	function	ACharacter::NotifyActorEndOverlap	Called when another actor stops overlapping this character.

Damage

1 ▼

Access	Type	Name	Description
public	function	ACharacter::ApplyDamageMomentum	Applies an impulse to the character's movement component based on the incoming damage event.

Input

1 ▼

Access	Type	Name	Description
public	function	ACharacter::SetupPlayerInputComponent	Called to bind input actions and axes to the character's input component.

Networking

69 ▼

Access	Type	Name	Description
public	function	ACharacter::CanUseRootMotionRepMove	Determines whether a buffered server root motion move is compatible with the current client montage state and can be used to teleport the client back to that position for correction.
public	function	ACharacter::ClientAckGoodMove deprecated	Sent by the server to the owning client to acknowledge that a specific move was accepted without correction.
public	function	ACharacter::ClientAckGoodMove_Implementation deprecated	Client-side body for ClientAckGoodMove.
public	function	ACharacter::ClientAdjustPosition deprecated	Deprecated client RPC sent by the server to correct the client's position and velocity after detecting client-side prediction error.
public	function	ACharacter::ClientAdjustPosition_Implementation deprecated	Client-side body of the deprecated ClientAdjustPosition RPC.
public	function	ACharacter::ClientAdjustRootMotionPosition deprecated	Client RPC that corrects a simulated proxy's position and montage track when the server detects desync during animation root-motion movement.
public	function	ACharacter::ClientAdjustRootMotionPosition_Implementation deprecated	The client-side implementation body for ClientAdjustRootMotionPosition, executed on the owning client after the RPC is dispatched.
public	function	ACharacter::ClientAdjustRootMotionSourcePosition deprecated	Client RPC that corrects position and root-motion-source state when the server detects desync during source-driven (non-montage) root motion movement.
public	function	ACharacter::ClientAdjustRootMotionSourcePosition_Implementation deprecated	Client-side implementation body for the deprecated ClientAdjustRootMotionSourcePosition RPC.
public	function	ACharacter::ClientMoveResponsePacked	Client RPC that delivers the server's response to a client move — either an acknowledgement or a position correction.
public	function	ACharacter::ClientMoveResponsePacked_Implementation	Client-side implementation body for the ClientMoveResponsePacked RPC.
public	function	ACharacter::ClientMoveResponsePacked_Validate	Validation function for the ClientMoveResponsePacked RPC.
public	function	ACharacter::ClientVeryShortAdjustPosition deprecated	Bandwidth-saving variant of ClientAdjustPosition that omits velocity, used when the server correction has zero velocity.
public	function	ACharacter::ClientVeryShortAdjustPosition_Implementation deprecated	Client-side body of the deprecated ClientVeryShortAdjustPosition RPC.
public	function	DEPRECATED_CHARACTER_MOVEMENT_RPC deprecated	Macro that annotates legacy character movement RPC functions (ServerMove, ServerMoveDual, ClientAdjustPosition, etc.
public	function	ACharacter::FindRootMotionRepMove	Searches RootMotionRepMoves backwards in time to find the most recent buffered server move that passes CanUseRootMotionRepMove().
public	function	ACharacter::GatherCurrentMovement	Fills the replicated movement struct (`ReplicatedMovement`) with the Character's current location, rotation, velocity, and base information before it is sent to clients.
public	function	ACharacter::GetLifetimeReplicatedProps	Registers which properties are replicated to remote machines and under what conditions.
public	function	ACharacter::GetProxyIsJumpForceApplied	Returns whether the replicated `bProxyIsJumpForceApplied` flag is currently set, indicating the Character is under active jump force on simulated proxies.
public	function	ACharacter::GetReplayLastTransformUpdateTimeStamp	Returns the timestamp of the most recent transform update that was replicated to the replay recording connection.
public	function	ACharacter::GetReplicatedBasedMovement	Returns the replicated based-movement info received from the server.
public	function	ACharacter::GetReplicatedCustomConditionState	Populates the per-property custom replication condition flags for this character.
public	function	ACharacter::GetReplicatedGravityDirection	Returns the custom gravity direction replicated to simulated proxies.
public	function	ACharacter::GetReplicatedMovementMode	Returns the packed movement mode replicated to simulated proxies.
public	function	ACharacter::GetReplicatedServerLastTransformUpdateTimeStamp	Returns the server's last transform update timestamp as replicated to simulated proxies.
public	function	ACharacter::GetRepRootMotion	Returns a const reference to the replicated root-motion montage struct.
public	function	ACharacter::GetRepRootMotion_Mutable	Returns a mutable reference to the replicated root-motion montage struct for in-place modification.
public	function	ACharacter::IsPlayingNetworkedRootMotionMontage	Returns true if the character is currently playing a root-motion montage with RootMotionMode set to RootMotionFromMontagesOnly, which enables the networked root-motion code path.
public	function	ACharacter::OnRep_IsCrouched	RepNotify called on simulated proxies when bIsCrouched changes.
public	function	ACharacter::OnRep_ReplayLastTransformUpdateTimeStamp	RepNotify called on replay connections when ReplayLastTransformUpdateTimeStamp is received.
public	function	ACharacter::OnRep_ReplicatedBasedMovement	RepNotify called on simulated proxies when ReplicatedBasedMovement is received from the server.
public	function	ACharacter::OnRep_ReplicatedMovement	Override of AActor::OnRep_ReplicatedMovement that additionally handles character-specific movement updates such as movement mode and based movement when the replicated transform is received.
public	function	ACharacter::OnRep_RootMotion	RepNotify called on simulated proxies when the RepRootMotion property is replicated from the server.
public	function	ACharacter::OnUpdateSimulatedPosition	Called on the client after a network position update is received and `CharacterMovement->SmoothCorrection()` has run.
public	function	ACharacter::PostNetReceive	Called on the client after all replicated properties have been applied for this network update.
public	function	ACharacter::PostNetReceiveLocationAndRotation	Called on simulated proxies after a replicated location and rotation update is received from the server.
public	function	ACharacter::PreNetReceive	Called on the client immediately before applying an incoming network update for this Character.
public	function	ACharacter::PreReplication	Called on the server (and for autonomous proxies during Client Replay recording) immediately before replication to give the actor a chance to update replicated properties or mark which ones have changed.
public	function	ACharacter::PreReplicationForReplay	Called for all actors when recording a Client Replay, including simulated proxies.
public	function	ACharacter::RestoreReplicatedMove	Applies a previously buffered server root motion move to the character, teleporting it back to the replicated position and restarting the montage from the saved state.
public	function	ACharacter::RootMotionDebugClientPrintOnScreen	Reliable Client RPC used by the root motion debugging system to display a message on the client's screen.
public	function	ACharacter::RootMotionDebugClientPrintOnScreen_Implementation	Implementation body for the RootMotionDebugClientPrintOnScreen RPC.
public	function	ACharacter::SaveRelativeBasedMovement	Stores a new relative location and rotation in the BasedMovement struct so the character can correctly follow a dynamic movement base between frames.
public	function	ACharacter::ServerMove deprecated	Deprecated server RPC that sends a single client movement update to the server.
public	function	ACharacter::ServerMove_Implementation deprecated	Server-side body of the deprecated ServerMove RPC.
public	function	ACharacter::ServerMove_Validate deprecated	Validation function for the deprecated ServerMove RPC.
public	function	ACharacter::ServerMoveDual deprecated	Deprecated server RPC that sends two consecutive client movement updates in a single packet to reduce per-move RPC overhead.
public	function	ACharacter::ServerMoveDual_Implementation deprecated	Server-side body of the deprecated ServerMoveDual RPC.
public	function	ACharacter::ServerMoveDual_Validate deprecated	Validation function for the deprecated ServerMoveDual RPC.
public	function	ACharacter::ServerMoveDualHybridRootMotion deprecated	Deprecated server RPC for a dual move where the first move uses normal movement and the second uses animation root motion.
public	function	ACharacter::ServerMoveDualHybridRootMotion_Implementation deprecated	Server-side body of the deprecated ServerMoveDualHybridRootMotion RPC.
public	function	ACharacter::ServerMoveDualHybridRootMotion_Validate deprecated	Validation function for the deprecated ServerMoveDualHybridRootMotion RPC.
public	function	ACharacter::ServerMoveDualNoBase deprecated	Dual-move variant of ServerMoveNoBase, batching two consecutive client moves into a single RPC when neither involves a movement base.
public	function	ACharacter::ServerMoveDualNoBase_Implementation deprecated	Server-side body for ServerMoveDualNoBase.
public	function	ACharacter::ServerMoveDualNoBase_Validate deprecated	Validation function for the ServerMoveDualNoBase RPC.
public	function	ACharacter::ServerMoveNoBase deprecated	Bandwidth-optimised variant of ServerMove sent by the client when the character has no movement base.
public	function	ACharacter::ServerMoveNoBase_Implementation deprecated	Server-side implementation body for ServerMoveNoBase.
public	function	ACharacter::ServerMoveNoBase_Validate deprecated	Validation function for the ServerMoveNoBase RPC.
public	function	ACharacter::ServerMoveOld deprecated	Resends an important old move to the server when the client suspects it was dropped.
public	function	ACharacter::ServerMoveOld_Implementation deprecated	Server-side body for ServerMoveOld.
public	function	ACharacter::ServerMoveOld_Validate deprecated	Validation function for the ServerMoveOld RPC.
public	function	ACharacter::ServerMovePacked	Server RPC that transmits packed client movement data from the owning client to the server.
public	function	ACharacter::ServerMovePacked_Implementation	Server-side implementation body for the ServerMovePacked RPC.
public	function	ACharacter::ServerMovePacked_Validate	Validation function for the ServerMovePacked RPC.
public	function	ACharacter::SetProxyIsJumpForceApplied	Sets the `bProxyIsJumpForceApplied` replicated flag and marks the property dirty for replication.
public	function	ACharacter::SetReplicateMovement	Enables or disables movement replication for this character.
public	function	ACharacter::SetRepRootMotion	Assigns the replicated root-motion montage struct and marks the property dirty so the change is sent to clients on the next replication pass.
public	function	ACharacter::ShouldNotifyLanded	Returns whether Landed() and related events should be broadcast for this landing.
public	function	ACharacter::TornOff	Called when this Character's actor channel is torn off — it transitions from server-replicated to locally simulated on the client.

Navigation

2 ▼

Access	Type	Name	Description
public	function	ACharacter::GetNavAgentLocation	Returns the world-space location used by the navigation system to represent this character's position.
public	function	ACharacter::UpdateNavigationRelevance	Notifies the navigation system whether this Character should be considered for dynamic obstacle/agent registration.

Utility

7 ▼

Access	Type	Name	Description
public	function	ACharacter::ClientCheatFly	Reliable Client RPC sent from the server to switch the character into fly movement mode as part of the cheat system.
public	function	ACharacter::ClientCheatFly_Implementation	Implementation body for the ClientCheatFly RPC.
public	function	ACharacter::ClientCheatGhost	Reliable Client RPC sent from the server to switch the character into ghost (noclip) movement mode as part of the cheat system.
public	function	ACharacter::ClientCheatGhost_Implementation	Implementation body for the ClientCheatGhost RPC.
public	function	ACharacter::ClientCheatWalk	Reliable Client RPC called from the server to force the character into walk movement mode as part of the cheat system.
public	function	ACharacter::ClientCheatWalk_Implementation	Implementation body for the ClientCheatWalk RPC.
public	function	ACharacter::DisplayDebug	Draws Character-specific debug information (movement state, jump state, based movement) to the HUD canvas when `showdebug` is active.

Animation

6 ▼

Access	Type	Name	Description
public	function	ACharacter::GetCurrentMontage	Returns the animation montage currently playing on the character's mesh, or nullptr if no montage is active.
public	function	ACharacter::PlayAnimMontage	Plays an animation montage on the character's mesh.
public	function	ACharacter::StopAnimMontage	Stops a playing animation montage on the character's mesh.
public	function	ACharacter::GetAnimRootMotionTranslationScale	Returns the current scale factor applied to animation root motion translation.
public	function	ACharacter::SetAnimRootMotionTranslationScale	Sets a runtime multiplier applied to all animation root motion translation for this character.
public	function	ACharacter::GetRootMotionAnimMontageInstance	Returns the FAnimMontageInstance currently driving root motion on this character's animation instance, or nullptr if no root-motion montage is active.

Crouch

2 ▼

Access	Type	Name	Description
public	function	ACharacter::CanCrouch	Returns true if the character is currently able to crouch and is not already crouching.
public	function	ACharacter::RecalculateCrouchedEyeHeight	Recomputes the camera/eye height offset for the crouched state from the CharacterMovementComponent settings.

Jump

8 ▼

Access	Type	Name	Description
public	function	ACharacter::IsJumpProvidingForce	Returns true while the jump key is held and the hold time has not yet exceeded JumpMaxHoldTime, meaning the jump is still actively applying upward force.
public	function	ACharacter::GetJumpMaxHoldTime	Returns the maximum duration the jump key can be held to continue receiving upward force.
public	function	ACharacter::NotifyJumpApex	Called by CharacterMovementComponent when the character reaches the peak of a jump.
public	function	ACharacter::OnJumped	Event fired when the character has just started a jump.
public	function	ACharacter::ResetJumpState	Marks the character as no longer attempting to jump, clearing jump-related state flags and timers.
public	function	ACharacter::CheckJumpInput	Called each frame by CharacterMovementComponent to process jump input.
public	function	ACharacter::ClearJumpInput	Called each frame after CheckJumpInput to update JumpKeyHoldTime and clear bPressedJump once the hold window expires.
public	function	ACharacter::OnJumped_Implementation	The C++ implementation body for the OnJumped BlueprintNativeEvent.

Movement

32 ▼

Access	Type	Name	Description
public	function	ACharacter::CanJump	Returns true if the Character is currently allowed to jump.
public	function	ACharacter::Crouch	Requests the character to start crouching.
public	function	ACharacter::IsCrouched	Returns true if the Character is currently crouched.
public	function	ACharacter::Jump	Tells the Character to jump on the next movement update by setting `bPressedJump` to true.
public	function	ACharacter::Landed	Called by CharacterMovementComponent when the character lands after being airborne.
public	function	ACharacter::LaunchCharacter	Applies an impulse to the character by setting a pending launch velocity that is processed on the next CharacterMovementComponent tick.
public	function	ACharacter::OnLanded	Blueprint-implementable event fired automatically by Landed() when the character touches down.
public	function	ACharacter::StopJumping	Clears the jump input flag (`bPressedJump`) and resets the hold timer so the Character stops receiving jump Z-velocity on the next movement update.
public	function	ACharacter::UnCrouch	Requests the character to stop crouching.
public	function	ACharacter::GetBasedMovement	Returns a read-only reference to the current `FBasedMovementInfo`, which describes the object the character is standing on, the bone they are attached to, and relative location/rotation.
public	function	ACharacter::GetDefaultHalfHeight	Returns the default (standing) half-height of the Character's CapsuleComponent.
public	function	ACharacter::GetGravityDirection	Returns the current world-space gravity direction vector for this character.
public	function	ACharacter::GetMovementBase	Returns the primitive component the character is currently standing on (its movement base).
public	function	ACharacter::K2_OnEndCrouch	Blueprint event fired when the character finishes crouching.
public	function	ACharacter::K2_OnMovementModeChanged	BlueprintImplementableEvent called when the movement mode changes, exposing both previous and new modes to Blueprint.
public	function	ACharacter::K2_OnStartCrouch	Blueprint event fired when the character begins crouching.
public	function	ACharacter::MoveBlockedBy	Called by CharacterMovementComponent when the character's movement is blocked by geometry.
public	function	ACharacter::OnEndCrouch	Called in C++ when the character finishes crouching.
public	function	ACharacter::OnLaunched	BlueprintImplementableEvent fired by LaunchCharacter immediately after the launch velocity is queued.
public	function	ACharacter::OnMovementModeChanged	Called by CharacterMovementComponent whenever the movement mode changes (e.
public	function	ACharacter::OnStartCrouch	Called in C++ when the character begins crouching.
public	function	ACharacter::OnWalkingOffLedge	Fired when the character is walking and the floor becomes unwalkable, just before falling begins.
public	function	ACharacter::OnWalkingOffLedge_Implementation	C++ override point for the BlueprintNativeEvent fired when the character is about to walk off a ledge because the floor became unwalkable.
public	function	ACharacter::RecalculateBaseEyeHeight	Updates `BaseEyeHeight` to account for the Character's current posture (standing or crouched).
public	function	ACharacter::ApplyAsyncOutput	Writes the results of an async Character Movement simulation back onto the character's authoritative game-thread state.
public	function	ACharacter::Falling	Called by CharacterMovementComponent when the character's movement mode transitions to Falling.
public	function	ACharacter::FillAsyncInput	Populates an FCharacterAsyncInput struct with the character's current state for handoff to the async Character Movement simulation.
public	function	ACharacter::GetGravityTransform	Returns a quaternion that rotates from world space into gravity-relative space, allowing movement and orientation calculations to be performed relative to the current gravity direction.
public	function	ACharacter::InitializeAsyncOutput	Sets default values on an FCharacterAsyncOutput struct before the async movement simulation runs.
public	function	ACharacter::K2_UpdateCustomMovement	BlueprintImplementableEvent called each frame while the character's movement mode is set to Custom.
public	function	ACharacter::SetBase	Sets the component the character is standing on, allowing CharacterMovementComponent to follow dynamic objects.
public	function	ACharacter::SetIsCrouched	Directly sets the `bIsCrouched` replicated flag and marks it dirty for replication.

Root Motion

3 ▼

Access	Type	Name	Description
public	function	ACharacter::HasAnyRootMotion	Returns true if root motion from any source — anim montage or FRootMotionSource — is currently active on the character.
public	function	ACharacter::IsPlayingRootMotion	Returns true if an AnimMontage with root motion mode RootMotionFromMontagesOnly is currently active.
public	function	ACharacter::SimulatedRootMotionPositionFixup	Corrects the position of simulated proxies playing root motion by blending toward the server-authoritative position.

Properties

Access	Type	Name	Description
public	property	ACharacter::ClientRootMotionParams	Stores root motion parameters for the locally-controlled autonomous proxy.
public	property	ACharacter::CrouchedEyeHeight	The eye height (in unscaled units from the bottom of the capsule) used when the character is crouched.
public	property	ACharacter::JumpCurrentCount	Tracks how many jumps the character has performed since last landing.
public	property	ACharacter::JumpCurrentCountPreJump	Stores the value of `JumpCurrentCount` captured at the start of `CheckJumpInput`, before that function potentially increments the counter.
public	property	ACharacter::JumpForceTimeRemaining	Amount of jump force time remaining in seconds, when `JumpMaxHoldTime` is greater than zero.
public	property	ACharacter::JumpKeyHoldTime	Tracks the total time in seconds that the jump key has been continuously held.
public	property	ACharacter::JumpMaxCount	The maximum number of jumps the character can perform before needing to land.
public	property	ACharacter::JumpMaxHoldTime	The maximum time in seconds the jump key can be held to continue receiving upward velocity.
public	property	ACharacter::LandedDelegate	Multicast delegate broadcast when the character lands after being in the Falling movement mode.
public	property	ACharacter::MovementModeChangedDelegate	Multicast delegate broadcast whenever the character's movement mode changes.
public	property	ACharacter::OnCharacterMovementUpdated	Delegate broadcast at the end of each CharacterMovementComponent movement update, providing DeltaSeconds, the initial location, and initial velocity for that tick.
public	property	ACharacter::OnReachedJumpApex	Multicast delegate broadcast when the character reaches the apex of a jump.
public	property	ACharacter::ProxyJumpForceStartedTime	Stores the world time at which a replicated jump force event started on a simulated proxy.
public	property	ACharacter::RepRootMotion	Replicated struct that carries root-motion montage state from the server to simulated proxies.
public	property	ACharacter::RootMotionRepMoves	Buffer of previously received replicated root motion moves from the server.
public	property	ACharacter::SavedRootMotion	Stores the root motion group that was active during the last PerformMovement() call on locally-controlled autonomous clients.

Events & Delegates

event OnLanded

Version History

Introduced in: 1.0

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?