UNavModifierComponent | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/NavigationSystem


Name	UNavModifierComponent
Type	class
Header File	/Engine/Source/Runtime/NavigationSystem/Public/NavModifierComponent.h
Include Path	#include "NavModifierComponent.h"

Syntax

UCLASS (ClassGroup=(Navigation), Meta=(BlueprintSpawnableComponent), HideCategories=(Activation),  
       Config=Engine, defaultconfig, MinimalAPI)  
class UNavModifierComponent : public UNavRelevantComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UNavRelevantComponent → UNavModifierComponent

Implements Interfaces

Derived Classes

USplineNavModifierComponent

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UNavModifierComponent ( const FObjectInitializer& ObjectInitializer )		NavModifierComponent.h

Structs

Name	Remarks
FRotatedBox

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AreaClass	TSubclassOf< UNavArea >	NavArea to apply inside the defined volume.	NavModifierComponent.h	EditAnywhere BlueprintReadOnly Category=Navigation
AreaClassToReplace	TSubclassOf< UNavArea >	When setting this value, the modifier behavior changes : it will now replace any surface marked by AreaClassToReplace in the volume and replace it with AreaClass.	NavModifierComponent.h	EditAnywhere BlueprintReadOnly Category=Navigation
bIncludeAgentHeight	uint8	Setting to 'true' will result in expanding lower bounding box of the nav modifier by agent's height, before applying to navmesh	NavModifierComponent.h	Config EditAnywhere Category=Navigation
FailsafeExtent	FVector	Box extent used ONLY when owning actor doesn't have collision component	NavModifierComponent.h	EditAnywhere Category=Navigation
NavMeshResolution	ENavigationDataResolution	Experimental: Indicates which navmesh resolution should be used around the actor.	NavModifierComponent.h	EditAnywhere Category=Navigation AdvancedDisplay

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
virtual void CalculateBounds()	Does the actual calculating and caching of the bounds when called by CalcAndCacheBounds.	NavModifierComponent.h
virtual void GetNavigationData ( FNavigationRelevantData& Data ) const		NavModifierComponent.h
void SetAreaClass ( TSubclassOf< UNavArea > NewAreaClass )		NavModifierComponent.h	BlueprintCallable Category="AI\|Navigation"
void SetAreaClassToReplace ( TSubclassOf< UNavArea > NewAreaClassToReplace )		NavModifierComponent.h	BlueprintCallable Category="AI\|Navigation"

Overridden from UNavRelevantComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual void CalcAndCacheBounds()	@Note We might make this function non-virtual in the future in favor of child classes overriding CalculateBounds, see #jira UE-202451	NavModifierComponent.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
void OnNavAreaRegistered ( const UWorld& World, const UClass* NavAreaClass )		NavModifierComponent.h
void OnNavAreaUnregistered ( const UWorld& World, const UClass* NavAreaClass )		NavModifierComponent.h
void OnTransformUpdated ( USceneComponent* RootComponent, EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport )		NavModifierComponent.h
void PopulateComponentBounds ( FTransform InParentTransform, const UBodySetup& InBodySetup ) const		NavModifierComponent.h

Overridden from UActorComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual void OnRegister()		NavModifierComponent.h
virtual void OnUnregister()		NavModifierComponent.h