1. Epic GamesDeveloper
  3. UUserWidget

UUserWidget

A widget that enables UI extensibility through WidgetBlueprint.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Blueprint

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Blueprint/UserWidget.h
Include #include "Blueprint/UserWidget.h"

Syntax

UCLASS (Abstract, EditInlineNew, BlueprintType, Blueprintable,  
       Meta=(DontUseGenericSpawnObject="True", DisableNativeTick), MinimalAPI)  
class UUserWidget :  
    public UWidget ,  
    public INamedSlotInterface

Remarks

A widget that enables UI extensibility through WidgetBlueprint.

Variables

  Type Name Description
Public variable UProperty Transient TArray< TObjectPtr< UUMGSequencePlayer > > ActiveSequencePlayers All the sequence players currently playing
Protected variable UProperty Transient duplicatetransient TArray< FAnimationEventBinding > AnimationCallbacks  
Public variable UProperty Transient TObjectPtr< UUMGSequenceTickManager > AnimationTickManager  
Public variable UProperty uint8: 1 bAutomaticallyRegisterInputOnConstruction If true, this widget will automatically register its own input component upon construction.
Public variable UProperty uint8: 1 bHasScriptImplementedPaint If a widget has an implemented paint blueprint function
Public variable UProperty uint8: 1 bHasScriptImplementedTick If a widget has an implemented tick blueprint function
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter uint8: 1 bIsFocusable Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter uint8: 1 bStopAction  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FLinearColor ColorAndOpacity The color and opacity of this widget. Tints all child widgets.
Public variable UProperty FGetLinearColor ColorAndOpacityDelegate  
Public variable UProperty EDesignPreviewSizeMode DesignSizeMode  
Public variable UProperty FVector2D DesignTimeSize Stores the design time desired size of the user widget
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FSlateColor ForegroundColor The foreground color of the widget, this is inherited by sub widgets.
Public variable UProperty FGetSlateColor ForegroundColorDelegate  
Protected variable UProperty Transient duplicatetransient TObjectPtr< class UInputComponent > InputComponent  
Protected variable FLinearColor K2_Cache_ColorAndOpacity  
Protected variable FSlateColor K2_Cache_ForegroundColor  
Public variable FNativeOnDestruct OnNativeDestruct  
Public variable FNativeOnVisibilityChangedEvent OnNativeVisibilityChanged  
Public variable UProperty Category BlueprintAssignable FOnVisibilityChangedEvent OnVisibilityChanged Called when the visibility has changed
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FMargin Padding The padding area around the content.
Public variable UProperty FText PaletteCategory The category this widget appears in the palette.
Public variable UProperty Category, EditDefaultsOnly TObjectPtr< UTexture2D > PreviewBackground A preview background that you can use when designing the UI to get a sense of scale on the screen.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter int32 Priority  
Public variable UProperty Transient TArray< FQueuedWidgetAnimationTransition > QueuedWidgetAnimationTransitions Animation transitions to trigger on next tick
Public variable UProperty Transient TArray< TObjectPtr< UUMGSequencePlayer > > StoppedSequencePlayers List of sequence players to cache and clean up when safe
Protected variable friend UUMGSequencePlayer The sequence player is a friend because we need to be alerted when animations start and finish without going through the normal event callbacks as people have a tendency to RemoveAll(this), which would permanently disable callbacks that are critical for UserWidget's base class - so rather we just directly report to the owning UserWidget of state transitions.
Protected variable friend UUMGSequenceTickManager  
Public variable UProperty Transient duplicatetransient, textexporttransient TObjectPtr< UWidgetTree > WidgetTree The widget tree contained inside this user widget initialized by the blueprint

Constructors

  Type Name Description
Public function  

UUserWidget ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function ExtensionType * Add the extension of the requested type.
Public function UFunction BlueprintCallable, Category, Meta UUserWidgetExtension *

AddExtension ( TSubclassOf< UUserWidgetExtension > InExtensionType
)

 Add the extension of the requested type.
Public function UFunction BlueprintCallable, Category, Meta blueprintcosmetic bool

AddToPlayerScreen ( int32 ZOrder
)

 Adds the widget to the game's viewport in a section dedicated to the player.
