UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FNavAgentProperties Struct Reference

#include <NavigationTypes.h>

+ Inheritance diagram for FNavAgentProperties:

Public Member Functions

 FNavAgentProperties (float Radius=-1.f, float Height=-1.f)
 
ENGINE_API FNavAgentProperties (const FNavAgentProperties &Other)
 
ENGINE_API FNavAgentPropertiesoperator= (const FNavAgentProperties &Other)
 
ENGINE_API void UpdateWithCollisionComponent (class UShapeComponent *CollisionComponent)
 
bool IsValid () const
 
bool HasStepHeightOverride () const
 
ENGINE_API bool IsNavDataMatching (const FNavAgentProperties &Other) const
 
bool IsEquivalent (const FNavAgentProperties &Other, float Precision=5.f) const
 
bool operator== (const FNavAgentProperties &Other) const
 
FVector GetExtent () const
 
ENGINE_API void SetPreferredNavData (TSubclassOf< AActor > NavDataClass)
 
- Public Member Functions inherited from FMovementProperties
 FMovementProperties ()
 

Public Attributes

float AgentRadius
 
float AgentHeight
 
float AgentStepHeight
 
float NavWalkingSearchHeightScale
 
FSoftClassPath PreferredNavData
 
- Public Attributes inherited from FMovementProperties
uint8 bCanCrouch:1
 
uint8 bCanJump:1
 
uint8 bCanWalk:1
 
uint8 bCanSwim:1
 
uint8 bCanFly:1
 

Static Public Attributes

static ENGINE_API const FNavAgentProperties DefaultProperties
 

Friends

uint32 GetTypeHash (const FNavAgentProperties &A)
 

Detailed Description

Properties of representation of an 'agent' (or Pawn) used by AI navigation/pathfinding.

Constructor & Destructor Documentation

◆ FNavAgentProperties() [1/2]

FNavAgentProperties::FNavAgentProperties ( float  Radius = -1.f,
float  Height = -1.f 
)
inline

◆ FNavAgentProperties() [2/2]

FNavAgentProperties::FNavAgentProperties ( const FNavAgentProperties Other)
default

Member Function Documentation

◆ GetExtent()

FVector FNavAgentProperties::GetExtent ( ) const
inline

◆ HasStepHeightOverride()

bool FNavAgentProperties::HasStepHeightOverride ( ) const
inline

◆ IsEquivalent()

bool FNavAgentProperties::IsEquivalent ( const FNavAgentProperties Other,
float  Precision = 5.f 
) const
inline

◆ IsNavDataMatching()

bool FNavAgentProperties::IsNavDataMatching ( const FNavAgentProperties Other) const

◆ IsValid()

bool FNavAgentProperties::IsValid ( ) const
inline

◆ operator=()

FNavAgentProperties & FNavAgentProperties::operator= ( const FNavAgentProperties Other)
default

◆ operator==()

bool FNavAgentProperties::operator== ( const FNavAgentProperties Other) const
inline

◆ SetPreferredNavData()

void FNavAgentProperties::SetPreferredNavData ( TSubclassOf< AActor NavDataClass)

◆ UpdateWithCollisionComponent()

void FNavAgentProperties::UpdateWithCollisionComponent ( class UShapeComponent CollisionComponent)

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FNavAgentProperties A)
friend

Member Data Documentation

◆ AgentHeight

float FNavAgentProperties::AgentHeight

Total height of the capsule used for navigation/pathfinding.

◆ AgentRadius

float FNavAgentProperties::AgentRadius

Radius of the capsule used for navigation/pathfinding.

◆ AgentStepHeight

float FNavAgentProperties::AgentStepHeight

Step height to use, or -1 for default value from navdata's config.

◆ DefaultProperties

const FNavAgentProperties FNavAgentProperties::DefaultProperties
static

◆ NavWalkingSearchHeightScale

float FNavAgentProperties::NavWalkingSearchHeightScale

Scale factor to apply to height of bounds when searching for navmesh to project to when nav walking

◆ PreferredNavData

FSoftClassPath FNavAgentProperties::PreferredNavData

Type of navigation data used by agent, null means "any"


The documentation for this struct was generated from the following files: