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

#include <NavigationModifier.h>

+ Inheritance diagram for FCompositeNavModifier:

Public Member Functions

 FCompositeNavModifier ()
 
ENGINE_API void Shrink ()
 
ENGINE_API void Reset ()
 
ENGINE_API void Empty ()
 
bool IsEmpty () const
 
bool IsDynamic () const
 
void Add (const FAreaNavModifier &Area)
 
void Add (const FSimpleLinkNavModifier &Link)
 
void Add (const FCustomLinkNavModifier &Link)
 
void Add (const FCompositeNavModifier &Modifiers)
 
ENGINE_API void CreateAreaModifiers (const UPrimitiveComponent *PrimComp, const TSubclassOf< UNavAreaBase > AreaClass, const TSubclassOf< UNavAreaBase > AreaClassToReplace={})
 
ENGINE_API void CreateAreaModifiers (const FCollisionShape &CollisionShape, const FTransform &LocalToWorld, const TSubclassOf< UNavAreaBase > AreaClass, const bool bIncludeAgentHeight=false)
 
const TArray< FAreaNavModifier > & GetAreas () const
 
const TArray< FSimpleLinkNavModifier > & GetSimpleLinks () const
 
const TArray< FCustomLinkNavModifier > & GetCustomLinks () const
 
bool HasLinks () const
 
bool HasPotentialLinks () const
 
bool HasAgentHeightAdjust () const
 
bool HasAreas () const
 
bool HasLowAreaModifiers () const
 
bool IsPerInstanceModifier () const
 
bool GetFillCollisionUnderneathForNavmesh () const
 
void SetFillCollisionUnderneathForNavmesh (bool bValue)
 
bool GetMaskFillCollisionUnderneathForNavmesh () const
 
void SetMaskFillCollisionUnderneathForNavmesh (bool bValue)
 
bool GetRasterizeAsFilledConvexVolume () const
 
void SetRasterizeAsFilledConvexVolume (bool bValue)
 
ENavigationDataResolution GetNavMeshResolution () const
 
void SetNavMeshResolution (ENavigationDataResolution Resolution)
 
void ReserveForAdditionalAreas (int32 AdditionalElementsCount)
 
void MarkPotentialLinks ()
 
void MarkAsPerInstanceModifier ()
 
ENGINE_API FCompositeNavModifier GetInstantiatedMetaModifier (const FNavAgentProperties *NavAgent, const TWeakObjectPtr< const UObject > &WeakOwnerPtr) const
 
ENGINE_API FCompositeNavModifier GetInstantiatedMetaModifier (const FNavAgentProperties *NavAgent, TWeakObjectPtr< UObject > WeakOwnerPtr) const
 
ENGINE_API uint32 GetAllocatedSize () const
 
TArray< FAreaNavModifier > & GetMutableAreas ()
 
TArray< FSimpleLinkNavModifier > & GetSimpleLinks ()
 
TArray< FCustomLinkNavModifier > & GetCustomLinks ()
 
- Public Member Functions inherited from FNavigationModifier
 FNavigationModifier ()
 
bool HasMetaAreas () const
 

Public Attributes

FNavDataPerInstanceTransformDelegate NavDataPerInstanceTransformDelegate
 

Static Public Attributes

static ENGINE_API bool bEnableNavMeshResolutions = true
 

Additional Inherited Members

- Protected Attributes inherited from FNavigationModifier
int32 bHasMetaAreas: 1
 

Constructor & Destructor Documentation

◆ FCompositeNavModifier()

FCompositeNavModifier::FCompositeNavModifier ( )
inline

Member Function Documentation

◆ Add() [1/4]

void FCompositeNavModifier::Add ( const FAreaNavModifier Area)
inline

◆ Add() [2/4]

void FCompositeNavModifier::Add ( const FCompositeNavModifier Modifiers)
inline

◆ Add() [3/4]

void FCompositeNavModifier::Add ( const FCustomLinkNavModifier Link)
inline

◆ Add() [4/4]

void FCompositeNavModifier::Add ( const FSimpleLinkNavModifier Link)
inline

◆ CreateAreaModifiers() [1/2]

void FCompositeNavModifier::CreateAreaModifiers ( const FCollisionShape CollisionShape,
const FTransform LocalToWorld,
const TSubclassOf< UNavAreaBase AreaClass,
const bool  bIncludeAgentHeight = false 
)

◆ CreateAreaModifiers() [2/2]

void FCompositeNavModifier::CreateAreaModifiers ( const UPrimitiveComponent *  PrimComp,
const TSubclassOf< UNavAreaBase AreaClass,
const TSubclassOf< UNavAreaBase AreaClassToReplace = {} 
)

◆ Empty()

void FCompositeNavModifier::Empty ( )

◆ GetAllocatedSize()

uint32 FCompositeNavModifier::GetAllocatedSize ( ) const

◆ GetAreas()

const TArray< FAreaNavModifier > & FCompositeNavModifier::GetAreas ( ) const
inline

◆ GetCustomLinks() [1/2]

TArray< FCustomLinkNavModifier > & FCompositeNavModifier::GetCustomLinks ( )
inline

◆ GetCustomLinks() [2/2]

const TArray< FCustomLinkNavModifier > & FCompositeNavModifier::GetCustomLinks ( ) const
inline

◆ GetFillCollisionUnderneathForNavmesh()

bool FCompositeNavModifier::GetFillCollisionUnderneathForNavmesh ( ) const
inline

◆ GetInstantiatedMetaModifier() [1/2]

FCompositeNavModifier FCompositeNavModifier::GetInstantiatedMetaModifier ( const FNavAgentProperties NavAgent,
const TWeakObjectPtr< const UObject > &  WeakOwnerPtr 
) const

returns a copy of Modifier

◆ GetInstantiatedMetaModifier() [2/2]

FCompositeNavModifier FCompositeNavModifier::GetInstantiatedMetaModifier ( const FNavAgentProperties NavAgent,
TWeakObjectPtr< UObject WeakOwnerPtr 
) const

◆ GetMaskFillCollisionUnderneathForNavmesh()

bool FCompositeNavModifier::GetMaskFillCollisionUnderneathForNavmesh ( ) const
inline

◆ GetMutableAreas()

TArray< FAreaNavModifier > & FCompositeNavModifier::GetMutableAreas ( )
inline

◆ GetNavMeshResolution()

ENavigationDataResolution FCompositeNavModifier::GetNavMeshResolution ( ) const
inline

◆ GetRasterizeAsFilledConvexVolume()

bool FCompositeNavModifier::GetRasterizeAsFilledConvexVolume ( ) const
inline

◆ GetSimpleLinks() [1/2]

TArray< FSimpleLinkNavModifier > & FCompositeNavModifier::GetSimpleLinks ( )
inline

◆ GetSimpleLinks() [2/2]

const TArray< FSimpleLinkNavModifier > & FCompositeNavModifier::GetSimpleLinks ( ) const
inline

◆ HasAgentHeightAdjust()

bool FCompositeNavModifier::HasAgentHeightAdjust ( ) const
inline

◆ HasAreas()

bool FCompositeNavModifier::HasAreas ( ) const
inline

◆ HasLinks()

bool FCompositeNavModifier::HasLinks ( ) const
inline

◆ HasLowAreaModifiers()

bool FCompositeNavModifier::HasLowAreaModifiers ( ) const
inline

◆ HasPotentialLinks()

bool FCompositeNavModifier::HasPotentialLinks ( ) const
inline

◆ IsDynamic()

bool FCompositeNavModifier::IsDynamic ( ) const
inline

◆ IsEmpty()

bool FCompositeNavModifier::IsEmpty ( ) const
inline

◆ IsPerInstanceModifier()

bool FCompositeNavModifier::IsPerInstanceModifier ( ) const
inline

◆ MarkAsPerInstanceModifier()

void FCompositeNavModifier::MarkAsPerInstanceModifier ( )
inline

◆ MarkPotentialLinks()

void FCompositeNavModifier::MarkPotentialLinks ( )
inline

◆ ReserveForAdditionalAreas()

void FCompositeNavModifier::ReserveForAdditionalAreas ( int32  AdditionalElementsCount)
inline

◆ Reset()

void FCompositeNavModifier::Reset ( )

◆ SetFillCollisionUnderneathForNavmesh()

void FCompositeNavModifier::SetFillCollisionUnderneathForNavmesh ( bool  bValue)
inline

◆ SetMaskFillCollisionUnderneathForNavmesh()

void FCompositeNavModifier::SetMaskFillCollisionUnderneathForNavmesh ( bool  bValue)
inline

◆ SetNavMeshResolution()

void FCompositeNavModifier::SetNavMeshResolution ( ENavigationDataResolution  Resolution)
inline

◆ SetRasterizeAsFilledConvexVolume()

void FCompositeNavModifier::SetRasterizeAsFilledConvexVolume ( bool  bValue)
inline

◆ Shrink()

void FCompositeNavModifier::Shrink ( )

Member Data Documentation

◆ bEnableNavMeshResolutions

bool FCompositeNavModifier::bEnableNavMeshResolutions = true
static

◆ NavDataPerInstanceTransformDelegate

FNavDataPerInstanceTransformDelegate FCompositeNavModifier::NavDataPerInstanceTransformDelegate

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