1. Epic GamesDeveloper
  3. UMovementUtils

UMovementUtils

MovementUtils: a collection of stateless static BP-accessible functions for a variety of movement-related operations

API > API/Plugins > API/Plugins/Mover

MovementUtils: a collection of stateless static BP-accessible functions for a variety of movement-related operations

   
Name UMovementUtils
Type class
Header File /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MoveLibrary/MovementUtils.h
Include Path #include "MoveLibrary/MovementUtils.h"

Syntax

UCLASS (MinimalAPI)  
class UMovementUtils : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static FRotator ApplyAngularVelocity ( const FRotator& StartingOrient,
const FRotator& AngularVelocity,
float DeltaSeconds
)

 Applies a desired angular velocity to a starting rotator over time. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FQuat ApplyAngularVelocityToQuat ( const FQuat& StartingOrient,
const FVector& AngularVelocityDegrees,
float DeltaSeconds
)

 Applies a desired angular velocity to a starting quaternion over time. MoveLibrary/MovementUtils.h
  • BlueprintPure
  • Category=Mover

static FRotator ApplyAngularVelocityToRotator ( const FRotator& StartingOrient,
const FVector& AngularVelocityDegrees,
float DeltaSeconds
)

 Applies a desired angular velocity to a starting rotator over time. MoveLibrary/MovementUtils.h
  • BlueprintPure
  • Category=Mover

static FRotator ApplyGravityToOrientationIntent ( const FRotator& IntendedOrientation,
const FQuat& WorldToGravity,
bool bStayVertical
)

 Converts intended orientation into orientation rotated by out current gravity MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool CanEscapeGravity ( const FVector& PriorVelocity,
const FVector& NewVelocity,
const FVector& GravityAccel,
float DeltaSeconds
)

 Checks whether a given velocity is strong enough to lift off against gravity MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FRotator ComputeAngularVelocity ( const FRotator& From,
const FRotator& To,
const FQuat& WorldToGravity,
float DeltaSeconds,
float TurningRateLimit
)

 Computes the angular velocity needed to change from one orientation to another within a time frame. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeAngularVelocityDegrees ( const FRotator& From,
const FRotator& To,
float DeltaSeconds,
float TurningRateLimit
)

 Computes the angular velocity needed to change from one orientation to another within a time frame. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeCombinedVelocity ( const FComputeCombinedVelocityParams& InParams
)

 Returns new velocity based on previous state, movement intent, movement mode's influence and movement settings MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeDirectionIntent ( const FVector& MoveInput,
EMoveInputType MoveInputType,
float MaxSpeed
)

 Computes the directional movement intent based on input vector and associated type MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputePenetrationAdjustment ( const FHitResult& Hit
)

 Returns a movement step that should get the subject of the hit result out of an initial penetration condition MoveLibrary/MovementUtils.h  

static FVector ComputeSlideDelta ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
const float PctOfDeltaToMove,
const FVector& Normal,
const FHitResult& Hit
)

 Returns an alternative move delta to slide along a surface, based on parameters describing a blocked attempted move MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeTwoWallAdjustedDelta ( const FMovingComponentSet& MovingComps,
const FVector& MoveDelta,
const FHitResult& Hit,
const FVector& OldHitNormal
)

 Returns an alternative move delta when we are in contact with 2 surfaces MoveLibrary/MovementUtils.h  

static FVector ComputeVelocity ( const FComputeVelocityParams& InParams
)

 Returns new ground-based velocity (worldspace) based on previous state, movement intent (worldspace), and movement settings MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeVelocityFromGravity ( const FVector& GravityAccel,
float DeltaSeconds
)

 Returns velocity (units per second) contributed by gravitational acceleration over a given time MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeVelocityFromPositions ( const FVector& FromPos,
const FVector& ToPos,
float DeltaSeconds
)

 Computes velocity based on start and end positions over time MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ConstrainToPlane ( const FVector& Vector,
const FPlane& MovementPlane,
bool bMaintainMagnitude
)

 Ensures input Vector (typically a velocity, acceleration, or move delta) is limited to a movement plane. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector DeduceUpDirectionFromGravity ( const FVector& GravityAcceleration
)

 Returns the up direction deduced from gravity acceleration, but defaults to mover constants up direction if zero MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool FindTeleportSpot ( const UMoverComponent* MoverComp,
FVector& TestLocation,
FRotator TestRotation
)

 Try to find an acceptable non-colliding location to place TestActor as close to possible to TestLocation. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector GetGravityVerticalComponent ( const FVector& Vector,
const FVector& UpDirection
)

 Returns the component of the vector in the gravity-space vertical direction. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static const ComponentType * GetOriginalComponentType ( const AActor* MoverCompOwner
)

 Gets CDO component type - useful for getting original values. MoveLibrary/MovementUtils.h  

static void InitCollisionParams ( const UPrimitiveComponent* UpdatedPrimitive,
FCollisionQueryParams& OutParams,
FCollisionResponseParams& OutResponseParam
)

   MoveLibrary/MovementUtils.h  

