1. Epic GamesDeveloper
  3. UChaosPathedMovementMode

UChaosPathedMovementMode

Base for any movement mode that proceeds along a defined path within a specified amount of time

API > API/Plugins > API/Plugins/ChaosMover

Base for any movement mode that proceeds along a defined path within a specified amount of time

   
Name UChaosPathedMovementMode
Type class
Header File /Engine/Plugins/Experimental/ChaosMover/Source/ChaosMover/Public/ChaosMover/PathedMovement/ChaosPathedMovementMode.h
Include Path #include "ChaosMover/PathedMovement/ChaosPathedMovementMode.h"

Syntax

UCLASS (Within=MoverComponent)  
class UChaosPathedMovementMode :  
    public UChaosMovementMode ,  
    public IChaosMovementActuationInterface ,  
    public IChaosPathedMovementModeInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosPathedMovementMode ( const FObjectInitializer& ObjectInitializer
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllowPatternDebugDrawing bool True to allow individual patterns to draw debug representations. ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • Category="Pathed Movement Mode|Debug"
bDebugDrawAggregatePath bool True to draw debug lines for the aggregate path resulting from all the patterns in the path (i.e. the path that will actually be followed in game) ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • Category="Pathed Movement Mode|Debug"
bUseJointConstraint bool True to have the updated component be able to respond to physics inputs by being "pulled" along the path using a joint constraint configured using JointConstraintProperties below. ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(AllowPrivateAccess)
CustomEasingCurve TObjectPtr< UCurveFloat > If using a custom ease, this is the curve that will be used. ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(EditCondition="Easing==EAlphaBlendOption::Custom", AllowPrivateAccess)
Easing EAlphaBlendOption The kind of easing to apply when traveling along the path ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(AllowPrivateAccess)
JointConstraintProperties FConstraintProfileProperties Configuration of the joint constraint that (if enabled) pulls the updated component along the path The default settings are for a very stiff joint that allows just a little bit of "play" ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • Category="Pathed Movement Mode"
  • Meta=(EditCondition=bUseJointConstraint)
JointSettings Chaos::FPBDJointSettings   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  
OneWayPlaybackDuration float Total duration in seconds of a one-way trip from start to end. ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(ClampMin=0, UIMin=0, Units=Seconds, AllowPrivateAccess)
PathDebugDrawColor FColor The color used when drawing the aggregate path ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • Category="Pathed Movement Mode|Debug"
  • Meta=(EditCondition=bDebugDrawAggregatePath)
PathPatterns TArray< TObjectPtr< UChaosPathedMovementPatternBase > > The set of patterns to follow that combine to form the path the component will follow ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • EditAnywhere
  • Instanced
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(AllowPrivateAccess)

Functions

Public

Name Remarks Include Path Unreal Specifiers
Finds the first path pattern on this mode of the given type, if there is one ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • BlueprintPure
  • Category=PathedMovementMode
  • DisplayName="Find Pattern"
  • Meta=(DeterminesOutputType=PatternType)

virtual void GenerateMove_Implementation ( const FMoverTickStartData& StartState,
const FMoverTimeStep& TimeStep,
FProposedMove& OutProposedMove
) const

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

float GetOneWayTripDuration()

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • BlueprintCallable
  • Category=PathedMovementMode
  • DisplayName="Set Path Duration (BeginPlay only)"

virtual void InitializePath()

 Called when the owning UChaosPathedPhysicsMoverComponent is registered (i.e. at both edit and game time) ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void SetOneWayTripDuration_BeginPlayOnly ( float NewDuration
)

 Set the time it takes to travel one way along this path from start to end. ChaosMover/PathedMovement/ChaosPathedMovementMode.h
  • BlueprintCallable
  • Category=PathedMovementMode
  • DisplayName="Set Path Duration (BeginPlay only)"

virtual void SimulationTick_Implementation ( const FSimulationTickParams& Params,
FMoverTickEndData& OutputState
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Overridden from UChaosMovementMode

Name Remarks Include Path Unreal Specifiers

virtual bool UsesMovementBasisTransform()

 Whether this movement mode is relative to a basis transform. ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Overridden from UBaseMovementMode

Name Remarks Include Path Unreal Specifiers

virtual void OnRegistered ( const FName ModeName
)

 UBaseMovementMode. ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual EDataValidationResult IsDataValid ( FDataValidationContext& Context
) const

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Overridden from IChaosMovementActuationInterface

Name Remarks Include Path Unreal Specifiers

virtual const Chaos::FPBDJointSettings & GetConstraintSettings()

 Constraint settings of the joint constraint, only valid when ShouldUseConstraint() is true. ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

virtual bool ShouldUseConstraint()

 Whether the simulation should use a constraint to move the controlled particle, or moving it kinematically. ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Overridden from IChaosPathedMovementModeInterface

Name Remarks Include Path Unreal Specifiers

virtual FTransform CalcTargetTransform ( float Progression,
const FTransform& BasisTransform
) const

 Returns the transform on the path at Progression. ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnInReverseChanging ( double BaseSimTimeMs,
bool bNewInReverse
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void OnLoopingChanging ( double BaseSimTimeMs,
bool bNewLooping
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void OnOneWayChanging ( double BaseSimTimeMs,
bool bNewOneWay
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void OnPlaybackBounced ( double BaseSimTimeMs
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void OnPlaybackStarting ( double BaseSimTimeMs
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void OnPlaybackStopping ( double BaseSimTimeMs,
bool bReachedEndOfPlayback
)

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

void SetDefaultJointConstraintProperties()

   ChaosMover/PathedMovement/ChaosPathedMovementMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page