1. Epic GamesDeveloper
  3. UNavModifierComponent

UNavModifierComponent

API > API/Runtime > API/Runtime/NavigationSystem

Inheritance Hierarchy

References

   
Module NavigationSystem
Header /Engine/Source/Runtime/NavigationSystem/Public/NavModifierComponent.h
Include #include "NavModifierComponent.h"

Syntax

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TSubclassOf< UNavArea > AreaClass NavArea to apply inside the defined volume.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TSubclassOf< UNavArea > AreaClassToReplace 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.
Public variable UProperty Category, EditAnywhere Config uint8: 1 bIncludeAgentHeight Setting to 'true' will result in expanding lower bounding box of the nav modifier by agent's height, before applying to navmesh
Protected variable FTransform CachedTransform Cached in CalcAndCacheBounds and tested in GetNavigationData to see if cached data is still valid
Protected variable TArray< FRotatedBox > ComponentBounds  
Public variable UProperty Category, EditAnywhere FVector FailsafeExtent Box extent used ONLY when owning actor doesn't have collision component
Public variable UProperty Category, EditAnywhere, AdvancedDisplay ENavigationDataResolution NavMeshResolution Experimental: Indicates which navmesh resolution should be used around the actor.
Protected variable FDelegateHandle OnNavAreaRegisteredDelegateHandle  
Protected variable FDelegateHandle OnNavAreaUnregisteredDelegateHandle  
Protected variable FDelegateHandle TransformUpdateHandle  

Constructors

  Type Name Description
Public function  

UNavModifierComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual Const void Does the actual calculating and caching of the bounds when called by CalcAndCacheBounds.
Public function Virtual Const void

GetNavigationData ( FNavigationRelevantData& Data
)

  
Protected function void

OnNavAreaRegistered ( const UWorld& World,
const UClass* NavAreaClass
)

  
Protected function void

OnNavAreaUnregistered ( const UWorld& World,
const UClass* NavAreaClass
)

  
Protected function void

OnTransformUpdated ( USceneComponent* RootComponent,
EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

  
Protected function Const void

PopulateComponentBounds ( FTransform InParentTransform,
const UBodySetup& InBodySetup
)

  
Public function UFunction BlueprintCallable, Category void

SetAreaClass ( TSubclassOf< UNavArea > NewAreaClass
)

  
Public function UFunction BlueprintCallable, Category void

SetAreaClassToReplace ( TSubclassOf< UNavArea > NewAreaClassToReplace
)

  

Overridden from UNavRelevantComponent

  Type Name Description
Public function Virtual Const void @Note We might make this function non-virtual in the future in favor of child classes overriding CalculateBounds, see #jira UE-202451
Protected function Virtual void  
Protected function Virtual void  

Classes

  Type Name Description
Protected struct FRotatedBox    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page