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 > UNavMovementComponent

Light Theme

Dark Theme

UNavMovementComponent

NavMovementComponent defines base functionality for MovementComponents that move any 'agent' that may be involved in AI pathfinding.

Windows

MacOS

Linux

Inheritance Hierarchy

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/GameFramework/NavMovementComponent.h
Include	#include "GameFramework/NavMovementComponent.h"

Syntax

class UNavMovementComponent : public UMovementComponent

Remarks

NavMovementComponent defines base functionality for MovementComponents that move any 'agent' that may be involved in AI pathfinding.

Variables

	Name	Description
uint8: 1	bStopMovementAbortPaths	If set, StopActiveMovement call will abort current path following request
uint8: 1	bUpdateNavAgentWithOwnersCollision	If set to true NavAgentProps' radius and height will be updated with Owner's collision capsule size
uint8: 1	bUseAccelerationForPaths	If set, pathfollowing will control character movement via acceleration values.
uint8: 1	bUseFixedBrakingDistanceForPaths	If set, FixedPathBrakingDistance will be used for path following deceleration
float	FixedPathBrakingDistance	Braking distance override used with acceleration driven path following (bUseAccelerationForPaths)
FMovementProper...	MovementState	Expresses runtime state of character's movement.
FNavAgentProper...	NavAgentProps	Properties that define how the component can move.

Constructors

	Name	Description
	UNavMovementComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
bool	CanEverCrouch()	Returns true if component can crouch
bool	CanEverFly()	Returns true if component can fly
bool	CanEverJump()	Returns true if component can jump
bool	CanEverMoveOnGround()	Returns true if component can move along the ground (walk, drive, etc)
bool	CanEverSwim()	Returns true if component can swim
bool	CanStartPathFollowing()	Returns true if path following can start
bool	CanStopPathFollowing()	Check if current move target can be reached right now if positions are matching (e.g. performing scripted move and can't stop)
void	ClearFixedBrakingDistance()	Clears fixed braking distance
FVector	GetActorFeetLocation()	Returns location of controlled actor's "feet" meaning center of bottom of collision bounding box
FBasedPositi...	GetActorFeetLocationBased()	Returns based location of controlled actor
FVector	GetActorLocation()	Returns location of controlled actor - meaning center of collision bounding box
FVector	GetActorNavLocation()	Returns navigation location of controlled actor
FNavAgentPro...	GetNavAgentPropertiesRef()	Returns the NavAgentProps
const FNavAg...	GetNavAgentPropertiesRef()	Returns the NavAgentProps(const)
const IPathF...	GetPathFollowingAgent()
IPathFollowi...	GetPathFollowingAgent()
float	GetPathFollowingBrakingDistance ( float MaxSpeed )	Returns braking distance for acceleration driven path following
bool	IsCrouching()	Returns true if currently crouching
bool	IsFalling()	Returns true if currently falling (not flying, in a non-fluid volume, and not on the ground)
bool	IsFlying()	Returns true if currently flying (moving through a non-fluid volume without resting on the ground)
bool	IsJumpAllowed()	Returns true if component is allowed to jump
bool	IsMovingOnGround()	Returns true if currently moving on the ground (e.g. walking or driving)
bool	IsSwimming()	Returns true if currently swimming (moving through a fluid volume)
void	RequestDirectMove ( const FVector& MoveVelocity, bool bForceMaxSpeed )	Path following: request new velocity
void	RequestPathMove ( const FVector& MoveInput )	Path following: request new move input (normal vector = full strength)
void	ResetMoveState()	Resets runtime movement state to character's movement capabilities
void	SetFixedBrakingDistance ( float DistanceToEndOfPath )	Set fixed braking distance
void	SetJumpAllowed ( bool bAllowed )	Sets whether this component is allowed to jump
void	SetPathFollowingAgent ( IPathFollowingAgentInterface* ... )
void	SetUpdateNavAgentWithOwnersCollisions ( bool bUpdateWithOwner )
bool	ShouldUpdateNavAgentWithOwnersCollision()
void	StopActiveMovement()	Stops applying further movement (usually zeros acceleration).
void	StopMovementKeepPathing()	Stops movement immediately (reset velocity) but keeps following current path
void	UpdateNavAgent ( const AActor& InOwner )
void	UpdateNavAgent ( const UCapsuleComponent& CapsuleCo... )
bool	UseAccelerationForPathFollowing()

Overridden from UMovementComponent

		Name	Description
	void	StopMovementImmediately()	Overridden to also call StopActiveMovement().

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

Take our survey

Dismiss