Navigation
API > API/Runtime > API/Runtime/Engine
NavLink Id type. Legacy Ids were generated using the incremental ID system which has been deprecated but will be supported for quite some time. The new system uses CityHash using GenerateUniqueId() Only NavLinks generated this way should have the most significant bit of the id set to 1.
| Name | FNavLinkId |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/AI/Navigation/NavigationTypes.h |
| Include Path | #include "AI/Navigation/NavigationTypes.h" |
Syntax
USTRUCT ()
struct FNavLinkId
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNavLinkId () |
AI/Navigation/NavigationTypes.h | ||
FNavLinkId
(
uint64 InId |
AI/Navigation/NavigationTypes.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Invalid | const FNavLinkId | AI/Navigation/NavigationTypes.h | |
| InvalidLinkId | uint64 | AI/Navigation/NavigationTypes.h | |
| NavLinkIdBitMask | uint64 | AI/Navigation/NavigationTypes.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Id | uint64 | AI/Navigation/NavigationTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 GetId() |
AI/Navigation/NavigationTypes.h | ||
bool IsLegacyId () |
New non Legacy NavLinkIds have the most significant bit set to 1. | AI/Navigation/NavigationTypes.h | |
bool IsValid() |
AI/Navigation/NavigationTypes.h | ||
void SetId
(
uint64 InId |
AI/Navigation/NavigationTypes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FNavLinkId GenerateUniqueId () |
Helper function: returns unique ID number for custom links. | AI/Navigation/NavigationTypes.h | |
static FNavLinkId GenerateUniqueId
(
FNavLinkAuxiliaryId AuxiliaryId, |
Helper function: returns unique ID number for custom links. | AI/Navigation/NavigationTypes.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FNavLinkId& Other |
AI/Navigation/NavigationTypes.h | ||
bool operator==
(
const FNavLinkId& Other |
AI/Navigation/NavigationTypes.h |