UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Public Attributes | List of all members
FNavLinkGenerationJumpConfig Struct Reference

#include <LinkGenerationConfig.h>

Public Member Functions

NAVIGATIONSYSTEM_API FNavLinkGenerationJumpConfig ()
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FNavLinkGenerationJumpConfig ()=default
 
 FNavLinkGenerationJumpConfig (const FNavLinkGenerationJumpConfig &)=default
 
 FNavLinkGenerationJumpConfig (FNavLinkGenerationJumpConfig &&)=default
 
FNavLinkGenerationJumpConfig & operator= (const FNavLinkGenerationJumpConfig &)=default
 
FNavLinkGenerationJumpConfig & operator= (FNavLinkGenerationJumpConfig &&)=default
 
bool Serialize (FArchive &Ar)
 

Public Attributes

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool bEnabled = true
 
FName Name
 
float JumpLength = 150.f
 
float JumpDistanceFromEdge = 10.f
 
float JumpMaxDepth = 150.f
 
float JumpHeight = 50.f
 
float JumpEndsHeightTolerance = 80.f
 
float SamplingSeparationFactor = 1.f
 
float FilterDistanceThreshold = 80.f
 
uint16 LinkBuilderFlags = (uint16)ENavLinkBuilderFlags::CreateCenterPointLink
 
TSubclassOf< UNavAreaBase > DownDirectionAreaClass
 
TSubclassOf< UNavAreaBase > UpDirectionAreaClass
 
TSubclassOf< UBaseGeneratedNavLinksProxy > LinkProxyClass
 
FNavLinkId LinkProxyId
 
TObjectPtr< UBaseGeneratedNavLinksProxy > LinkProxy = nullptr
 
bool bLinkProxyRegistered = false
 

Detailed Description

Experimental configuration to generate vertical links.

Constructor & Destructor Documentation

◆ FNavLinkGenerationJumpConfig() [1/3]

PRAGMA_ENABLE_DEPRECATION_WARNINGS PRAGMA_DISABLE_DEPRECATION_WARNINGS FNavLinkGenerationJumpConfig::FNavLinkGenerationJumpConfig ( )

◆ ~FNavLinkGenerationJumpConfig()

PRAGMA_DISABLE_DEPRECATION_WARNINGS FNavLinkGenerationJumpConfig::~FNavLinkGenerationJumpConfig ( )
default

◆ FNavLinkGenerationJumpConfig() [2/3]

FNavLinkGenerationJumpConfig::FNavLinkGenerationJumpConfig ( const FNavLinkGenerationJumpConfig &  )
default

◆ FNavLinkGenerationJumpConfig() [3/3]

FNavLinkGenerationJumpConfig::FNavLinkGenerationJumpConfig ( FNavLinkGenerationJumpConfig &&  )
default

Member Function Documentation

◆ operator=() [1/2]

FNavLinkGenerationJumpConfig & FNavLinkGenerationJumpConfig::operator= ( const FNavLinkGenerationJumpConfig &  )
default

◆ operator=() [2/2]

FNavLinkGenerationJumpConfig & FNavLinkGenerationJumpConfig::operator= ( FNavLinkGenerationJumpConfig &&  )
default

◆ Serialize()

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool FNavLinkGenerationJumpConfig::Serialize ( FArchive &  Ar)

Implemented for deprecated property cleanup purposes.

Member Data Documentation

◆ bEnabled

PRAGMA_ENABLE_DEPRECATION_WARNINGS bool FNavLinkGenerationJumpConfig::bEnabled = true

Should this config be used to generate links.

◆ bLinkProxyRegistered

bool FNavLinkGenerationJumpConfig::bLinkProxyRegistered = false

Is the link proxy registered to the navigation system CustomNavLinksMap. Registration occurs on PostRegisterAllComponents or on PostLoadPreRebuild if a new proxy was created.

◆ DownDirectionAreaClass

TSubclassOf<UNavAreaBase> FNavLinkGenerationJumpConfig::DownDirectionAreaClass

Area class for downward traversal of links generated by this configuration.

Note
If the value matches UpDirectionAreaClass, a single bidirectional link will be used to represent links generated by this configuration. If the value is null, no link will be generated in this direction

◆ FilterDistanceThreshold

float FNavLinkGenerationJumpConfig::FilterDistanceThreshold = 80.f

When filtering similar links, it's the distance used to compare between segment endpoints to match similar links. Use greater distance for more filtering (0 to deactivate filtering).

◆ JumpDistanceFromEdge

float FNavLinkGenerationJumpConfig::JumpDistanceFromEdge = 10.f

How far from the navmesh edge is the jump started.

◆ JumpEndsHeightTolerance

float FNavLinkGenerationJumpConfig::JumpEndsHeightTolerance = 80.f

Tolerance at both ends of the jump to find ground.

◆ JumpHeight

float FNavLinkGenerationJumpConfig::JumpHeight = 50.f

Peak height relative to the height of the starting point.

◆ JumpLength

float FNavLinkGenerationJumpConfig::JumpLength = 150.f

Horizontal length of the jump. How far from the starting point we will look for ground.

◆ JumpMaxDepth

float FNavLinkGenerationJumpConfig::JumpMaxDepth = 150.f

How far below the starting height we want to look for landing ground. A negative value can be used to generate a trajectory landing above the starting height (if negative, make sure to use a JumpHeight value big enough).

◆ LinkBuilderFlags

uint16 FNavLinkGenerationJumpConfig::LinkBuilderFlags = (uint16)ENavLinkBuilderFlags::CreateCenterPointLink

Flags used to indicate how links will be added.

◆ LinkProxy

TObjectPtr<UBaseGeneratedNavLinksProxy> FNavLinkGenerationJumpConfig::LinkProxy = nullptr

Current proxy. The proxy instance is build from the LinkProxyClass (provided it's not null). A proxy will be created if a

See also
LinkProxyClass is used.

◆ LinkProxyClass

TSubclassOf<UBaseGeneratedNavLinksProxy> FNavLinkGenerationJumpConfig::LinkProxyClass

Class used to handle links made with this configuration. Using this allows to implement custom behaviors when using navlinks, for example during the pathfollow. Note that having a proxy is not required for successful navlink pathfinding, but it does allow for custom behavior at the start and the end of a given navlink. This implies that using LinkProxyClass is optional, and it can remain empty (the default value).

See also
INavLinkCustomInterface
UGeneratedNavLinksProxy

◆ LinkProxyId

FNavLinkId FNavLinkGenerationJumpConfig::LinkProxyId

Identifier used identify the current proxy handler. All links generated through this config will use the same handler.

◆ Name

FName FNavLinkGenerationJumpConfig::Name

A name for this config

◆ SamplingSeparationFactor

float FNavLinkGenerationJumpConfig::SamplingSeparationFactor = 1.f

Value multiplied by CellSize to find the distance between sampling trajectories. Default is 1. Larger values improve generation speed but might introduce sampling errors.

◆ UpDirectionAreaClass

TSubclassOf<UNavAreaBase> FNavLinkGenerationJumpConfig::UpDirectionAreaClass

Area class for upward traversal of links generated by this configuration.

Note
If the value matches DownDirectionAreaClass, a single bidirectional link will be used to represent links generated by this configuration. If the value is null, no link will be generated in this direction
The documentation for this struct was generated from the following files: