UUserWidget::PlayAnimation

Plays an animation in this widget a specified number of times

Windows
MacOS
Linux

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Blueprint/UserWidget.h

Include

#include "Blueprint/UserWidget.h"

Source

/Engine/Source/Runtime/UMG/Private/UserWidget.cpp

Syntax

UUMGSequencePlayer * PlayAnimation
(
    UWidgetAnimation * InAnimation,
    float StartAtTime,
    int32 NumLoopsToPlay,
    EUMGSequencePlayMode::Type PlayMode,
    float PlaybackSpeed,
    bool bRestoreState
)

Remarks

Plays an animation in this widget a specified number of times

Parameters

Parameter

Description

InAnimation

The animation to play

StartAtTime

The time in the animation from which to start playing, relative to the start position. For looped animations, this will only affect the first playback of the animation.

NumLoopsToPlay

The number of times to loop this animation (0 to loop indefinitely)

PlaybackSpeed

The speed at which the animation should play

PlayMode

Specifies the playback mode

bRestoreState

Restores widgets to their pre-animated state when the animation stops

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