UNavCollision

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

NavigationSystem

Header

/Engine/Source/Runtime/NavigationSystem/Public/NavCollision.h

Include

#include "NavCollision.h"

Syntax

class UNavCollision : public UNavCollisionBase

Variables

Name Description

Public variable

TSubclassOf< cl...

 

AreaClass

Navigation area type that will be use when this static mesh is used as a navigation obstacle.

Public variable

uint32: 1

 

bCreateOnClient

If false, will not create nav collision when connecting as a client

Public variable

uint32: 1

 

bForceGeometryRebuild

If set, convex geometry will be rebuild instead of using cooked data

Public variable

uint32: 1

 

bGatherConvexGeometry

If set, convex collisions will be exported offline for faster runtime navmesh building (increases memory usage)

Public variable

FGuid

 

BodySetupGuid

Guid of associated BodySetup

Public variable

TArray< FNavCol...

 

BoxCollision

List of nav collision boxes

Public variable

TNavStatArray< ...

 

ConvexShapeIndices

Public variable

FFormatContaine...

 

CookedFormatData

Cooked data for each format

Public variable

TArray< FNavCol...

 

CylinderCollision

List of nav collision cylinders

Constructors

Name Description

Public function

UNavCollision

(
    const FObjectInitializer& ObjectIn...
)

Functions

Name Description

Protected function

void

 

ClearCollision()

Public function

void

 

CopyUserSettings

(
    const UNavCollision& OtherData
)

Copy user settings from other nav collision data

Public function

void

 

GatherCollision()

Read collisions data

Protected function

FByteBulkDat...

 

GetCookedData

(
    FName Format
)

Public function Const

FGuid

 

GetGuid()

Protected function

void

 

InvalidatePhysicsData()

Overridden from UNavCollisionBase

Name Description

Public function Virtual

void

 

DrawSimpleGeom

(
    FPrimitiveDrawInterface* PDI,
    const FTransform& Transform,
    const FColor Color
)

Show cylinder and box collisions

Public function Virtual Const

bool

 

ExportGeometry

(
    const FTransform& LocalToWorld,
    FNavigableGeometryExport& GeoExpor...
)

Export collision data

Public function Virtual

void

 

GetNavigationModifier

(
    FCompositeNavModifier& Modifier,
    const FTransform& LocalToWorld
)

Get data for dynamic obstacle

Public function Virtual

void

 

InvalidateCollision()

Public function Virtual

void

 

Setup

(
    UBodySetup* BodySetup
)

Tries to read data from DDC, and if that fails gathers navigation collision data, stores it and uploads to DDC

Overridden from UObject

Name Description

Public function Virtual

void

 

GetResourceSizeEx

(
    FResourceSizeEx& CumulativeResourc...
)

Get the size of the object/resource for use in memory tools or to display to artists/LDs in the Editor This is the extended version which separates up the used memory into different memory regions (the actual definition of which may be platform specific).

Public function Virtual Const

bool

 

NeedsLoadForClient()

Called during saving to determine the load flags to save with the object.

Public function Virtual Const

bool

 

NeedsLoadForTargetPlatform

(
    const ITargetPlatform* TargetP...
)

Called during saving to determine the load flags to save with the object.

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.