BP_SplinePath

October 03, 2024

BP_SplinePath

Path: /Game/AdvancedTurnBasedTileToolkit/Maps/Demo/Outline/BP_SplinePath

.. cpp:class:: BP_SplinePath : public Actor

Used by a GridUI to draw movement spline paths and outlines

.. cpp:function:: void Construction_Script(exec then)

  Type: Construction script, the place to spawn components and do other setup. @note Name used in CreateBlueprint function

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Required API, Event, Blueprint Event

  Construction script, the place to spawn components and do other setup. @note Name used in CreateBlueprint function

  :arg then: 
  :type then: exec

.. cpp:function:: exec ClearSplinePath(exec then)

  Type: Hides all visible spline meshes

  Category: Default

  Access Modifier: Public

  Constant: False

  Flags: Blueprint Callable, Blueprint Event

  Hides all visible spline meshes

  :arg then: 
  :type then: exec
  :returns execute: 
  :rtype execute: exec

.. cpp:function:: (exec, SplineMeshComponent, exec, SplineMeshComponent) GetOrAddSplineMesh(exec then)

  Type: Creates a new spline mesh component or reuses an old one if available

  Category: Default

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Has Defaults, Blueprint Callable, Blueprint Event, Blueprint Pure

  Creates a new spline mesh component or reuses an old one if available

  :arg then: 
  :type then: exec
  :returns execute: 
  :rtype execute: exec
  :returns SplineMesh: 
  :rtype SplineMesh: SplineMeshComponent
  :returns execute: 
  :rtype execute: exec
  :returns SplineMesh: 
  :rtype SplineMesh: SplineMeshComponent

.. cpp:function:: (exec, Vector) FindPathPoints(exec then, Vector Path)

  Type: Takes a path of tile locations and generates a point of movement path points connecting these with smooth turns and adjusting for height differences

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Has Defaults, Blueprint Callable, Blueprint Event

  Takes a path of tile locations and generates a point of movement path points connecting these with smooth turns and adjusting for height differences

  :arg then: 
  :type then: exec
  :arg Path: 
  :type Path: Vector
  :returns execute: 
  :rtype execute: exec
  :returns PathPoints: 
  :rtype PathPoints: Vector

.. cpp:function:: (exec, exec) DisplayPathFromPoints(exec then, Vector Points, DataTableRowHandle PathData, double StraightThreshold=150.000000, bool bIsOutline)

  Type: 

  Category: Default

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Has Defaults, Blueprint Callable, Blueprint Event

  

  :arg then: 
  :type then: exec
  :arg Points: 
  :type Points: Vector
  :arg PathData: 
  :type PathData: DataTableRowHandle
  :arg StraightThreshold:  (Default: 150.000000)
  :type StraightThreshold: double
  :arg bIsOutline: 
  :type bIsOutline: bool
  :returns execute: 
  :rtype execute: exec
  :returns execute: 
  :rtype execute: exec

.. cpp:function:: (exec, exec) EnsureFirstSegmentIsLong(exec then, Vector OutlinePoints, double StraightThreshold)

  Type: 

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Blueprint Callable, Blueprint Event

  

  :arg then: 
  :type then: exec
  :arg OutlinePoints: 
  :type OutlinePoints: Vector
  :arg StraightThreshold: 
  :type StraightThreshold: double
  :returns execute: 
  :rtype execute: exec
  :returns execute: 
  :rtype execute: exec

.. cpp:function:: (exec, exec) AdjustPathThickness(exec then, SplineMeshComponent SplineMeshesIn, Vector2D Thickness)

  Type: 

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Blueprint Callable, Blueprint Event

  

  :arg then: 
  :type then: exec
  :arg SplineMeshesIn: 
  :type SplineMeshesIn: SplineMeshComponent
  :arg Thickness: 
  :type Thickness: Vector2D
  :returns execute: 
  :rtype execute: exec
  :returns execute: 
  :rtype execute: exec

.. cpp:function:: exec ExtrapolatePathAtStartAndEnd(exec then, Vector Points)

  Type: 

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Blueprint Callable, Blueprint Event

  

  :arg then: 
  :type then: exec
  :arg Points: 
  :type Points: Vector
  :returns execute: 
  :rtype execute: exec

.. cpp:function:: exec LoopPathBackOnItself(exec then, Vector Points)

  Type: 

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Blueprint Callable, Blueprint Event

  

  :arg then: 
  :type then: exec
  :arg Points: 
  :type Points: Vector
  :returns execute: 
  :rtype execute: exec

.. cpp:function:: (exec, MaterialInstanceDynamic, exec, MaterialInstanceDynamic) GetSplineMeshDynamicMaterial(exec then, PrimitiveComponent Target)

  Type: 

  Category: 

  Access Modifier: Public

  Constant: False

  Flags: Has Out Params, Blueprint Callable, Blueprint Event, Blueprint Pure

  

  :arg then: 
  :type then: exec
  :arg Target: 
  :type Target: PrimitiveComponent
  :returns execute: 
  :rtype execute: exec
  :returns DynamicMaterial: 
  :rtype DynamicMaterial: MaterialInstanceDynamic
  :returns execute: 
  :rtype execute: exec
  :returns DynamicMaterial: 
  :rtype DynamicMaterial: MaterialInstanceDynamic

.. cpp:member:: SplineComponent PathSpline

  Category: Default

  Access Modifier: 
  Flags: Blueprint Visible, Zero Constructor, Instanced Reference, Non Transactional, No Destructor, Has Get Value Type Hash
  Lifetime Condition: None

  

.. cpp:member:: SceneComponent DefaultSceneRoot

  Category: Default

  Access Modifier: 
  Flags: Blueprint Visible, Zero Constructor, Instanced Reference, Non Transactional, No Destructor, Has Get Value Type Hash
  Lifetime Condition: None

  

.. cpp:member:: int SplineMeshCounter

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Zero Constructor, Disable Edit On Instance, Is Plain Old Data, No Destructor, Has Get Value Type Hash
  Lifetime Condition: None

  

.. cpp:member:: Array SplineMeshes

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Disable Edit On Instance, Contains Instanced Reference
  Lifetime Condition: None

  

.. cpp:member:: StaticMesh SplineAppearance

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Zero Constructor, Disable Edit On Instance, No Destructor, Has Get Value Type Hash
  Lifetime Condition: None

  

.. cpp:member:: double PathHeight

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Zero Constructor, Is Plain Old Data, No Destructor, Expose On Spawn, Has Get Value Type Hash
  Lifetime Condition: None

  

.. cpp:member:: Array DynamicMaterials

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Disable Edit On Instance
  Lifetime Condition: None

  

.. cpp:member:: double OutlineHeight

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Zero Constructor, Is Plain Old Data, No Destructor, Expose On Spawn, Has Get Value Type Hash
  Lifetime Condition: None

  

.. cpp:member:: double PathBendOffset

  Category: Default

  Access Modifier: 
  Flags: Edit, Blueprint Visible, Zero Constructor, Disable Edit On Instance, Is Plain Old Data, No Destructor, Has Get Value Type Hash
  Lifetime Condition: None

  

Profile picture

Written by Urakaiketsuya , just a guy who codes. You should follow them on Twitter