UNavArea

Class containing definition of a navigation area

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

NavigationSystem

Header

/Engine/Source/Runtime/NavigationSystem/Public/NavAreas/NavArea.h

Include

#include "NavAreas/NavArea.h"

Syntax

class UNavArea : public UNavAreaBase

Remarks

Class containing definition of a navigation area

Variables

Name Description

Public variable

union UNavArea:...

 

@4876

DEPRECATED AGENT CONFIG.

Protected variable

uint16

 

AreaFlags

These flags will be applied to navigation data along with AreaID

Public variable

uint32: 1

 

bSupportsAgent0

Public variable

uint32: 1

 

bSupportsAgent1

Public variable

uint32: 1

 

bSupportsAgent10

Public variable

uint32: 1

 

bSupportsAgent11

Public variable

uint32: 1

 

bSupportsAgent12

Public variable

uint32: 1

 

bSupportsAgent13

Public variable

uint32: 1

 

bSupportsAgent14

Public variable

uint32: 1

 

bSupportsAgent15

Public variable

uint32: 1

 

bSupportsAgent2

Public variable

uint32: 1

 

bSupportsAgent3

Public variable

uint32: 1

 

bSupportsAgent4

Public variable

uint32: 1

 

bSupportsAgent5

Public variable

uint32: 1

 

bSupportsAgent6

Public variable

uint32: 1

 

bSupportsAgent7

Public variable

uint32: 1

 

bSupportsAgent8

Public variable

uint32: 1

 

bSupportsAgent9

Public variable

float

 

DefaultCost

Travel cost multiplier for path distance

Public variable

FColor

 

DrawColor

Area color in navigation view

Protected variable

float

 

FixedAreaEnteringCost

Entering cost

Public variable

FNavAgentSelect...

 

SupportedAgents

Restrict area only to specified agents

Public variable

uint32

 

SupportedAgentsBits

Constructors

Name Description

Public function

UNavArea

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Public function Virtual

void

 

CopyFrom

(
    TSubclassOf< UNavArea > AreaClass
)

Copy properties from other area

Public function Const

uint16

 

GetAreaFlags()

Public function Static

FColor

 

GetColor

(
    UClass* AreaDefinitionClass
)

Retrieved color declared for AreaDefinitionClass

Public function Virtual

float

 

GetFixedAreaEnteringCost()

Get the fixed area entering cost.

Public function Const

bool

 

HasFlags

(
    uint16 InFlags
)

Public function Virtual

void

 

InitializeArea()

Called before adding to navigation system

Public function Const

bool

 

IsSupportingAgent

(
    int32 AgentIndex
)

Protected function

void

 

RegisterArea()

Overridden from UObject

Name Description

Public function Virtual

void

 

FinishDestroy()

Called to finish destroying the object.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Public function Virtual

void

 

PostInitProperties()

Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

Serialize

(
    FArchive& Ar
)

Handles reading, writing, and reference collecting using FArchive.

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