static bool IsAngularVelocityZero ( const FRotator& AngularVelocity
)

 Returns whether this rotator representing angular velocity has any non-zero values. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool IsExceedingMaxSpeed ( const FVector& Velocity,
float InMaxSpeed
)

 Checks whether a given velocity is exceeding a maximum speed, with some leeway to account for numeric imprecision MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool OverlapTest ( const USceneComponent* UpdatedComponent,
const UPrimitiveComponent* UpdatedPrimitive,
const FVector& Location,
const FQuat& RotationQuat,
const ECollisionChannel CollisionChannel,
const FCollisionShape& CollisionShape,
const AActor* IgnoreActor
)

   MoveLibrary/MovementUtils.h  

static FVector ProjectToGravityFloor ( const FVector& Vector,
const FVector& UpDirection
)

 Project a vector onto the floor defined by the gravity direction. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static void SetGravityVerticalComponent ( FVector& Vector,
const FVector::FReal VerticalValue,
const FVector& UpDirection
)

 Set the vertical component of the vector to the given value in the gravity-space vertical direction. MoveLibrary/MovementUtils.h  

static bool TestEncroachment ( const UMoverComponent* MoverComp,
FVector TestLocation,
FRotator TestRotation
)

 Returns whether MoverComp's Actor would encroach at TestLocation on something that blocks it. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool TestEncroachment_Internal ( const UWorld* World,
const AActor* TestActor,
const UPrimitiveComponent* PrimComp,
const FTransform& TestWorldTransform,
const TArray< AActor* >& IgnoreActors
)

 Internal function for testing whether a Mover actor would encroach at a test location. MoveLibrary/MovementUtils.h  

static bool TestEncroachmentAndAdjust ( const UMoverComponent* MoverComp,
FVector TestLocation,
FRotator TestRotation,
FVector& OutProposedAdjustment
)

 Returns whether MoverComp's Actor would encroach at TestLocation on something that blocks it. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool TestEncroachmentWithAdjustment_Internal ( const UWorld* World,
const AActor* TestActor,
const UPrimitiveComponent* PrimComp,
const FTransform& TestWorldTransform,
const TArray< AActor* >& IgnoreActors,
FVector& OutProposedAdjustment
)

 Internal function for testing whether a Mover actor would encroach at a test location, and computes a proposed adjustment where they won't encroach (if found). MoveLibrary/MovementUtils.h  

static bool TryMoveToResolvePenetration ( const FMovingComponentSet& MovingComps,
EMoveComponentFlags MoveComponentFlags,
const FVector& ProposedAdjustment,
const FHitResult& Hit,
const FQuat& NewRotationQuat,
FMovementRecord& MoveRecord
)

 Attempts to move out of a situation where the component is stuck in geometry, using a suggested adjustment to start. MoveLibrary/MovementUtils.h  

static float TryMoveToSlideAlongSurface ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
float PctOfDeltaToMove,
const FQuat Rotation,
const FVector& Normal,
FHitResult& Hit,
bool bHandleImpact,
FMovementRecord& MoveRecord
)

 Attempts to move a component along a surface. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Try Move To Slide Along Surface (Movement Record)")

static float TryMoveToSlideAlongSurfaceNoMovementRecord ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
float PctOfDeltaToMove,
const FQuat Rotation,
const FVector& Normal,
FHitResult& Hit,
bool bHandleImpact
)

 Attempts to move a component along a surface. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Try Move To Slide Along Surface (No Movement Record)")

static bool TryMoveUpdatedComponent_Internal ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
EMoveComponentFlags MoveComponentFlags,
FHitResult* OutHit,
ETeleportType Teleport
)

 Internal function that other move functions use to perform all actual component movement and retrieve results Note: This function moves the character directly and should only be used if needed. MoveLibrary/MovementUtils.h  

static float TrySafeMoveAndSlideUpdatedComponent ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult& OutHit,
ETeleportType Teleport,
FMovementRecord& MoveRecord,
bool bSlideAlongSurface
)

 Attempts to move a component and resolve any penetration issues with the proposed move Delta. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Try Safe Move And Slide (Movement Record)")

static float TrySafeMoveAndSlideUpdatedComponentNoMovementRecord ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult& OutHit,
ETeleportType Teleport,
bool bSlideAlongSurface
)

 Attempts to move a component and resolve any penetration issues with the proposed move Delta. MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Try Safe Move And Slide (No Movement Record)")

static bool TrySafeMoveUpdatedComponent ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult& OutHit,
ETeleportType Teleport,
FMovementRecord& MoveRecord
)

 Attempts to move a component and resolve any penetration issues with the proposed move Delta Note: This function takes a movement record that collects moves applied to the actor see @FMovementRecord MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Try Safe Move Updated Component (Movement Record)")

static bool TrySafeMoveUpdatedComponentNoMovementRecord ( const FMovingComponentSet& MovingComps,
const FVector& Delta,
const FQuat& NewRotation,
bool bSweep,
FHitResult& OutHit,
ETeleportType Teleport
)

 Attempts to move a component and resolve any penetration issues with the proposed move Delta Note: This function doesn't update a movement record so velocity should be gathered/set using a different method MoveLibrary/MovementUtils.h
  • BlueprintCallable
  • Category=Mover
  • Meta=(DisplayName="Try Safe Move Updated Component (No Movement Record)")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page