Public function UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

AddToViewport ( int32 ZOrder
)

 Adds it to the game's viewport and fills the entire screen, unless SetDesiredSizeInViewport is called to explicitly set the size.
Public function void Add the GUID of each Namedslot widget to its corresponding binding, if any.
Public function UFunction BlueprintCallable, Category void

BindToAnimationEvent ( UWidgetAnimation* Animation,
FWidgetAnimationDynamicEvent Delegate,
EWidgetAnimationEvent AnimationEvent,
FName UserTag
)

 Allows binding to a specific animation's event.
Public function UFunction BlueprintCallable, Category void

BindToAnimationFinished ( UWidgetAnimation* Animation,
FWidgetAnimationDynamicEvent Delegate
)

 Bind an animation finished delegate.
Public function UFunction BlueprintCallable, Category void

BindToAnimationStarted ( UWidgetAnimation* Animation,
FWidgetAnimationDynamicEvent Delegate
)

 Bind an animation started delegate.
Protected function void Broadcast any events based on a state transition for the sequence player, started, finished...etc.
Public function UFunction BlueprintCallable, Category void Cancels any pending Delays or timer callbacks for this widget.
Protected function void  
Public function UFunction Category, Meta, BlueprintImplementableEvent blueprintcosmetic void Called after the underlying slate widget is constructed.
Public function Static UUserWidget *

CreateWidgetInstance ( UWidget& OwningWidget,
TSubclassOf< UUserWidget > UserWidgetClass,
FName WidgetName
)

  
Public function Static UUserWidget *

CreateWidgetInstance ( UWidgetTree& OwningWidgetTree,
TSubclassOf< UUserWidget > UserWidgetClass,
FName WidgetName
)

  
Public function Static UUserWidget *

CreateWidgetInstance ( UWorld& World,
TSubclassOf< UUserWidget > UserWidgetClass,
FName WidgetName
)

  
Public function Static UUserWidget *

CreateWidgetInstance ( UGameInstance& GameInstance,
TSubclassOf< UUserWidget > UserWidgetClass,
FName WidgetName
)

  
Public function Static UUserWidget *

CreateWidgetInstance ( APlayerController& OwnerPC,
TSubclassOf< UUserWidget > UserWidgetClass,
FName WidgetName
)

  
Public function UFunction Category, Meta, BlueprintImplementableEvent blueprintcosmetic void Called when a widget is no longer referenced causing the slate resource to destroyed.
Protected function void  
Public function void

DuplicateAndInitializeFromWidgetTree ( UWidgetTree* InWidgetTree,
const TMap< FName, UWidget* >& NamedSlotContentToMerge
)

  
Protected function void  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void Flushes all animations on all widgets to guarantee that any queued updates are processed before this call returns
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic FVector2D  
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic FAnchors  
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic float

GetAnimationCurrentTime ( const UWidgetAnimation* InAnimation
)

 Gets the current time of the animation in this widget
Public function Const const FLinearColor & Gets the tint of the widget.
Public function Const UWidget *  
Public function Const FName  
Public function Const EWidgetTickFrequency  
Public function Const ExtensionType * Find the first extension of the requested type.
Public function Const UFunction BlueprintCallable, Category, Meta UUserWidgetExtension *

GetExtension ( TSubclassOf< UUserWidgetExtension > ExtensionType
)

 Find the first extension of the requested type.
Public function Const UFunction BlueprintCallable, Category, Meta TArray< UUserWidgetExtension * >

GetExtensions ( TSubclassOf< UUserWidgetExtension > ExtensionType
)

 Find the extensions of the requested type.
Public function Const const FSlateColor & Gets the foreground color of the widget, this is inherited by sub widgets.
Protected function Const FMargin  
Public function Const int32 Gets the priority of the input action.
Public function Const UFunction BlueprintPure, Category, Meta blueprintcosmetic bool  
Protected function Const FVector2D  
Protected function UUMGSequencePlayer *  
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic APlayerCameraManager * Gets the player camera manager associated with this UI.
Public function Const T * Gets the player camera manager associated with this UI cast to the template type.
Public function Const T * Gets the player pawn associated with this UI cast to the template type.
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic APawn * Gets the player pawn associated with this UI.
Public function Const TPlayerState *

