UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Attributes | Friends | List of all members
FNavigationElementHandle Struct Reference

#include <NavigationElement.h>

Public Member Functions

 FNavigationElementHandle ()=default
 
 FNavigationElementHandle (const UObject *Object, const uint64 SubElementId=INDEX_NONE)
 
 FNavigationElementHandle (const TWeakObjectPtr< const UObject > &WeakObject, const uint64 SubElementId=INDEX_NONE)
 
bool operator== (const FNavigationElementHandle &Other) const
 
bool operator!= (const FNavigationElementHandle &Other) const
 
 operator bool () const
 
bool IsValid () const
 
void Invalidate ()
 

Static Public Attributes

static ENGINE_API const FNavigationElementHandle Invalid = FNavigationElementHandle(nullptr, INDEX_NONE)
 

Friends

uint32 GetTypeHash (const FNavigationElementHandle &Handle)
 
ENGINE_API friend FString LexToString (const FNavigationElementHandle &Handle)
 

Detailed Description

Structure used to identify a unique navigation element registered in the Navigation system. The handle can be created to represent two use cases:

  1. Single UObject representing the navigation element constructed from a UObject raw or weak pointer
  2. Single UObject managing multiple non-UObject navigation elements constructed from a UObject raw or weak pointer and using the optional constructor parameter to identity a unique sub-element
    See also
    FNavigationElement

Constructor & Destructor Documentation

◆ FNavigationElementHandle() [1/3]

FNavigationElementHandle::FNavigationElementHandle ( )
default

◆ FNavigationElementHandle() [2/3]

FNavigationElementHandle::FNavigationElementHandle ( const UObject *  Object,
const uint64  SubElementId = INDEX_NONE 
)
inlineexplicit

◆ FNavigationElementHandle() [3/3]

FNavigationElementHandle::FNavigationElementHandle ( const TWeakObjectPtr< const UObject > &  WeakObject,
const uint64  SubElementId = INDEX_NONE 
)
inlineexplicit

Member Function Documentation

◆ Invalidate()

void FNavigationElementHandle::Invalidate ( )
inline

Invalidates the current handle so further calls to IsValid will return false.

◆ IsValid()

bool FNavigationElementHandle::IsValid ( ) const
inline
Returns
true if the handle has been properly assigned.

◆ operator bool()

FNavigationElementHandle::operator bool ( ) const
inlineexplicit

Conversion operator used to convert the handle to a boolean based on its validity.

See also
IsValid

◆ operator!=()

bool FNavigationElementHandle::operator!= ( const FNavigationElementHandle &  Other) const
inline

◆ operator==()

bool FNavigationElementHandle::operator== ( const FNavigationElementHandle &  Other) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FNavigationElementHandle &  Handle)
friend

Hash function to use TSet/TMap

◆ LexToString

ENGINE_API friend FString LexToString ( const FNavigationElementHandle &  Handle)
friend

Stringifies FNavigationElementHandle

Member Data Documentation

◆ Invalid

const FNavigationElementHandle FNavigationElementHandle::Invalid = FNavigationElementHandle(nullptr, INDEX_NONE)
static
The documentation for this struct was generated from the following files: