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 > API/Plugins/Mover/MoveLibrary

Inheritance Hierarchy

References

   
Module Mover
Header /Engine/Plugins/Experimental/Mover/Source/Mover/Public/MoveLibrary/MovementUtils.h
Include #include "MoveLibrary/MovementUtils.h"

Syntax

UCLASS ()  
class UMovementUtils : public UBlueprintFunctionLibrary

Remarks

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

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category 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
Public function Static UFunction BlueprintCallable, Category FRotator

ComputeAngularVelocity ( 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.
Public function Static UFunction BlueprintCallable, Category FVector Returns new velocity based on previous state, movement intent, movement mode's influence and movement settings
Public function Static UFunction BlueprintCallable, Category FVector

ComputeDirectionIntent ( const FVector& MoveInput,
EMoveInputType MoveInputType
)

 Computes the directional movement intent based on input vector and associated type
Public function Static FVector Returns a movement step that should get the subject of the hit result out of an initial penetration condition
Public function Static UFunction BlueprintCallable, Category FVector

ComputeSlideDelta ( 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
Public function Static FVector

ComputeTwoWallAdjustedDelta ( const FVector& MoveDelta,
const FHitResult& Hit,
const FVector& OldHitNormal
)

 Returns an alternative move delta when we are in contact with 2 surfaces
Public function Static UFunction BlueprintCallable, Category FVector Returns new ground-based velocity (worldspace) based on previous state, movement intent (worldspace), and movement settings
Public function Static UFunction BlueprintCallable, Category FVector

ComputeVelocityFromGravity ( const FVector& GravityAccel,
float DeltaSeconds
)

 Returns velocity (units per second) contributed by gravitational acceleration over a given time
Public function Static UFunction BlueprintCallable, Category FVector

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

 Computes velocity based on start and end positions over time
Public function Static UFunction BlueprintCallable, Category 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.
Public function Static void

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

  
Public function Static UFunction BlueprintCallable, Category bool

IsExceedingMaxSpeed ( const FVector& Velocity,
float InMaxSpeed
)

 JAH TODO: Ideally, none of these functions should deal with simulation input/state types.
Public function Static bool

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

  
Public function Static bool

TryMoveToResolvePenetration ( USceneComponent* UpdatedComponent,
UPrimitiveComponent* UpdatedPrimitive,
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.
Public function Static UFunction BlueprintCallable, Category float

TryMoveToSlideAlongSurface ( USceneComponent* UpdatedComponent,
UPrimitiveComponent* UpdatedPrimitive,
UMoverComponent* MoverComponent,
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.
Public function Static bool

TryMoveUpdatedComponent_Internal ( USceneComponent* UpdatedComponent,
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.
Public function Static UFunction BlueprintCallable, Category bool

TrySafeMoveUpdatedComponent ( USceneComponent* UpdatedComponent,
UPrimitiveComponent* UpdatedPrimitive,
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page