USplineNavModifierComponent | Unreal Engine 5.7 Documentation

API > API/Runtime > API/Runtime/NavigationSystem

Used to assign a chosen NavArea to the nav mesh in the vicinity of a chosen spline. A tube is constructed around the spline and intersected with the nav mesh. Set its dimensions with StrokeWidth and StrokeHeight.


Name	USplineNavModifierComponent
Type	class
Header File	/Engine/Source/Runtime/NavigationSystem/Public/SplineNavModifierComponent.h
Include Path	#include "SplineNavModifierComponent.h"

Syntax

UCLASS (Blueprintable, MinimalAPI, Meta=(BlueprintSpawnableComponent),  
       HideCategories=(Variable, Tags, Cooking, Collision))  
class USplineNavModifierComponent : public UNavModifierComponent

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UNavRelevantComponent → UNavModifierComponent → USplineNavModifierComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
USplineNavModifierComponent ( const FObjectInitializer& ObjectInitializer )		SplineNavModifierComponent.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
AttachedSpline	FComponentReference	The SplineComponent which will modify the nav mesh; it must also be attached to this component's owner actor	SplineNavModifierComponent.h	EditAnywhere Category=Navigation Meta=(UseComponentPicker, AllowedClasses="/Script/Engine.SplineComponent", DisplayName="Nav Modifier Spline")
bUpdateNavDataOnSplineChange	bool	If true, any changes to Spline Components on this actor will cause this component to update the nav mesh.	SplineNavModifierComponent.h	EditAnywhere Category=Navigation
SplineTransform	FTransform	Used for bounds calculation and to check against attached spline's transform each tick for changes.	SplineNavModifierComponent.h
SplineVersion	uint32	Used to check against attached spline's version each tick for changes.	SplineNavModifierComponent.h
StrokeHeight	double	Cross-sectional height of the tube enclosing the spline	SplineNavModifierComponent.h	EditAnywhere Category=Navigation Meta=(UIMin="10", ClampMin="10")
StrokeWidth	double	Cross-sectional width of the tube enclosing the spline	SplineNavModifierComponent.h	EditAnywhere Category=Navigation Meta=(UIMin="10", ClampMin="10")
SubdivisionLOD	ESubdivisionLOD	Higher LOD will capture finer details in the spline	SplineNavModifierComponent.h	EditAnywhere Category=Navigation

Functions

Protected

Name	Remarks	Include Path	Unreal Specifiers
float GetSubdivisionThreshold()		SplineNavModifierComponent.h

Overridden from UNavModifierComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual void CalculateBounds()	Does the actual calculating and caching of the bounds when called by CalcAndCacheBounds.	SplineNavModifierComponent.h
virtual void GetNavigationData ( FNavigationRelevantData& Data ) const		SplineNavModifierComponent.h

Overridden from UActorComponent

Name	Remarks	Include Path	Unreal Specifiers
virtual bool IsComponentTickEnabled()		SplineNavModifierComponent.h
virtual void TickComponent ( float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction )		SplineNavModifierComponent.h