Navigation
API > API/Runtime > API/Runtime/UMG
Handle to an ongoing or finished widget animation.
| Name | FWidgetAnimationHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/UMG/Public/Animation/WidgetAnimationHandle.h |
| Include Path | #include "Animation/WidgetAnimationHandle.h" |
Syntax
USTRUCT (BlueprintType )
struct FWidgetAnimationHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Creates an invalid handle. | Animation/WidgetAnimationHandle.h | ||
FWidgetAnimationHandle
(
TSharedPtr< FWidgetAnimationState > InState |
Creates a handle for the given running animation on the given widget. | Animation/WidgetAnimationHandle.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| WeakState | TWeakPtr< FWidgetAnimationState > | Weak pointer to the animation state. | Animation/WidgetAnimationHandle.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FWidgetAnimationState * GetAnimationState() |
Gets the animation state. | Animation/WidgetAnimationHandle.h | |
UUMGSequencePlayer * GetSequencePlayer() |
For backwards compatibility in C++ code. | Animation/WidgetAnimationHandle.h | |
FName GetUserTag() |
Gets the user tag associated with the running animation. | Animation/WidgetAnimationHandle.h | |
bool IsValid () |
Returns whether this handle is valid. | Animation/WidgetAnimationHandle.h | |
TSharedPtr< FWidgetAnimationState > PinAnimationState() |
Gets the animation state. | Animation/WidgetAnimationHandle.h | |
void SetUserTag
(
FName InUserTag |
Sets the user tag associated with the running animation. | Animation/WidgetAnimationHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator UUMGSequencePlayer *() |
Animation/WidgetAnimationHandle.h |