FNavDataGenerator

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FNavDataGenerator

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Public/AI/NavDataGenerator.h

Include

#include "AI/NavDataGenerator.h"

Syntax

Destructors

Name Description

Public function Virtual

~FNavDataGenerator()

Functions

Name Description

Public function Virtual

void

 

CancelBuild()

Cancels build, may block until current running async tasks are finished

Public function Virtual

void

 

EnsureBuildCompletion()

Blocks until build is complete

Public function Virtual Const

void

 

ExportNavigationData

(
    const FString& FileName
)

Public function Virtual Const

int32

 

GetNumRemaningBuildTasks()

Returns number of remaining tasks till build is complete

Public function Virtual Const

int32

 

GetNumRunningBuildTasks()

Returns number of currently running tasks

Public function Virtual Const

bool

 

GetTimeSliceData

(
    int32& OutNumRemainingBuildTasks,
    double& OutCurrentBuildTaskDuratio...
)

Public function Virtual Const

void

 

GrabDebugSnapshot

(
    FVisualLogEntry* Snapshot,
    const FBox& BoundingBox,
    const FName& CategoryName,
    ELogVerbosity::Type Verbosity
)

Public function Virtual Const

bool

 

IsBuildInProgressCheckDirty()

Determines whether this generator is performing navigation building actions at the moment, dirty areas are also checked

Public function Virtual Const

uint32

 

LogMemUsed()

Debug

Public function Virtual

void

 

OnNavigationBoundsChanged()

Public function Virtual

bool

 

RebuildAll()

Rebuilds all known navigation data

Public function Virtual

void

 

RebuildDirtyAreas

(
    const TArray< FNavigationDirtyArea ...
)

Asks generator to update navigation affected by DirtyAreas

Public function Virtual

void

 

TickAsyncBuild

(
    float DeltaSeconds
)

Ticks navigation build If the generator is set to time sliced rebuild then this function will only get called when there is sufficient time (effectively roughly once in n frames where n is the number of time sliced nav data / generators currently building)

Deprecated Functions

Name Description

Public function Virtual Const

void

 

GrabDebugSnapshot

(
    FVisualLogEntry* Snapshot,
    const FBox& BoundingBox,
    const FLogCategoryBase& Category,
    ELogVerbosity::Type Verbosity
)

This version of GrabDebugSnapshot has been deprecated. Please use the other version of the function.

Public function Virtual Const

bool

 

IsBuildInProgress

(
    bool bCheckDirtyToo
)

This function is deprecated. Please use IsBuildInProgressCheckDirty

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss