1. Epic GamesDeveloper
  3. UChaosPathedMovementControllerComponent

UChaosPathedMovementControllerComponent

This controller component gives control over pathed movement of an actor with a mover component and an active pathed movement mode.

API > API/Plugins > API/Plugins/ChaosMover

This controller component gives control over pathed movement of an actor with a mover component and an active pathed movement mode. You can start/stop, play forward or in reverse, play once or loop and play one way (0 to 1) or round trip (0 to 1 to 0). In async mode, control requests are sent as scheduled to take effect at a future frame, to give enough time for all end points to receive the request and react at the same exact scheduled frame.

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

Syntax

UCLASS (BlueprintType, Blueprintable, Meta=(BlueprintSpawnableComponent))  
class UChaosPathedMovementControllerComponent :  
    public UActorComponent ,  
    public IMoverInputProducerInterface ,  
    public IChaosPathedMovementDebugDrawInterface

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UChaosPathedMovementControllerComponent()

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
InitialProperties FChaosMutablePathedMovementProperties   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • EditAnywhere
  • Category="Pathed Movement"
OnPathedMovementBounced FChaosMover_OnPathedMovementBounced Broadcast when the pathed movement has bounced (reached the end of one leg in a round trip) ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintAssignable
  • Category="Pathed Movement"
OnPathedMovementLoopingPlaybackChanged FChaosMover_OnPathedMovementLoopingPlaybackChanged Broadcast when looping has changed ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintAssignable
  • Category="Pathed Movement"
OnPathedMovementOneWayPlaybackChanged FChaosMover_OnPathedMovementOneWayPlaybackChanged Broadcast when one way has changed ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintAssignable
  • Category="Pathed Movement"
OnPathedMovementReversePlaybackChanged FChaosMover_OnPathedMovementReversePlaybackChanged Broadcast when reverse has changed ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintAssignable
  • Category="Pathed Movement"
OnPathedMovementStarted FChaosMover_OnPathedMovementStarted Broadcast when the pathed movement has started ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintAssignable
  • Category="Pathed Movement"
OnPathedMovementStopped FChaosMover_OnPathedMovementStopped Broadcast when the pathed movement has stopped ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintAssignable
  • Category="Pathed Movement"

Protected

Name Type Remarks Include Path Unreal Specifiers
EventSchedulingMinDelaySeconds float Delay added to changes, when they are scheduled. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  
LastChangeFrame int32 The (server) frame at which PathedMovementMutableProperties took effect Note that it can be greater than the current server frame to schedule that change (the changes are sent immediately but scheduled to take effect in the future) ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  
MovementStartFrame int32 The frame at which movement last started (but this may be in the future for a scheduled start) ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  
MoverComponent TObjectPtr< UMoverComponent > Cached mover component if found on owner actor We use the OnPostMovement delegate to reflect the current state to gameplay (interpolated state in async) ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • Transient
PathedMovementDelayedStartTimerHandle FTimerHandle   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  
PathedMovementMutableProperties FChaosMutablePathedMovementProperties Mutable pathed movement properties to take effect when server frame reaches LastChangeFrame. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  
PostSimState FChaosPathedMovementState The (possibly interpolated) post simulation state. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool IsLoopingPlayback()

 Is the playback looping ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool IsOneWayPlayback()

 Is the playback one way or round trip ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool IsPlayingPath()

 Is a playback under way (not just requested) or stopped? ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool IsReversePlayback()

 Is the playback in reverse ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

virtual void ProduceInput_Implementation ( int32 SimTimeMs,
FMoverInputCmdContext& InputCmdResult
)

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

void RequestLoopingPlayback ( bool bWantsLoopingPlayback,
EChaosPathedMovementExecutionType ExecutionType,
bool bIsScheduled
)

 Looping Playback. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

void RequestOneWayPlayback ( bool bWantsOneWayPlayback,
EChaosPathedMovementExecutionType ExecutionType,
bool bIsScheduled
)

 One-way vs. round trip playback. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

void RequestReversePlayback ( bool bWantsReversePlayback,
EChaosPathedMovementExecutionType ExecutionType,
bool bIsScheduled
)

 Reverse Playback. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

void RequestStartPlayingPath ( EChaosPathedMovementExecutionType ExecutionType,
bool bIsScheduled
)

 Pathed Movement Control Layer Start/Stop Playing Path Request to start or resume moving along the path. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

void RequestStopPlayingPath ( EChaosPathedMovementExecutionType ExecutionType,
bool bIsScheduled
)

 Request to stop playback. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool WantsLoopingPlayback()

 Do we want the playback to be looping or forward? ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool WantsOneWayPlayback()

 Do we want the playback to be one way or round trip? ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool WantsPlayingPath()

 Do we want to be starting or resuming playback? ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

bool WantsReversePlayback()

 Do we want the playback to be in reverse? ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h
  • BlueprintCallable
  • Category="Pathed Movement"

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

 UActorComponent. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

virtual void OnRegister()

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

virtual void OnUnregister()

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual float GetPreviewMeshOverallPathProgress_Implementation()

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

virtual UMaterialInterface * GetProgressPreviewMeshMaterial_Implementation()

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

virtual void OnPostFinalize ( const FMoverSyncState& SyncState,
const FMoverAuxStateContext& AuxState
)

   ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

virtual void OnPostSimEventReceived ( const FMoverSimulationEventData& EventData
)

 Processes output events coming from the simulation and broadcasts delegates accordingly. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

virtual bool ShouldDisplayProgressPreviewMesh_Implementation()

 IChaosPathedMovementDebugDrawInterface implementation. ChaosMover/PathedMovement/ChaosPathedMovementControllerComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page