Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > GameFramework > UCharacterMovementComponent > UCharacterMovementComponent::Crouch

Light Theme

Dark Theme

UCharacterMovementComponent::Crouch

Checks if new capsule size fits (no encroachment), and call CharacterOwner->OnStartCrouch() if successful.

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/GameFramework/CharacterMovementComponent.h
Include	#include "GameFramework/CharacterMovementComponent.h"
Source	/Engine/Source/Runtime/Engine/Private/Components/CharacterMovementComponent.cpp

Syntax

virtual void Crouch
(
bool bClientSimulation
)

Remarks

Checks if new capsule size fits (no encroachment), and call CharacterOwner->OnStartCrouch() if successful. In general you should set bWantsToCrouch instead to have the crouch persist during movement, or just use the crouch functions on the owning Character.

Parameters

Parameter	Description
bClientSimulation	true when called when bIsCrouched is replicated to non owned clients, to update collision cylinder and offset.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss