1. Epic GamesDeveloper
  3. FAreaNavModifier

FAreaNavModifier

Area modifier: base

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/AI

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Public/AI/NavigationModifier.h
Include #include "AI/NavigationModifier.h"

Syntax

struct FAreaNavModifier : public FNavigationModifier

Remarks

Area modifier: base

Variables

  Type Name Description
Protected variable TEnumAsByte< ENavigationAreaMode::Type > ApplyMode  
Protected variable TWeakObjectPtr< UClass > AreaClassOb This should take a value of a game specific navigation modifier
Protected variable uint8: 1 bExpandTopByCellHeight If set, area shape will be extended at the top by one cell height
Protected variable uint8: 1 bIncludeAgentHeight If set, area shape will be extended by agent's height to cover area underneath like regular colliding geometry
Protected variable uint8: 1 bIsLowAreaModifier Set when this modifier affects low spans in navmesh generation step
Protected variable FBox Bounds  
Public variable float Cost Transient value used for navigation modifiers sorting. If < 0 then not set
Public variable float FixedCost  
Protected variable TArray< FVector > Points  
Protected variable TWeakObjectPtr< UClass > ReplaceAreaClassOb  
Protected variable TEnumAsByte< ENavigationShapeType::Type > ShapeType  

Constructors

  Type Name Description
Public function    
Public function  

FAreaNavModifier ( const UBrushComponent* BrushComponent,
const TSubclassOf< UNavAreaBase > AreaClass
)

 FAreaNavModifier constructor with a UBrushComponent* parameter has been deprecated since it wasn't able to handle concave shapes. Use FCompositeNavModifier::CreateAreaModifiers instead
Public function  

FAreaNavModifier ( const FVector& Extent,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function  

FAreaNavModifier ( const FBox& Box,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function  

FAreaNavModifier ( float Radius,
float Height,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function  

FAreaNavModifier ( const TArray< FVector >& Points,
ENavigationCoordSystem::Type CoordType,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function  

FAreaNavModifier ( const TArray< FVector >& Points,
const int32 FirstIndex,
const int32 LastIndex,
ENavigationCoordSystem::Type CoordType,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function  

FAreaNavModifier ( const TNavStatArray< FVector >& Points,
const int32 FirstIndex,
const int32 LastIndex,
ENavigationCoordSystem::Type CoordType,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  

Functions

  Type Name Description
Protected function Static void

FillConvexNavAreaData ( const FVector* InPoints,
const int32 InNumPoints,
const FTransform& InLocalToWorld,
FConvexNavAreaData& OutConvexData,
FBox& OutBounds
)

  
Public function Const ENavigationAreaMode::Type  
Public function Const const TSubclassOf< UNavAreaBase >  
Public function Const const TSubclassOf< UNavAreaBase >  
Public function Const const FBox &  
Public function Const void  
Public function Const void  
Public function Const void  
Public function Const void

GetPerInstanceConvex ( const FTransform& InLocalToWorld,
FConvexNavAreaData& OutData
)

  
Public function Const ENavigationShapeType::Type  
Protected function void

Init ( const TSubclassOf< UNavAreaBase > InAreaClass
)

  
Public function void

InitializeConvex ( const TNavStatArray< FVector >& Points,
const int32 FirstIndex,
const int32 LastIndex,
const FTransform& LocalToWorld,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function void

InitializePerInstanceConvex ( const TNavStatArray< FVector >& Points,
const int32 FirstIndex,
const int32 LastIndex,
const TSubclassOf< UNavAreaBase > AreaClass
)

  
Public function Const bool  
Public function void Operation mode, ReplaceInLowPass will always automatically use UNavArea_LowHeight as ReplaceAreaClass!
Public function void

SetAreaClass ( const TSubclassOf< UNavAreaBase > AreaClass
)

 Navigation area applied by this modifier
Public function void Additional class for used by some ApplyModes, setting it will automatically change ApplyMode to keep backwards compatibility!
Protected function void

SetBox ( const FBox& Box,
const FTransform& LocalToWorld
)

  
Protected function void

SetConvex ( const FVector* InPoints,
const int32 FirstIndex,
const int32 LastIndex,
ENavigationCoordSystem::Type CoordType,
const FTransform& LocalToWorld
)

  
Public function void

SetExpandTopByCellHeight ( bool bExpand
)

  
Public function FAreaNavModifier &

SetIncludeAgentHeight ( bool bInclude
)

  
Protected function void

SetPerInstanceConvex ( const FVector* InPoints,
const int32 InFirstIndex,
const int32 InLastIndex
)

  
Public function Const bool  
Public function Const bool  

Deprecated Functions

  Type Name Description
Public function  

FAreaNavModifier ( const UBrushComponent* BrushComponent,
const TSubclassOf< UNavAreaBase > AreaClass
)

 FAreaNavModifier constructor with a UBrushComponent* parameter has been deprecated since it wasn't able to handle concave shapes. Use FCompositeNavModifier::CreateAreaModifiers instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page