FAreaNavModifier

Area modifier: base

Windows
MacOS
Linux

Inheritance Hierarchy

FNavigationModifier

FAreaNavModifier

References

Module

Engine

Header

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

Include

#include "AI/NavigationModifier.h"

Syntax

struct FAreaNavModifier : public FNavigationModifier

Remarks

Area modifier: base

Variables

Name Description

Protected variable

TEnumAsByte< EN...

 

ApplyMode

Protected variable

TWeakObjectPtr<...

 

AreaClassOb

This should take a value of a game specific navigation modifier

Protected variable

uint8: 1

 

bIncludeAgentHeight

If set, area shape will be extended by agent's height to cover area underneath like regular colliding geometry

Protected variable

uint8: 1

 

bIsLowAreaModifier

Set when this modifier affects low spans in navmesh generation step

Protected variable

FBox

 

Bounds

Public variable

float

 

Cost

Transient value used for navigation modifiers sorting. If < 0 then not set

Public variable

float

 

FixedCost

Protected variable

TArray< FVector...

 

Points

Protected variable

TWeakObjectPtr<...

 

ReplaceAreaClassOb

Protected variable

TEnumAsByte< EN...

 

ShapeType

Constructors

Name Description

Public function

FAreaNavModifier()

Public function

FAreaNavModifier

(
    const UBrushComponent* BrushCo...,
    const TSubclassOf< UNavAreaBase > A...
)

Public function

FAreaNavModifier

(
    const FVector& Extent,
    const FTransform& LocalToWorld,
    const TSubclassOf< UNavAreaBase > A...
)

Public function

FAreaNavModifier

(
    const FBox& Box,
    const FTransform& LocalToWorld,
    const TSubclassOf< UNavAreaBase > A...
)

Public function

FAreaNavModifier

(
    float Radius,
    float Height,
    const FTransform& LocalToWorld,
    const TSubclassOf< UNavAreaBase > A...
)

Public function

FAreaNavModifier

(
    const TArray< FVector >& Points,
    ENavigationCoordSystem::Type CoordT...,
    const FTransform& LocalToWorld,
    const TSubclassOf< UNavAreaBase > A...
)

Public function

FAreaNavModifier

(
    const TArray< FVector >& Points,
    const int32 FirstIndex,
    const int32 LastIndex,
    ENavigationCoordSystem::Type CoordT...,
    const FTransform& LocalToWorld,
    const TSubclassOf< UNavAreaBase > A...
)

Public function

FAreaNavModifier

(
    const TNavStatArray< FVector >& Po...,
    const int32 FirstIndex,
    const int32 LastIndex,
    ENavigationCoordSystem::Type CoordT...,
    const FTransform& LocalToWorld,
    const TSubclassOf< UNavAreaBase > A...
)

Functions

Name Description

Public function Const

ENavigationA...

 

GetApplyMode()

Public function Const

const TSubcl...

 

GetAreaClass()

Public function Const

const TSubcl...

 

GetAreaClassToReplace()

Public function Const

const FBox &

 

GetBounds()

Public function Const

void

 

GetBox

(
    FBoxNavAreaData& Data
)

Public function Const

void

 

GetConvex

(
    FConvexNavAreaData& Data
)

Public function Const

void

 

GetCylinder

(
    FCylinderNavAreaData& Data
)

Public function Const

ENavigationS...

 

GetShapeType()

Protected function

void

 

Init

(
    const TSubclassOf< UNavAreaBase > I...
)

Public function Const

bool

 

IsLowAreaModifier()

Public function

void

 

SetApplyMode

(
    ENavigationAreaMode::Type InApplyMo...
)

Operation mode, ReplaceInLowPass will always automatically use UNavArea_LowHeight as ReplaceAreaClass!

Public function

void

 

SetAreaClass

(
    const TSubclassOf< UNavAreaBase > A...
)

Navigation area applied by this modifier

Public function

void

 

SetAreaClassToReplace

(
    const TSubclassOf< UNavAreaBase > A...
)

Additional class for used by some ApplyModes, setting it will automatically change ApplyMode to keep backwards compatibility!

Protected function

void

 

SetBox

(
    const FBox& Box,
    const FTransform& LocalToWorld
)

Protected function

void

 

SetConvex

(
    const FVector* InPoints,
    const int32 FirstIndex,
    const int32 LastIndex,
    ENavigationCoordSystem::Type CoordT...,
    const FTransform& LocalToWorld
)

Public function

FAreaNavModi...

 

SetIncludeAgentHeight

(
    bool bInclude
)

Public function Const

bool

 

ShouldIncludeAgentHeight()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback