Navigation
API > API/Runtime > API/Runtime/Engine
Structure used to identify a unique navigation element registered in the Navigation system. The handle can be created to represent two use cases:
Single UObject representing the navigation element constructed from a UObject raw or weak pointer
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
| Name | FNavigationElementHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/Engine/Classes/AI/Navigation/NavigationElement.h |
| Include Path | #include "AI/Navigation/NavigationElement.h" |
Syntax
struct FNavigationElementHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| AI/Navigation/NavigationElement.h | |||
FNavigationElementHandle
(
const UObject* Object, |
Inlines (FNavigationElementHandle) | AI/Navigation/NavigationElement.h | |
FNavigationElementHandle
(
const TWeakObjectPtr< const UObject >& WeakObject, |
AI/Navigation/NavigationElement.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Invalid | const FNavigationElementHandle | AI/Navigation/NavigationElement.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OwnerUObject | TWeakObjectPtr< const UObject > | Main mandatory part of the handle to associate it with either a UObject with a 1:1 relation with the registered navigation element, or a UObject that manages multiple non-UObject navigation elements. | AI/Navigation/NavigationElement.h | |
| SubElementId | uint64 | Second optional part of the handle used when the associated UObject manages multiple navigation elements. | AI/Navigation/NavigationElement.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Invalidate() |
Invalidates the current handle so further calls to IsValid will return false. | AI/Navigation/NavigationElement.h | |
bool IsValid() |
AI/Navigation/NavigationElement.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator bool() |
Conversion operator used to convert the handle to a boolean based on its validity. | AI/Navigation/NavigationElement.h | |
bool operator!=
(
const FNavigationElementHandle& Other |
AI/Navigation/NavigationElement.h | ||
bool operator==
(
const FNavigationElementHandle& Other |
AI/Navigation/NavigationElement.h |