1. Epic GamesDeveloper
  3. UInterpToMovementComponent

UInterpToMovementComponent

Move the root component between a series of points over a given time *

API > API/Runtime > API/Runtime/Engine > API/Runtime/Engine/Components

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/Components/InterpToMovementComponent.h
Include #include "Components/InterpToMovementComponent.h"

Syntax

UCLASS (ClassGroup=Movement, Meta=(BlueprintSpawnableComponent), HideCategories=Velocity,  
       MinimalAPI)  
class UInterpToMovementComponent : public UMovementComponent

Remarks

Move the root component between a series of points over a given time *

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bCheckIfStillInWorld Do we want this comp to perform CheckStillInWorld checks?
Protected variable bool bContainsActorControlPoints Are there any actor control points in use
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EInterpToBehaviourType BehaviourType Movement behaviour of the component
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bForceSubStepping If true, forces sub-stepping to break up movement into discrete smaller steps to improve accuracy of the trajectory.
Protected variable bool bIsWaiting Have we hit something and are waiting for it to move to carry on moving
Public variable UProperty Category, EditAnywhere BlueprintReadWrite uint32: 1 bPauseOnImpact If true, will pause movement on impact.
Protected variable bool bStopped Have we stopped (because we hit something, or reached the end of the cycle
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bSweep If true, will sweep for blocking collision during movement.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TArray< FInterpControlPoint > ControlPoints List of control points to visit.
Protected variable float CurrentDirection Current direction along spline timeline
Protected variable float CurrentTime Current position on spline
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float Duration How long to take to move from the first point to the last (or vice versa)
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 MaxSimulationIterations Max number of iterations used for each discrete simulation step.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite float MaxSimulationTimeStep Max time delta for each discrete simulation step.
Public variable UProperty BlueprintAssignable FOnInterpToReverseDelegate OnInterpToReverse Called when InterpTo impacts something and reverse is enabled.
Public variable UProperty BlueprintAssignable FOnInterpToStopDelegate OnInterpToStop Called when InterpTo has come to a stop.
Public variable UProperty BlueprintAssignable FOnInterpToResetDelegate OnResetDelegate Called when InterpTo reached the end and reset back to start .
Public variable UProperty BlueprintAssignable FOnInterpToWaitBeginDelegate OnWaitBeginDelegate Called when InterpTo has come to a stop but will resume when possible.
Public variable UProperty BlueprintAssignable FOnInterpToWaitEndDelegate OnWaitEndDelegate Called when InterpTo has resumed following a stop.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float SpeedMultiplier Change the speed of movement.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ETeleportType TeleportType Physics teleport type.
Protected variable float TimeMultiplier User to

Constructors

  Type Name Description
Public function  

UInterpToMovementComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual UFunction BlueprintCallable, Category void

AddControlPointPosition ( FVector Pos,
bool bPositionIsRelative
)

 Add a control point that represents a position.
Protected function float

CalculateNewTime ( float TimeNow,
float Delta,
FHitResult& HitResult,
bool InBroadcastEvent,
bool& OutStopped,
float& OutTimeRemainder
)

 Calculate the new current time
Public function Virtual bool This will check to see if the InterpTo is still in the world.
Protected function Virtual Const FVector

ComputeMoveDelta ( float Time
)

 Compute the distance for the given time.
Public function UFunction BlueprintCallable, Category void Initialise the control points array.
Public function Const float

GetSimulationTimeStep ( float RemainingTime,
int32 Iterations
)

 Compute remaining time step given remaining time and current iterations.
Protected function bool

HandleHitWall ( const FHitResult& Hit,
float TimeTick,
const FVector& MoveDelta
)

  
Public function bool  
Public function UFunction BlueprintCallable, Category void Clear the control points array and set to stopped.
Public function UFunction BlueprintCallable, Category void

RestartMovement ( float InitialDirection
)

 Reset to start. Sets time to zero and direction to 1.
Protected function void

ReverseDirection ( const FHitResult& Hit,
float Time,
bool InBroadcastEvent
)

 Reverse direction we are moving
Public function Virtual Const bool Determine whether or not to use substepping in the InterpTo motion update.
Public function UFunction BlueprintCallable, Category void

StopSimulating ( const FHitResult& HitResult
)

 Clears the reference to UpdatedComponent, fires stop event, and stops ticking.
Protected function Virtual void

UpdateControlPoints ( bool InForceUpdate
)

 Update the control points.

Overridden from UMovementComponent

  Type Name Description
Protected function Virtual void

HandleImpact ( const FHitResult& Hit,
float TimeSlice,
const FVector& MoveDelta
)

 Deal with an impact. Change direction, stop etc depending on the current behaviour setting.
Public function Virtual void Stops movement immediately (zeroes velocity, usually zeros acceleration for components with acceleration).

Overridden from UActorComponent

  Type Name Description
Public function Virtual void

ApplyWorldOffset ( const FVector& InOffset,
bool bWorldShift
)

 Called by owner actor on position shifting Component should update all relevant data structures to reflect new actor location
Public function Virtual void Begins Play for the component.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Classes

  Type Name Description
Public class FOnInterpToResetDelegate    
Public class FOnInterpToReverseDelegate    
Public class FOnInterpToStopDelegate    
Public class FOnInterpToWaitBeginDelegate    
Public class FOnInterpToWaitEndDelegate    

Constants

Name Description
MIN_TICK_TIME Minimum delta time considered when ticking.

See Also

UMovementComponent

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page