UAnimCharacterMovementLibrary::PredictGroundMovementStopLocation

Predict where the character will stop based on its current movement properties and parameters from the movement component.

Choose your operating system:

Windows

macOS

Linux

References

Module

AnimationLocomotionLibraryRuntime

Header

/Engine/Plugins/Animation/AnimationLocomotionLibrary/Source/Runtime/Public/AnimCharacterMovementLibrary.h

Include

#include "AnimCharacterMovementLibrary.h"

Source

/Engine/Plugins/Animation/AnimationLocomotionLibrary/Source/Runtime/Private/AnimCharacterMovementLibrary.cpp

Syntax

UFUNCTION(BlueprintPure, Category="Animation Character Movement", Meta=(BlueprintThreadSafe))
static FVector PredictGroundMovementStopLocation
(
    const FVector & Velocity,
    bool bUseSeparateBrakingFriction,
    float BrakingFriction,
    float GroundFriction,
    float BrakingFrictionFactor,
    float BrakingDecelerationWalking
)

Remarks

Predict where the character will stop based on its current movement properties and parameters from the movement component. This uses prediction logic that is heavily tied to the UCharacterMovementComponent. Each parameter corresponds to a value from the UCharacterMovementComponent with the same name. Because this is a thread safe function, it's recommended to populate these fields via the Property Access system.

Returns

The predicted stop position in local space to the character. The size of this vector will be the distance to the stop location.