1. Epic GamesDeveloper
  3. UPCGPathfindingSettings

UPCGPathfindingSettings

Finds the optimal path across the points of a given point cloudshould one existwhen provided a start and goal location, and a maximum jump distance between points.

API > API/Plugins > API/Plugins/PCG

Finds the optimal path across the points of a given point cloudshould one existwhen provided a start and goal location, and a maximum jump distance between points. Can return a partial path.

   
Name UPCGPathfindingSettings
Type class
Header File /Engine/Plugins/PCG/Source/PCG/Public/Elements/PCGPathfindingElement.h
Include Path #include "Elements/PCGPathfindingElement.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, ClassGroup=(Procedural), HideCategories="Data|Attributes")  
class UPCGPathfindingSettings : public UPCGSettings

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPCGPathfindingSettings()

   Elements/PCGPathfindingElement.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAcceptPartialPath bool Even if the path is not complete, return a viable partial path to the point closest to the goal. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(PCG_Overridable)
bCopyOriginatingPoints bool Copy the properties and attributes from the originating point input to the output points. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="!bOutputAsSpline", EditConditionHides, PCG_Overridable)
bGoalLocationsAsInput bool   Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
bOutputAsSpline bool The final path will be a spline. If false, the final path will be an ordered point data. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
bStartLocationsAsInput bool   Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
bUsePathTraces bool Controls whether raycasts will be used to test for collisions along the path (hit results will be considered obstacles for the pathfinding). Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(PCG_Overridable)
CostAttribute FPCGAttributePropertyInputSelector Attribute to use as part of the cost function - it's meaning will depend on the cost function mode (fitness value, scalar multiplier, or else). Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="CostFunctionMode != EPCGPathfindingCostFunctionMode::Distance", EditConditionHides, PCG_Overridable)
CostFunctionMode EPCGPathfindingCostFunctionMode Controls whether the cost function will use a given attribute as a scalar wrt to the distance. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(PCG_Overridable)
Goal FVector The location the pathfinding should attempt to reach. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="!bGoalLocationsAsInput", EditConditionHides, PCG_Overridable)
GoalLocationAttribute FPCGAttributePropertyInputSelector   Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="bGoalLocationsAsInput", EditConditionHides, PCG_Overridable)
GoalMappingMode EPCGPathfindingGoalMappingMode How each goal location correlates to each start location. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(PCG_Overridable)
HeuristicWeight double The heuristic estimates a faster path to speed up processing. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(ClampMin="0.0", PCG_Overridable)
MaximumFitnessPenaltyFactor double Fitness penalty scalar (maximum penalty applied when fitness is zero.) Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(ClampMin="1.0", EditCondition="CostFunctionMode == EPCGPathfindingCostFunctionMode::FitnessScore", EditConditionHides, PCG_Overridable)
PathTraceParams FPCGWorldRaycastQueryParams   Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="bUsePathTraces", EditConditionHides, PCG_Overridable, ShowOnlyInnerProperties)
SearchDistance double The max distance from each point to search for the next viable point in the path. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(ClampMin="0.01", PCG_Overridable)
SplineMode EPCGPathfindingSplineMode Determines how the output spline's curves will be calculated. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="bOutputAsSpline", EditConditionHides, PCG_Overridable)
Start FVector The location the pathfinding should attempt to reach. Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="!bStartLocationsAsInput", EditConditionHides, PCG_Overridable)
StartLocationAttribute FPCGAttributePropertyInputSelector   Elements/PCGPathfindingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=Settings
  • Meta=(EditCondition="bStartLocationsAsInput", EditConditionHides, PCG_Overridable)

Functions

Public

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FName GetDefaultNodeName()

   Elements/PCGPathfindingElement.h  

virtual FText GetDefaultNodeTitle()

   Elements/PCGPathfindingElement.h  

virtual FText GetNodeTooltipText()

   Elements/PCGPathfindingElement.h  

virtual EPCGSettingsType GetType()

   Elements/PCGPathfindingElement.h  

Protected

Overridden from UPCGSettings

Name Remarks Include Path Unreal Specifiers

virtual FPCGElementPtr CreateElement()

   Elements/PCGPathfindingElement.h  

virtual EPCGChangeType GetChangeTypeForProperty ( FPropertyChangedEvent& PropertyChangedEvent
) const

 Gets the change impact for a given property. Elements/PCGPathfindingElement.h  

virtual TArray< FPCGPinProperties > InputPinProperties()

 Returns an array of all the input pin properties. You should not add manually a "params" pin, it is handled automatically by FillOverridableParamsPins. Elements/PCGPathfindingElement.h  

virtual TArray< FPCGPinProperties > OutputPinProperties()

   Elements/PCGPathfindingElement.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page