UMovementComponent::IsExceedingMaxSpeed

Returns true if the current velocity is exceeding the given max speed (usually the result of [GetMaxSpeed()](API\Runtime\Engine\GameFramework\UMovementComponent\GetMaxSpeed)), within a small error tolerance.

Windows
MacOS
Linux

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/GameFramework/MovementComponent.h

Include

#include "GameFramework/MovementComponent.h"

Source

/Engine/Source/Runtime/Engine/Private/Components/MovementComponent.cpp

Syntax

virtual bool IsExceedingMaxSpeed
(
    float MaxSpeed
) const

Remarks

Returns true if the current velocity is exceeding the given max speed (usually the result of GetMaxSpeed()), within a small error tolerance. Note that under normal circumstances updates cause by acceleration will not cause this to be true, however external forces or changes in the max speed limit can cause the max speed to be violated.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss