UCharacterMovementComponent — UE_DEPRECATED_FORGAME annotations
Deprecated: Marks several members deprecated at different versions: CrouchedHalfHeight (5.0), DoJump(bool) (5.5), and FSavedMove_Character::MovementMode (4.20). See each annotation's message for its specific replacement.
#include "GameFramework/CharacterMovementComponent.h"
Access: public
Specifiers: deprecated
Description
A compiler-warning macro applied to deprecated members of UCharacterMovementComponent. In this class it marks the CrouchedHalfHeight property (5.0, use SetCrouchedHalfHeight/GetCrouchedHalfHeight), the old DoJump(bool) overload (5.5, use DoJump(bool, float)), and the legacy MovementMode field on FSavedMove_Character (4.20, use StartPackedMovementMode/EndPackedMovementMode).
Caveats & Gotchas
- • UE_DEPRECATED_FORGAME only triggers its compile-time warning in game modules — engine code itself can keep using the annotated member internally, so you may see engine call sites still touching these fields.
- • Each use site carries its own version and message; always check the specific annotation in the header rather than assuming a single replacement applies everywhere.
- • This entry documents the macro's usage pattern in this class, not a real callable member — there's no 'UE_DEPRECATED_FORGAME' function or property to invoke.
Signature
UE_DEPRECATED_FORGAME(version, "message")Example
What this looks like in the header C++
// Property deprecation:
UE_DEPRECATED_FORGAME(5.0, "Public access to this property is deprecated, and it will become private "
"in a future release. Please use SetCrouchedHalfHeight and GetCrouchedHalfHeight instead.")
UPROPERTY(...)
float CrouchedHalfHeight;
// Function overload deprecation:
UE_DEPRECATED_FORGAME(5.5, "This function has been deprecated. Please call DoJump(bool bReplayingMoves, float DeltaTime)")
virtual bool DoJump(bool bReplayingMoves);Tags
Version History
Introduced in: 4.20
| Version | Status | Notes |
|---|---|---|
| 5.6 | stable | — |
Feedback
Was this helpful?