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

#include <NavLinkDefinition.h>

+ Inheritance diagram for FNavigationLinkBase:

Public Member Functions

ENGINE_API FNavigationLinkBase ()
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS FNavigationLinkBase (const FNavigationLinkBase &)=default
 
 FNavigationLinkBase (FNavigationLinkBase &&Other)=default
 
FNavigationLinkBaseoperator= (const FNavigationLinkBase &Other)=default
 
FNavigationLinkBaseoperator= (FNavigationLinkBase &&Other)=default
 
ENGINE_API PRAGMA_ENABLE_DEPRECATION_WARNINGS void InitializeAreaClass (const bool bForceRefresh=false)
 
ENGINE_API void SetAreaClass (UClass *InAreaClass)
 
ENGINE_API UClassGetAreaClass () const
 
ENGINE_API bool HasMetaArea () const
 

Public Attributes

float LeftProjectHeight
 
float MaxFallDownLength
 
uint32 UserId
 
FNavLinkId NavLinkId
 
float SnapRadius
 
float SnapHeight
 
FNavAgentSelector SupportedAgents
 
uint32 bSupportsAgent0: 1
 
uint32 bSupportsAgent1: 1
 
uint32 bSupportsAgent2: 1
 
uint32 bSupportsAgent3: 1
 
uint32 bSupportsAgent4: 1
 
uint32 bSupportsAgent5: 1
 
uint32 bSupportsAgent6: 1
 
uint32 bSupportsAgent7: 1
 
uint32 bSupportsAgent8: 1
 
uint32 bSupportsAgent9: 1
 
uint32 bSupportsAgent10: 1
 
uint32 bSupportsAgent11: 1
 
uint32 bSupportsAgent12: 1
 
uint32 bSupportsAgent13: 1
 
uint32 bSupportsAgent14: 1
 
uint32 bSupportsAgent15: 1
 
TEnumAsByte< ENavLinkDirection::TypeDirection
 
uint8 bUseSnapHeight: 1
 
uint8 bSnapToCheapestArea: 1
 
uint8 bCustomFlag0: 1
 
uint8 bCustomFlag1: 1
 
uint8 bCustomFlag2: 1
 
uint8 bCustomFlag3: 1
 
uint8 bCustomFlag4: 1
 
uint8 bCustomFlag5: 1
 
uint8 bCustomFlag6: 1
 
uint8 bCustomFlag7: 1
 
uint8 bIsGenerated: 1
 

Static Public Attributes

static constexpr uint32 InvalidUserId = 0
 

Constructor & Destructor Documentation

◆ FNavigationLinkBase() [1/3]

FNavigationLinkBase::FNavigationLinkBase ( )

◆ FNavigationLinkBase() [2/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FNavigationLinkBase::FNavigationLinkBase ( const FNavigationLinkBase )
default

◆ FNavigationLinkBase() [3/3]

FNavigationLinkBase::FNavigationLinkBase ( FNavigationLinkBase &&  Other)
default

Member Function Documentation

◆ GetAreaClass()

UClass * FNavigationLinkBase::GetAreaClass ( ) const

◆ HasMetaArea()

bool FNavigationLinkBase::HasMetaArea ( ) const

◆ InitializeAreaClass()

void FNavigationLinkBase::InitializeAreaClass ( const bool  bForceRefresh = false)

◆ operator=() [1/2]

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

◆ operator=() [2/2]

FNavigationLinkBase & FNavigationLinkBase::operator= ( FNavigationLinkBase &&  Other)
default

◆ SetAreaClass()

void FNavigationLinkBase::SetAreaClass ( UClass InAreaClass)

Member Data Documentation

◆ bCustomFlag0

uint8 FNavigationLinkBase::bCustomFlag0

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag1

uint8 FNavigationLinkBase::bCustomFlag1

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag2

uint8 FNavigationLinkBase::bCustomFlag2

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag3

uint8 FNavigationLinkBase::bCustomFlag3

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag4

uint8 FNavigationLinkBase::bCustomFlag4

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag5

uint8 FNavigationLinkBase::bCustomFlag5

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag6

uint8 FNavigationLinkBase::bCustomFlag6

custom flag, check DescribeCustomFlags for details

◆ bCustomFlag7

uint8 FNavigationLinkBase::bCustomFlag7

custom flag, check DescribeCustomFlags for details

◆ bIsGenerated

uint8 FNavigationLinkBase::bIsGenerated

Was this link generated by the navigation system

◆ bSnapToCheapestArea

uint8 FNavigationLinkBase::bSnapToCheapestArea

If set, link will try to snap to the cheapest area in given radius

◆ bSupportsAgent0

uint32 FNavigationLinkBase::bSupportsAgent0

◆ bSupportsAgent1

uint32 FNavigationLinkBase::bSupportsAgent1

◆ bSupportsAgent10

uint32 FNavigationLinkBase::bSupportsAgent10

◆ bSupportsAgent11

uint32 FNavigationLinkBase::bSupportsAgent11

◆ bSupportsAgent12

uint32 FNavigationLinkBase::bSupportsAgent12

◆ bSupportsAgent13

uint32 FNavigationLinkBase::bSupportsAgent13

◆ bSupportsAgent14

uint32 FNavigationLinkBase::bSupportsAgent14

◆ bSupportsAgent15

uint32 FNavigationLinkBase::bSupportsAgent15

◆ bSupportsAgent2

uint32 FNavigationLinkBase::bSupportsAgent2

◆ bSupportsAgent3

uint32 FNavigationLinkBase::bSupportsAgent3

◆ bSupportsAgent4

uint32 FNavigationLinkBase::bSupportsAgent4

◆ bSupportsAgent5

uint32 FNavigationLinkBase::bSupportsAgent5

◆ bSupportsAgent6

uint32 FNavigationLinkBase::bSupportsAgent6

◆ bSupportsAgent7

uint32 FNavigationLinkBase::bSupportsAgent7

◆ bSupportsAgent8

uint32 FNavigationLinkBase::bSupportsAgent8

◆ bSupportsAgent9

uint32 FNavigationLinkBase::bSupportsAgent9

◆ bUseSnapHeight

uint8 FNavigationLinkBase::bUseSnapHeight

◆ Direction

TEnumAsByte<ENavLinkDirection::Type> FNavigationLinkBase::Direction

◆ InvalidUserId

constexpr uint32 FNavigationLinkBase::InvalidUserId = 0
staticconstexpr

Needs to be 0 for recast data generator

◆ LeftProjectHeight

float FNavigationLinkBase::LeftProjectHeight

if greater than 0 nav system will attempt to project navlink's start point on geometry below

◆ MaxFallDownLength

float FNavigationLinkBase::MaxFallDownLength

if greater than 0 nav system will attempt to project navlink's end point on geometry below

◆ NavLinkId

FNavLinkId FNavigationLinkBase::NavLinkId

◆ SnapHeight

float FNavigationLinkBase::SnapHeight

◆ SnapRadius

float FNavigationLinkBase::SnapRadius

◆ SupportedAgents

FNavAgentSelector FNavigationLinkBase::SupportedAgents

restrict link only to specified agents

◆ UserId

uint32 FNavigationLinkBase::UserId

ID passed to navigation data generator


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