1. Epic GamesDeveloper
  3. UGroundMovementUtils

UGroundMovementUtils

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

API > API/Plugins > API/Plugins/Mover

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

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

Syntax

UCLASS (MinimalAPI)  
class UGroundMovementUtils : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool CanStepUpOnHitSurface ( const FHitResult& Hit
)

   MoveLibrary/GroundMovementUtils.h
  • BlueprintCallable
  • Category=Mover
Generate a new movement based on move/orientation intents and the prior state, constrained to the ground movement plane. MoveLibrary/GroundMovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector ComputeDeflectedMoveOntoRamp ( const FVector& OrigMoveDelta,
const FVector& UpDirection,
const FHitResult& RampHitResult,
float MaxWalkSlopeCosine,
const bool bHitFromLineTrace
)

 Used to change a movement to be along a ramp's surface, typically to prevent slow movement when running up/down a ramp MoveLibrary/GroundMovementUtils.h
  • BlueprintCallable
  • Category=Mover

static float TestGroundedMoveAlongHitSurface ( const FMovingComponentSet& MovingComps,
const FVector& OriginalMoveDelta,
const FVector& LocationAtHit,
const FQuat& TargetRotation,
bool bHandleImpact,
float MaxStepHeight,
float MaxWalkSlopeCosine,
FHitResult& InOutHit,
FMovementRecord& InOutMoveRecord
)

 Tests a potential movement along a walkable surface. MoveLibrary/GroundMovementUtils.h
  • BlueprintCallable
  • Category=Mover

static FVector TestMoveToAdjustToFloor ( const FMovingComponentSet& MovingComps,
const FVector& Location,
const FQuat& Rotation,
float MaxWalkSlopeCosine,
FFloorCheckResult& InOutCurrentFloor,
FMovementRecord& InOutMoveRecord
)

 Tests potential movement of a component up/down to adjust to a walkable floor. MoveLibrary/GroundMovementUtils.h
  • BlueprintCallable
  • Category=Mover

static bool TestMoveToStepOver ( const FMovingComponentSet& MovingComps,
const FVector& GravDir,
float MaxStepHeight,
float MaxWalkSlopeCosine,
float FloorSweepDistance,
const FVector& MoveDelta,
const FQuat& Rotation,
const FHitResult& MoveHitResult,
const FFloorCheckResult& CurrentFloor,
bool bIsFalling,
FOptionalFloorCheckResult* OutFloorTestResult,
FVector& OutFinalLocation,
FMovementRecord& InOutMoveRecord
)

 Tests potential up-and-over movement of a component to overcome a blocking obstacle hit, such as moving up steps or slope. MoveLibrary/GroundMovementUtils.h  

static bool TryMoveToAdjustHeightAboveFloor ( const FMovingComponentSet& MovingComps,
FFloorCheckResult& CurrentFloor,
float MaxWalkSlopeCosine,
FMovementRecord& MoveRecord
)

 Moves vertically to stay within range of the walkable floor. MoveLibrary/GroundMovementUtils.h  

static bool TryMoveToStepUp ( const FMovingComponentSet& MovingComps,
const FVector& GravDir,
float MaxStepHeight,
float MaxWalkSlopeCosine,
float FloorSweepDistance,
const FVector& MoveDelta,
const FHitResult& Hit,
const FFloorCheckResult& CurrentFloor,
bool bIsFalling,
FOptionalFloorCheckResult* OutStepDownResult,
FMovementRecord& MoveRecord
)

 TODO: Refactor this API for fewer parameters. MoveLibrary/GroundMovementUtils.h  

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

 Attempts to move a component along a surface in the walking mode. MoveLibrary/GroundMovementUtils.h
  • BlueprintCallable
  • Category=Mover

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page