Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > UMG > Animation > UWidgetAnimation

Light Theme

Dark Theme

UWidgetAnimation

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UMovieSceneSignedObject

UMovieSceneSequence

UWidgetAnimation

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Animation/WidgetAnimation.h
Include	#include "Animation/WidgetAnimation.h"

Syntax

class UWidgetAnimation : public UMovieSceneSequence

Variables

		Name	Description
	TArray< FWidget...	AnimationBindings
	UMovieScene ...	MovieScene	Pointer to the movie scene that controls this animation.

Constructors

	Name	Description
	UWidgetAnimation ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BindToAnimationFinished ( UUserWidget* Widget, FWidgetAnimationDynamicEvent Delega... )
void	BindToAnimationStarted ( UUserWidget* Widget, FWidgetAnimationDynamicEvent Delega... )	These animation binding functions were added so that we could cleanly upgrade assets from before animation sharing, they don't actually modify the animation, they just pipe through to the UUserWidget.
const TArray...	GetBindings()	Get Animation bindings of the animation
const FStrin...	GetDisplayLabel()
float	GetEndTime()	Get the end time of this animation.
bool	GetLegacyFinishOnStop()	Whether to finish evaluation on stop
UWidgetAnima...	GetNullAnimation()	Get a placeholder animation.
float	GetStartTime()	Get the start time of this animation.
void	RemoveBinding ( const UObject& PossessedObject )	Remove Animation Binding
void	RemoveBinding ( const FWidgetAnimationBinding& Bin... )	Remove Animation Binding
void	SetDisplayLabel ( const FString& InDisplayLabel )	Sets the friendly name of the animation to display in the editor
void	UnbindAllFromAnimationFinished ( UUserWidget* Widget )
void	UnbindAllFromAnimationStarted ( UUserWidget* Widget )
void	UnbindFromAnimationFinished ( UUserWidget* Widget, FWidgetAnimationDynamicEvent Delega... )
void	UnbindFromAnimationStarted ( UUserWidget* Widget, FWidgetAnimationDynamicEvent Delega... )

Overridden from UMovieSceneSequence

	Name	Description
void	BindPossessableObject ( const FGuid& ObjectId, UObject& PossessedObject, UObject* Context )	Called when Sequencer has created an object binding for a possessable object
bool	CanPossessObject ( UObject& Object, UObject* InPlaybackContext )	Check whether the given object can be possessed by this animation.
UObject *...	CreateDirectorInstance ( IMovieScenePlayer& Player, FMovieSceneSequenceID SequenceID )	Called to retrieve or construct a director instance to be used for the specified player
FText	GetDisplayName()	Returns the DisplayLabel if set, otherwise the object name
UMovieScene ...	GetMovieScene()	Get the movie scene that controls this animation.
UObject *...	GetParentObject ( UObject* Object )	Get the logical parent object for the supplied object (not necessarily its outer).
ETrackSuppor...	IsTrackSupported ( TSubclassOf< class UMovieSceneTrack... )	Sequences can determine whether they support a particular track type
void	LocateBoundObjects ( const FGuid& ObjectId, UObject* Context, TArray< UObject*, TInlineAlloc... )	Locate all the objects that correspond to the specified object ID, using the specified context
void	UnbindInvalidObjects ( const FGuid& ObjectId, UObject* Context )	Unbinds specific objects from the provided GUID that do not resolve
void	UnbindObjects ( const FGuid& ObjectId, const TArray< UObject* >& InO..., UObject* Context )	Unbinds specific objects from the provided GUID
void	UnbindPossessableObjects ( const FGuid& ObjectId )	Unbinds all possessable objects from the provided GUID.

Overridden from UObject

		Name	Description
	bool	IsPostLoadThreadSafe()	Called during async load to determine if PostLoad can be called on the loading thread.
	void	PostLoad()	Called after this object has been deserialized

Deprecated Variables

		Name	Description
	FOnWidgetAnimat...	OnAnimationFinished_DEPRECATED	Fires when the widget animation is finished.
	FOnWidgetAnimat...	OnAnimationStarted_DEPRECATED	Fires when the widget animation starts playing.

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

Take our survey

Dismiss