dtNavLinkBuilderJumpConfig Struct Reference

#include <DetourNavLinkBuilderConfig.h>

Public Member Functions
NAVMESH_API void	init ()
	Initialize the configuration by computing cached values.

Public Attributes
bool	enabled = true
	Should this config be used to generate links.
float	jumpLength = 150.f
	Horizontal length of the jump. How far from the starting point we will look for ground. [Limit: > 0] [Units: wu].
float	jumpDistanceFromEdge = 10.f
	How far from the edge is the jump started. [Limit: > 0] [Units: wu].
float	jumpMaxDepth = 150.f
	How far below the starting height we want to look for landing ground. [Limit: > 0] [Units: wu].
float	jumpHeight = 50.f
	Peak height relative to the height of the starting point. [Limit: >= 0] [Units: wu].
float	jumpEndsHeightTolerance = 50.f
	Tolerance at both ends of the jump to find ground. [Limit: > 0] [Units: wu].
float	samplingSeparationFactor = 1.f
float	filterDistanceThreshold = 80.f
unsigned short	linkBuilderFlags = DT_NAVLINK_CREATE_CENTER_POINT_LINK
	Flags used to indicate how links will be added.
float	cachedParabolaConstant = 0
	Cached parabola constant fitting the configuration parameters.
float	cachedDownRatio = 0
	Cached value used when computing jump trajectory.
unsigned long long	linkUserId = 0
	User id used to handle links made from this configuration.
unsigned short	downDirPolyFlag = 0
	User defined flags assigned to downwards traversal of the off-mesh connections.
unsigned short	upDirPolyFlag = 0
	User defined flags assigned to upwards traversal of the off-mesh connections.
unsigned char	downDirArea = 0
	User defined area id assigned to downards traversal of the off-mesh connections.
unsigned char	upDirArea = 0
	User defined area id assigned to upwards traversal of the off-mesh connections.
uint8	ConfigIndex = INVALID_CONFIG_INDEX

Static Public Attributes
static constexpr uint8	INVALID_CONFIG_INDEX = 0xFF
	Unique index in TArray<dtNavLinkBuilderJumpConfig> identifying this config.

Detailed Description

Configuration for generated jump links.

Member Function Documentation

init()

void dtNavLinkBuilderJumpConfig::init

(

)

Initialize the configuration by computing cached values.

Member Data Documentation

cachedDownRatio

float dtNavLinkBuilderJumpConfig::cachedDownRatio = 0

Cached value used when computing jump trajectory.

cachedParabolaConstant

float dtNavLinkBuilderJumpConfig::cachedParabolaConstant = 0

Cached parabola constant fitting the configuration parameters.

ConfigIndex

uint8 dtNavLinkBuilderJumpConfig::ConfigIndex = INVALID_CONFIG_INDEX

downDirArea

unsigned char dtNavLinkBuilderJumpConfig::downDirArea = 0

User defined area id assigned to downards traversal of the off-mesh connections.

downDirPolyFlag

unsigned short dtNavLinkBuilderJumpConfig::downDirPolyFlag = 0

User defined flags assigned to downwards traversal of the off-mesh connections.

enabled

bool dtNavLinkBuilderJumpConfig::enabled = true

Should this config be used to generate links.

filterDistanceThreshold

float dtNavLinkBuilderJumpConfig::filterDistanceThreshold = 80.f

When filtering similar links, distance used to compare between segment endpoints to match similar links. Use greater distance for more filtering (0 to deactivate filtering). [Limit: > 0] [Units: wu]

INVALID_CONFIG_INDEX

constexpr uint8 dtNavLinkBuilderJumpConfig::INVALID_CONFIG_INDEX = 0xFF

staticconstexpr

Unique index in TArray<dtNavLinkBuilderJumpConfig> identifying this config.

jumpDistanceFromEdge

float dtNavLinkBuilderJumpConfig::jumpDistanceFromEdge = 10.f

How far from the edge is the jump started. [Limit: > 0] [Units: wu].

jumpEndsHeightTolerance

float dtNavLinkBuilderJumpConfig::jumpEndsHeightTolerance = 50.f

Tolerance at both ends of the jump to find ground. [Limit: > 0] [Units: wu].

jumpHeight

float dtNavLinkBuilderJumpConfig::jumpHeight = 50.f

Peak height relative to the height of the starting point. [Limit: >= 0] [Units: wu].

jumpLength

float dtNavLinkBuilderJumpConfig::jumpLength = 150.f

Horizontal length of the jump. How far from the starting point we will look for ground. [Limit: > 0] [Units: wu].

jumpMaxDepth

float dtNavLinkBuilderJumpConfig::jumpMaxDepth = 150.f

How far below the starting height we want to look for landing ground. [Limit: > 0] [Units: wu].

linkBuilderFlags

unsigned short dtNavLinkBuilderJumpConfig::linkBuilderFlags = DT_NAVLINK_CREATE_CENTER_POINT_LINK

Flags used to indicate how links will be added.

linkUserId

unsigned long long dtNavLinkBuilderJumpConfig::linkUserId = 0

User id used to handle links made from this configuration.

samplingSeparationFactor

float dtNavLinkBuilderJumpConfig::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. [Limit: >= 1]

upDirArea

unsigned char dtNavLinkBuilderJumpConfig::upDirArea = 0

User defined area id assigned to upwards traversal of the off-mesh connections.

upDirPolyFlag

unsigned short dtNavLinkBuilderJumpConfig::upDirPolyFlag = 0

User defined flags assigned to upwards traversal of the off-mesh connections.

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Navmesh/Public/Detour/DetourNavLinkBuilderConfig.h
• Engine/Source/Runtime/Navmesh/Private/Detour/DetourNavLinkBuilderConfig.cpp