GetOwningPlayerState ( bool bChecked
)

 Get the owning player's PlayerState.
Public function Const FMargin Gets the padding for the user widget.
Public function Const const FLocalPlayerContext & Gets the player context associated with this UI.
Public function Const UWidget *  
Protected function Const UUMGSequencePlayer *

GetSequencePlayer ( const UWidgetAnimation* InAnimation
)

  
Public function Const TSharedPtr< SWidget >

GetSlateWidgetFromName ( const FName& Name
)

  
Public function Const UWidget *

GetWidgetFromName ( const FName& Name
)

  
Public function UWidget *

GetWidgetHandle ( TSharedRef< SWidget > InWidget
)

  
Public function Const UWidgetBlueprintGeneratedClass * Returns the BlueprintGeneratedClass that generated the WidgetTree.
Public function Virtual bool  
Protected function Virtual void  
Protected function void  
Protected function Virtual void The function is implemented only in nativized widgets (automatically converted from BP to c++)
Protected function void

Invalidate ( EInvalidateWidgetReason InvalidateReason
)

  
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic bool

IsAnimationPlaying ( const UWidgetAnimation* InAnimation
)

 Gets whether an animation is currently playing on this widget.
Public function UFunction BlueprintCallable, Category blueprintcosmetic bool Returns true if the animation is currently playing forward, false otherwise.
Public function Const UFunction BlueprintCallable, Category blueprintcosmetic bool  
Public function Virtual Const bool

IsAsset ()

  
Public function Virtual Const bool Is this widget an editor utility widget.
Public function Const bool Sets whether this widget to accept focus when clicked, or when navigated to.
Public function Const bool Returns whether the input action is blocking.
Public function Const UFunction Category, BlueprintImplementableEvent blueprintcosmetic bool Gets a value indicating if the widget is interactive.
Protected function Const UFunction BlueprintCallable, Category, Meta bool

IsListeningForInputAction ( FName ActionName
)

 Checks if the action has a registered callback with the input component.
Public function Const UFunction BlueprintCallable, Category bool Are we currently playing any animations?
Protected function FLinearColor  
Protected function FSlateColor  
Protected function UFunction BlueprintCallable, Category, Meta void

ListenForInputAction ( FName ActionName,
TEnumAsByte< EInputEvent > EventType,
bool bConsume,
FOnInputAction Callback
)

 Listens for a particular Player Input Action by name.
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual Const bool  
Protected function Virtual void

NativeOnAddedToFocusPath ( const FFocusEvent& InFocusEvent
)

  
Protected function Virtual FReply

NativeOnAnalogValueChanged ( const FGeometry& InGeometry,
const FAnalogInputEvent& InAnalogEvent
)

  
Protected function Virtual FCursorReply

NativeOnCursorQuery ( const FGeometry& InGeometry,
const FPointerEvent& InCursorEvent
)

  
Protected function Virtual void

NativeOnDragCancelled ( const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

  
Protected function Virtual void

NativeOnDragDetected ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent,
UDragDropOperation*& OutOperation
)

  
Protected function Virtual void

NativeOnDragEnter ( const FGeometry& InGeometry,
const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

  
Protected function Virtual void

NativeOnDragLeave ( const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

  
Protected function Virtual bool

NativeOnDragOver ( const FGeometry& InGeometry,
const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

  
Protected function Virtual bool

NativeOnDrop ( const FGeometry& InGeometry,
const FDragDropEvent& InDragDropEvent,
UDragDropOperation* InOperation
)

  
Protected function Virtual void  
Protected function Virtual void

NativeOnFocusChanging ( const FWeakWidgetPath& PreviousFocusPath,
const FWidgetPath& NewWidgetPath,
const FFocusEvent& InFocusEvent
)

  
Protected function Virtual void

NativeOnFocusLost ( const FFocusEvent& InFocusEvent
)

  
Protected function Virtual FReply

NativeOnFocusReceived ( const FGeometry& InGeometry,
const FFocusEvent& InFocusEvent
)

  
Protected function Virtual void  
Protected function Virtual FReply

NativeOnKeyChar ( const FGeometry& InGeometry,
const FCharacterEvent& InCharEvent
)

  
Protected function Virtual FReply

NativeOnKeyDown ( const FGeometry& InGeometry,
const FKeyEvent& InKeyEvent
)

  
Protected function Virtual FReply

NativeOnKeyUp ( const FGeometry& InGeometry,
const FKeyEvent& InKeyEvent
)

  
Protected function Virtual FReply

NativeOnMotionDetected ( const FGeometry& InGeometry,
const FMotionEvent& InMotionEvent
)

  
Protected function Virtual FReply

NativeOnMouseButtonDoubleClick ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual FReply

NativeOnMouseButtonDown ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual FReply

NativeOnMouseButtonUp ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual void

NativeOnMouseCaptureLost ( const FCaptureLostEvent& CaptureLostEvent
)

  
Protected function Virtual void

NativeOnMouseEnter ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual void

NativeOnMouseLeave ( const FPointerEvent& InMouseEvent
)

  
Protected function Virtual FReply

NativeOnMouseMove ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual FReply

NativeOnMouseWheel ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual FNavigationReply

NativeOnNavigation ( const FGeometry& InGeometry,
const FNavigationEvent& InNavigationEvent
)

  
Protected function Virtual FNavigationReply

NativeOnNavigation ( const FGeometry& MyGeometry,
const FNavigationEvent& InNavigationEvent,
const FNavigationReply& InDefaultReply
)

  
Protected function Virtual FReply

NativeOnPreviewKeyDown ( const FGeometry& InGeometry,
const FKeyEvent& InKeyEvent
)

  
Protected function Virtual FReply

NativeOnPreviewMouseButtonDown ( const FGeometry& InGeometry,
const FPointerEvent& InMouseEvent
)

  
Protected function Virtual void

NativeOnRemovedFromFocusPath ( const FFocusEvent& InFocusEvent
)

  
Protected function Virtual FReply

NativeOnTouchEnded ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

  
Protected function Virtual FReply

NativeOnTouchForceChanged ( const FGeometry& MyGeometry,
const FPointerEvent& TouchEvent
)

  
Protected function Virtual FReply

NativeOnTouchGesture ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

  
Protected function Virtual FReply

NativeOnTouchMoved ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

  
Protected function Virtual FReply

NativeOnTouchStarted ( const FGeometry& InGeometry,
const FPointerEvent& InGestureEvent
)

  
Protected function Virtual Const int32

NativePaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 Native implemented paint function for the Widget Returns the maximum LayerID painted on
Protected function Virtual void  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Virtual void

NativeTick ( const FGeometry& MyGeometry,
float InDeltaTime
)

  
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnAddedToFocusPath ( FFocusEvent InFocusEvent
)

 If focus is gained on on this widget or on a child widget and this widget is added to the focus path, and wasn't previously part of it, this event is called.
Public function UFunction Category, BlueprintImplementableEvent FEventReply

OnAnalogValueChanged ( FGeometry MyGeometry,
FAnalogInputEvent InAnalogInputEvent
)

 Called when an analog value changes on a button that supports analog
Protected function UFunction Category blueprintcosmetic, blueprintnativeevent void

OnAnimationFinished ( const UWidgetAnimation* Animation
)

 Called when an animation has either played all the way through or is stopped
Protected function Virtual void  
Protected function Virtual void Called when a sequence player is finished playing an animation
Protected function UFunction Category blueprintcosmetic, blueprintnativeevent void

OnAnimationStarted ( const UWidgetAnimation* Animation
)

 Called when an animation is started.
Protected function Virtual void  
Protected function Virtual void Called when a sequence player is finished playing an animation
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnDragCancelled ( const FPointerEvent& PointerEvent,
UDragDropOperation* Operation
)

 Called when the user cancels the drag operation, typically when they simply release the mouse button after beginning a drag operation, but failing to complete the drag.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnDragDetected ( FGeometry MyGeometry,
const FPointerEvent& PointerEvent,
UDragDropOperation*& Operation
)

 TODO.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnDragEnter ( FGeometry MyGeometry,
FPointerEvent PointerEvent,
UDragDropOperation* Operation
)

 Called during drag and drop when the drag enters the widget.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnDragLeave ( FPointerEvent PointerEvent,
UDragDropOperation* Operation
)

 Called during drag and drop when the drag leaves the widget.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic bool

OnDragOver ( FGeometry MyGeometry,
FPointerEvent PointerEvent,
UDragDropOperation* Operation
)

 Called during drag and drop when the the mouse is being dragged over a widget.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic bool

OnDrop ( FGeometry MyGeometry,
FPointerEvent PointerEvent,
UDragDropOperation* Operation
)

 Called when the user is dropping something onto a widget.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnFocusLost ( FFocusEvent InFocusEvent
)

 Called when this widget loses focus. This event does not bubble.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnFocusReceived ( FGeometry MyGeometry,
FFocusEvent InFocusEvent
)

 Called when keyboard focus is given to this widget. This event does not bubble.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void Called once only at game time on non-template instances.
Protected function void  
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnKeyChar ( FGeometry MyGeometry,
FCharacterEvent InCharacterEvent
)

 Called after a character is entered while this widget has focus
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnKeyDown ( FGeometry MyGeometry,
FKeyEvent InKeyEvent
)

 Called after a key (keyboard, controller, ...) is pressed when this widget has focus (this event bubbles if not handled)
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnKeyUp ( FGeometry MyGeometry,
FKeyEvent InKeyEvent
)

 Called after a key (keyboard, controller, ...) is released when this widget has focus
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnMotionDetected ( FGeometry MyGeometry,
FMotionEvent InMotionEvent
)

 Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnMouseButtonDoubleClick ( FGeometry InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnMouseButtonDown ( FGeometry MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was pressed within it.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnMouseButtonUp ( FGeometry MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was release within it.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void Called when mouse capture is lost if it was owned by this widget.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnMouseEnter ( FGeometry MyGeometry,
const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has entered it.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnMouseLeave ( const FPointerEvent& MouseEvent
)

 The system will use this event to notify a widget that the cursor has left it.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnMouseMove ( FGeometry MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnMouseWheel ( FGeometry MyGeometry,
const FPointerEvent& MouseEvent
)

 Called when the mouse wheel is spun. This event is bubbled.
Public function Const UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnPaint ( UPARAM(ref) FPaintContext& Context
)

  
Public function UFunction Category, BlueprintImplementableEvent FEventReply

OnPreviewKeyDown ( FGeometry MyGeometry,
FKeyEvent InKeyEvent
)

 Called after a key (keyboard, controller, ...) is pressed when this widget or a child of this widget has focus If a widget handles this event, OnKeyDown will not be passed to the focused widget.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnPreviewMouseButtonDown ( FGeometry MyGeometry,
const FPointerEvent& MouseEvent
)

 Just like OnMouseButtonDown, but tunnels instead of bubbling.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

OnRemovedFromFocusPath ( FFocusEvent InFocusEvent
)

 If focus is lost on on this widget or on a child widget and this widget is no longer part of the focus path.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnTouchEnded ( FGeometry MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is ended (finger lifted)
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnTouchForceChanged ( FGeometry MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad force has changed (user pressed down harder or let up)
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnTouchGesture ( FGeometry MyGeometry,
const FPointerEvent& GestureEvent
)

 Called when the user performs a gesture on trackpad. This event is bubbled.
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnTouchMoved ( FGeometry MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is moved (finger moved)
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic FEventReply

OnTouchStarted ( FGeometry MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is started (finger down)
Public function UFunction BlueprintCallable, Category blueprintcosmetic float

PauseAnimation ( const UWidgetAnimation* InAnimation
)

 Pauses an already running animation in this widget
Public function UFunction BlueprintCallable, Category blueprintcosmetic UUMGSequencePlayer *

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

 Plays an animation in this widget a specified number of times
Public function UFunction BlueprintCallable, Category blueprintcosmetic UUMGSequencePlayer *

PlayAnimationForward ( UWidgetAnimation* InAnimation,
float PlaybackSpeed,
bool bRestoreState
)

 Plays an animation on this widget relative to it's current state forward.
Public function UFunction BlueprintCallable, Category blueprintcosmetic UUMGSequencePlayer *

PlayAnimationReverse ( UWidgetAnimation* InAnimation,
float PlaybackSpeed,
bool bRestoreState
)

 Plays an animation on this widget relative to it's current state in reverse.
Public function UFunction BlueprintCallable, Category blueprintcosmetic UUMGSequencePlayer *

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

 Plays an animation in this widget a specified number of times stopping at a specified time
Public function UFunction BlueprintCallable, Category, Meta blueprintcosmetic void

PlaySound ( USoundBase* SoundToPlay
)

 Plays a sound through the UI
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

  
Public function Virtual void  
Protected function void

PostTickActionsAndAnimation ( float InDeltaTime
)

  
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

PreConstruct ( bool IsDesignTime
)

 Called by both the game and the editor.
Public function UFunction BlueprintCallable, Category blueprintcosmetic float

QueuePauseAnimation ( const UWidgetAnimation* InAnimation
)

 Pauses an already running animation in this widget
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

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

 Plays an animation in this widget a specified number of times
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

QueuePlayAnimationForward ( UWidgetAnimation* InAnimation,
float PlaybackSpeed,
bool bRestoreState
)

 Plays an animation on this widget relative to it's current state forward.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

QueuePlayAnimationReverse ( UWidgetAnimation* InAnimation,
float PlaybackSpeed,
bool bRestoreState
)

 Plays an animation on this widget relative to it's current state in reverse.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

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

 Plays an animation in this widget a specified number of times stopping at a specified time
Public function UFunction BlueprintCallable, Category void Stop All actively running animations.
Public function UFunction BlueprintCallable, Category void

QueueStopAnimation ( const UWidgetAnimation* InAnimation
)

 Stops an already running animation in this widget
Protected function UFunction BlueprintCallable, Category, Meta void ListenForInputAction will automatically Register an Input Component with the player input system.
Public function UFunction BlueprintCallable, Category void Remove the extension.
Public function void Remove all extensions of the requested type.
Public function UFunction BlueprintCallable, Category void

RemoveExtensions ( TSubclassOf< UUserWidgetExtension > InExtensionType
)

 Remove all extensions of the requested type.
Public function UFunction BlueprintCallable, Category, Meta blueprintcosmetic void Removes the widget from the viewport.
Protected function void

RemoveObsoleteBindings ( const TArray< FName >& NamedSlots
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

ReverseAnimation ( const UWidgetAnimation* InAnimation
)

 If an animation is playing, this function will reverse the playback.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetAlignmentInViewport ( FVector2D Alignment
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetAnchorsInViewport ( FAnchors Anchors
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetAnimationCurrentTime ( const UWidgetAnimation* InAnimation,
float InTime
)

 Sets the current time of the animation in this widget. Does not change state.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetColorAndOpacity ( FLinearColor InColorAndOpacity
)

 Sets the tint of the widget, this affects all child widgets.
Public function bool

SetDesiredFocusWidget ( FName WidgetName
)

 Sets the child Widget that should receive focus when this UserWidget gets focus using it's name.
Public function bool Sets the child Widget that should receive focus when this UserWidget gets focus.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetDesiredSizeInViewport ( FVector2D Size
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetForegroundColor ( FSlateColor InForegroundColor
)

 Sets the foreground color of the widget, this is inherited by sub widgets.
Protected function UFunction BlueprintCallable, Category, Meta void

SetInputActionBlocking ( bool bShouldBlock
)

  
Protected function UFunction BlueprintCallable, Category, Meta void

SetInputActionPriority ( int32 NewPriority
)

  
Public function void

SetIsFocusable ( bool InIsFocusable
)

  
Protected function void

SetMinimumDesiredSize ( FVector2D InMinimumDesiredSize
)

  
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetNumLoopsToPlay ( const UWidgetAnimation* InAnimation,
int32 NumLoopsToPlay
)

 Changes the number of loops to play given a playing animation
Public function void

SetOwningLocalPlayer ( ULocalPlayer* LocalPlayer
)

 Sets the player associated with this UI via LocalPlayer reference.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetOwningPlayer ( APlayerController* LocalPlayerController
)

 Sets the local player associated with this UI via PlayerController reference.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetPadding ( FMargin InPadding
)

 Sets the padding for the user widget, putting a larger gap between the widget border and it's root widget.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetPlaybackSpeed ( const UWidgetAnimation* InAnimation,
float PlaybackSpeed
)

 Changes the playback rate of a playing animation
Public function void

SetPlayerContext ( const FLocalPlayerContext& InPlayerContext
)

 Sets the player context associated with this UI.
Public function UFunction BlueprintCallable, Category blueprintcosmetic void

SetPositionInViewport ( FVector2D Position,
bool bRemoveDPIScale
)

 Sets the widgets position in the viewport.
Public function UFunction BlueprintCallable, Category void Stop All actively running animations.
Public function UFunction BlueprintCallable, Category void

StopAnimation ( const UWidgetAnimation* InAnimation
)

 Stops an already running animation in this widget
Public function UFunction BlueprintCallable, Category void Cancels any pending Delays or timer callbacks for this widget, and stops all active animations on the widget.
Protected function UFunction BlueprintCallable, Category, Meta void Stops listening to all input actions, and unregisters the input component with the player controller.
Protected function UFunction BlueprintCallable, Category, Meta void

StopListeningForInputAction ( FName ActionName,
TEnumAsByte< EInputEvent > EventType
)

 Removes the binding for a particular action's callback.
Protected function void  
Public function UFunction Category, BlueprintImplementableEvent blueprintcosmetic void

Tick ( FGeometry MyGeometry,
float InDeltaTime
)

 Ticks this widget. Override in derived classes, but always call the parent implementation.
Protected function void

TickActionsAndAnimation ( float InDeltaTime
)

 Ticks the active sequences and latent actions that have been scheduled for this Widget.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void

UnbindFromAnimationFinished ( UWidgetAnimation* Animation,
FWidgetAnimationDynamicEvent Delegate
)

 Unbind an animation finished delegate.
Public function UFunction BlueprintCallable, Category void

UnbindFromAnimationStarted ( UWidgetAnimation* Animation,
FWidgetAnimationDynamicEvent Delegate
)

 Unbind an animation started delegate.
Protected function UFunction BlueprintCallable, Category, Meta void StopListeningForAllInputActions will automatically Register an Input Component with the player input system.
Public function void

UpdateBindingForSlot ( FName SlotName
)

 Update the binding for this namedslot if the name is not found but GUID is matched.
Public function void  
Public function Const void

ValidateBlueprint ( const UWidgetTree& BlueprintWidgetTree,
IWidgetCompilerLog& CompileLog
)

 Final step of Widget Blueprint compilation.
Public function Virtual Const void

ValidateCompiledWidgetTree ( const UWidgetTree& BlueprintWidgetTree,
IWidgetCompilerLog& CompileLog
)

 Override to perform any custom inspections of the default widget tree at the end of compilation.

Overridden from UWidget

  Type Name Description
Public function Virtual Const T * Gets the local player associated with this UI cast to the template type.
Public function Virtual Const ULocalPlayer * Gets the local player associated with this UI.
Public function Virtual Const APlayerController * Gets the player controller associated with this UI.
Public function Virtual Const T * Gets the player controller associated with this UI cast to the template type.
Public function Virtual const FText Gets the palette category of the widget
Public function Virtual Const UWorld *  
Public function Virtual void  
Protected function Virtual void Function called after the underlying SWidget is constructed.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

  
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Sets the designer flags on the widget.
Public function Virtual void

SetVisibility ( ESlateVisibility InVisibility
)

 Sets the visibility of the widget.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Public function Virtual void  
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from INamedSlotInterface

  Type Name Description
Public function Virtual Const UWidget *

GetContentForSlot ( FName SlotName
)

 Gets the widget for a given slot by name, will return nullptr if no widget is in the slot.
Public function Virtual Const void

GetSlotNames ( TArray< FName >& SlotNames
)

 Gets the names for slots that we can store widgets into.
Public function Virtual void

SetContentForSlot ( FName SlotName,
UWidget* Content
)

 Sets the widget for a given slot by name.

Classes

  Type Name Description
Public class FNativeOnDestruct    
Public class UClass Category BlueprintAssignable FNativeOnVisibilityChangedEvent    

Constants

Name Description
bInitializingFromWidgetTree  
bTemplateInitializing  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page