1. Epic GamesDeveloper
  3. UPathedPhysicsMovementMode

UPathedPhysicsMovementMode

Base for any movement mode that proceeds along a defined path within a specified amount of time Only functional when used in concert with a PathedPhysicsMoverComponent and MoverPathedPhysicsLiaisonComponent

API > API/Plugins > API/Plugins/Mover

Base for any movement mode that proceeds along a defined path within a specified amount of time Only functional when used in concert with a PathedPhysicsMoverComponent and MoverPathedPhysicsLiaisonComponent

   
Name UPathedPhysicsMovementMode
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/PhysicsMover/PathedMovement/PathedMovementMode.h
Include Path #include "PhysicsMover/PathedMovement/PathedMovementMode.h"

Syntax

UCLASS (Within=PathedPhysicsMoverComponent)  
class UPathedPhysicsMovementMode : public UBaseMovementMode

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPathedPhysicsMovementMode()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

Typedefs

Name Type Remarks Include Path
FOnIsUsingJointChanged TMulticastDelegate_OneParam< void, bool >   PhysicsMover/PathedMovement/PathedMovementMode.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bAllowPatternDebugDrawing bool True to allow individual patterns to draw debug representations. PhysicsMover/PathedMovement/PathedMovementMode.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) PhysicsMover/PathedMovement/PathedMovementMode.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. PhysicsMover/PathedMovement/PathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(AllowPrivateAccess)
CachedInputs FMutablePathedMovementProperties   PhysicsMover/PathedMovement/PathedMovementMode.h  
CustomEasingCurve TObjectPtr< UCurveFloat > If using a custom ease, this is the curve that will be used. PhysicsMover/PathedMovement/PathedMovementMode.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 PhysicsMover/PathedMovement/PathedMovementMode.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" PhysicsMover/PathedMovement/PathedMovementMode.h
  • EditAnywhere
  • Category="Pathed Movement Mode"
  • Meta=(EditCondition=bUseJointConstraint)
OneWayTripDuration float Total duration in seconds of a one-way trip from start to end. PhysicsMover/PathedMovement/PathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(ClampMin=0, UIMin=0, Units=Seconds, AllowPrivateAccess)
OnIsUsingJointChangedEvent FOnIsUsingJointChanged   PhysicsMover/PathedMovement/PathedMovementMode.h  
PathDebugDrawColor FColor The color used when drawing the aggregate path PhysicsMover/PathedMovement/PathedMovementMode.h
  • EditAnywhere
  • Category="Pathed Movement Mode|Debug"
  • Meta=(EditCondition=bDebugDrawAggregatePath)
PathPatterns TArray< TObjectPtr< UPathedMovementPatternBase > > The set of patterns to follow that combine to form the path the component will follow PhysicsMover/PathedMovement/PathedMovementMode.h
  • EditAnywhere
  • Instanced
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(AllowPrivateAccess)
PlaybackBehaviorOverride TOptional< EPathedPhysicsPlaybackBehavior > Optional playback behavior override for this mode specifically PhysicsMover/PathedMovement/PathedMovementMode.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Pathed Movement Mode"
  • Meta=(AllowPrivateAccess)

Functions

Public

Name Remarks Include Path Unreal Specifiers

UPathedMovementPatternBase * BP_FindPattern ( TSubclassOf< UPathedMovementPatternBase > PatternType
) const

 Finds the first path pattern on this mode of the given type, if there is one PhysicsMover/PathedMovement/PathedMovementMode.h
  • BlueprintPure
  • Category=PathedMovementMode
  • DisplayName="Find Pattern"
  • Meta=(DeterminesOutputType=PatternType)

Chaos::FRigidTransform3 CalcTargetRelativeTransform ( float ProgressAmt
) const

   PhysicsMover/PathedMovement/PathedMovementMode.h  

const FMutablePathedMovementProperties & GetCachedInputs()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

const FConstraintProfileProperties & GetConstraintProperties()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

float GetPathDuration()

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

UPathedPhysicsMoverComponent & GetPathedMoverComp()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

const TOptional< EPathedPhysicsPlaybackBehavior > & GetPlaybackBehaviorOverride()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

virtual void InitializePath()

 Called when the owning UPathedPhysicsMoverComponent is registered (i.e. at both edit and game time) PhysicsMover/PathedMovement/PathedMovementMode.h  

bool IsUsingJoint()

   PhysicsMover/PathedMovement/PathedMovementMode.h
  • BlueprintCallable
  • Category=PathedMovementMode

FOnIsUsingJointChanged & OnIsUsingJointChanged()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

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

   PhysicsMover/PathedMovement/PathedMovementMode.h  

virtual void OnProcessInput_Internal ( int32 PhysicsStep,
float DeltaTime,
const FPhysicsMoverAsyncInput& Input
) const

   PhysicsMover/PathedMovement/PathedMovementMode.h  

void SetPathDuration_BeginPlayOnly ( float NewDuration
)

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

void SetUseJointConstraint ( bool bUseJoint
)

   PhysicsMover/PathedMovement/PathedMovementMode.h
  • BlueprintCallable
  • Category=PathedMovementMode

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

   PhysicsMover/PathedMovement/PathedMovementMode.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   PhysicsMover/PathedMovement/PathedMovementMode.h  

Protected

Name Remarks Include Path Unreal Specifiers

float GetBoundedPlaybackTime ( float TotalPlayTime,
bool& bOutReachesEndOfPlayback
) const

   PhysicsMover/PathedMovement/PathedMovementMode.h  

float GetBoundedTimeAlongPath ( float Time
) const

   PhysicsMover/PathedMovement/PathedMovementMode.h  

float GetBoundedTimeAlongPath_Unsafe ( float BoundedPlaybackTime
) const

   PhysicsMover/PathedMovement/PathedMovementMode.h  

float GetPlaybackDuration()

   PhysicsMover/PathedMovement/PathedMovementMode.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page