Language:
Discover
By Skill Level
By Category

UUserWidget

Choose your OS:

Inheritance Hierarchy

Syntax

class UUserWidget :
    public UWidget ,
    public INamedSlotInterface

Remarks

The user widget is extensible by users through the WidgetBlueprint.

Variables

Name Description

Public variable

TArray < UUMGSeq ...

 

ActiveSequencePlayers

All the sequence players currently playing

Public variable

uint8 : 1

 

bCookedWidgetTree

If this user widget was created using a cooked widget tree.

Public variable

uint8 : 1

 

bHasScriptImplementedPaint

If a widget has an implemented paint blueprint function

Public variable

uint8 : 1

 

bHasScriptImplementedTick

If a widget has an implemented tick blueprint function

Protected variable

uint8 : 1

 

bInitialized

Has this widget been initialized by its class yet?

Public variable

uint8 : 1

 

bIsFocusable

Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to.

Public variable

uint8 : 1

 

bStopAction

Protected variable

uint8 : 1

 

bStoppingAllAnimations

If we're stopping all animations, don't allow new animations to be created as side-effects.

Public variable

FLinearColor

 

ColorAndOpacity

The color and opacity of this widget. Tints all child widgets.

Public variable

FGetLinearColor

 

ColorAndOpacityDelegate

Public variable

EDesignPreviewS ...

 

DesignSizeMode

Public variable

FVector2D

 

DesignTimeSize

Stores the design time desired size of the user widget

Public variable

FSlateColor

 

ForegroundColor

The foreground color of the widget, this is inherited by sub widgets.

Public variable

FGetSlateColor

 

ForegroundColorDelegate

Protected variable

UInputComponent ...

 

InputComponent

Protected variable

FLinearColor

 

K2_Cache_ColorAndOpacity

Protected variable

FSlateColor

 

K2_Cache_ForegroundColor

Public variable

FMargin

 

Padding

The padding area around the content.

Public variable

FText

 

PaletteCategory

The category this widget appears in the palette.

Public variable

UTexture2D *...

 

PreviewBackground

A preview background that you can use when designing the UI to get a sense of scale on the screen.

Public variable

int32

 

Priority

Public variable

TArray < UUMGSeq ...

 

StoppedSequencePlayers

List of sequence players to cache and clean up when safe

Public variable

UWidgetTree ...

 

WidgetTree

The widget tree contained inside this user widget initialized by the blueprint

Constructors

Name Description

Public function

UUserWidget

(
    const FObjectInitializer & ObjectIn...
)

UUserWidget .

Functions

Name Description

Public function

bool

 

AddToPlayerScreen

(
    int32 ZOrder
)

Adds the widget to the game's viewport in a section dedicated to the player.

Protected function Virtual

void

 

AddToScreen

(
    ULocalPlayer * LocalPlayer,
    int32 ZOrder
)

Adds the widget to the screen, either to the viewport or to the player's screen depending on if the LocalPlayer is null.

Public function

void

 

AddToViewport

(
    int32 ZOrder
)

UNamedSlotInterface End.

Public function

void

 

CancelLatentActions()

Cancels any pending Delays or timer callbacks for this widget.

Public function

bool

 

CanInitialize()

Public function

void

 

Construct()

Called after the underlying slate widget is constructed.

Public function Static

UUserWidget ...

 

CreateWidgetInstance

(
    APlayerController & OwnerPC,
    TSubclassOf < UUserWidget > UserWidg...,
    FName WidgetName
)

Public function Static

UUserWidget ...

 

CreateWidgetInstance

(
    UGameInstance & GameInstance,
    TSubclassOf < UUserWidget > UserWidg...,
    FName WidgetName
)

Public function Static

UUserWidget ...

 

CreateWidgetInstance

(
    UWorld & World,
    TSubclassOf < UUserWidget > UserWidg...,
    FName WidgetName
)

Public function Static

UUserWidget ...

 

CreateWidgetInstance

(
    UWidgetTree & OwningWidgetTree,
    TSubclassOf < UUserWidget > UserWidg...,
    FName WidgetName
)

Public function Static

UUserWidget ...

 

CreateWidgetInstance

(
    UWidget & OwningWidget,
    TSubclassOf < UUserWidget > UserWidg...,
    FName WidgetName
)

Public function

void

 

Destruct()

Called when a widget is no longer referenced causing the slate resource to destroyed.

Public function

void

 

DuplicateAndInitializeFromWidgetTree

(
    UWidgetTree * InWidgetTree
)

Public function

FVector2D

 

GetAlignmentInViewport()

Public function

FAnchors

 

GetAnchorsInViewport()

Public function

float

 

GetAnimationCurrentTime

(
    const UWidgetAnimation * InAnim...
)

Gets the current time of the animation in this widget

the current time of the animation.

Public function

EWidgetTickF ...

 

GetDesiredTickFrequency()

Protected function

FMargin

 

GetFullScreenOffset()

Protected function

TGameInstanc...

 

GetGameInstance()

Helper function to get the game instance

a pointer to the owning game instance

Public function

bool

 

GetIsVisible()

Protected function

UUMGSequence ...

 

GetOrAddPlayer

(
    UWidgetAnimation * InAnimation
)

Public function

APawn *

 

GetOwningPlayerPawn()

Gets the player pawn associated with this UI.

Public function

T *

 

GetOwningPlayerPawn()

Gets the player pawn associated with this UI cast to the template type.

Public function

TPlayerState...

 

GetOwningPlayerState

(
    bool bChecked
)

Get the owning player's PlayerState.

const APlayerState*

Public function

const FLocal ...

 

GetPlayerContext()

Gets the player context associated with this UI.

Public function

UWidget *...

 

GetRootWidget()

The root UObject widget wrapper

Public function

TSharedPtr < ...

 

GetSlateWidgetFromName

(
    const FName & Name
)

The slate widget corresponding to a given name

Public function

UWidget *...

 

GetWidgetFromName

(
    const FName & Name
)

The uobject widget corresponding to a given name

Public function

UWidget *...

 

GetWidgetHandle

(
    TSharedRef < SWidget > InWidget
)

The UObject wrapper for a given SWidget

Protected function

UWidgetBluep ...

 

GetWidgetTreeOwningClass()

Public function Virtual

bool

 

Initialize()

Protected function Virtual

void

 

InitializeInputComponent()

Protected function

void

 

InitializeNamedSlots

(
    bool bReparentToWidgetTree
)

Protected function Virtual

void

 

InitializeNativeClassData()

The function is implemented only in nativized widgets (automatically converted from BP to c++)

Protected function

void

 

Invalidate()

Public function

bool

 

IsAnimationPlaying

(
    const UWidgetAnimation * InAnim...
)

Gets whether an animation is currently playing on this widget.

Public function

bool

 

IsAnimationPlayingForward

(
    const UWidgetAnimation * InAnim...
)

Returns true if the animation is currently playing forward, false otherwise.

Public function

bool

 

IsAnyAnimationPlaying()

True if any animation is currently playing

Public function

bool

 

IsInteractable()

Gets a value indicating if the widget is interactive.

Public function

bool

 

IsInViewport()

True if the widget was added to the viewport using AddToViewport.

Protected function

bool

 

IsListeningForInputAction

(
    FName ActionName
)

Checks if the action has a registered callback with the input component.

Public function

bool

 

IsPlayingAnimation()

Are we currently playing any animations?

Protected function

FLinearColor

 

K2_Gate_ColorAndOpacity()

Protected function

FSlateColor

 

K2_Gate_ForegroundColor()

Protected function

void

 

ListenForInputAction

(
    FName ActionName,
    TEnumAsByte < EInputEvent > EventTyp...,
    bool bConsume,
    FOnInputAction Callback
)

Listens for a particular Player Input Action by name.

Protected function Virtual

void

 

NativeConstruct()

Protected function Virtual

void

 

NativeDestruct()

Protected function Virtual

bool

 

NativeIsInteractable()

Protected function Virtual

void

 

NativeOnAddedToFocusPath

(
    const FFocusEvent & InFocusEvent
)

Protected function Virtual

FReply

 

NativeOnAnalogValueChanged

(
    const FGeometry & InGeometry,
    const FAnalogInputEvent & InAnalogE...
)

Protected function Virtual

FCursorReply

 

NativeOnCursorQuery

(
    const FGeometry & InGeometry,
    const FPointerEvent & InCursorEvent
)

Protected function Virtual

void

 

NativeOnDragCancelled

(
    const FDragDropEvent & InDragDropEv...,
    UDragDropOperation * InOperatio...
)

Protected function Virtual

void

 

NativeOnDragDetected

(
    const FGeometry & InGeometry,
    const FPointerEvent & InMouseEvent,
    UDragDropOperation *& OutOperat...
)

Protected function Virtual

void

 

NativeOnDragEnter

(
    const FGeometry & InGeometry,
    const FDragDropEvent & InDragDropEv...,
    UDragDropOperation * InOperatio...
)

Protected function Virtual

void

 

NativeOnDragLeave

(
    const FDragDropEvent & InDragDropEv...,
    UDragDropOperation * InOperatio...
)

Protected function Virtual

bool

 

NativeOnDragOver

(
    const FGeometry & InGeometry,
    const FDragDropEvent & InDragDropEv...,
    UDragDropOperation * InOperatio...
)

Protected function Virtual

bool

 

NativeOnDrop

(
    const FGeometry & InGeometry,
    const FDragDropEvent & InDragDropEv...,
    UDragDropOperation * InOperatio...
)

Protected function Virtual

void

 

NativeOnFocusChanging

(
    const FWeakWidgetPath & PreviousFoc...,
    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

 

NativeOnInitialized()

Native handling for SObjectWidget .

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

void

 

NativeOnMouseCaptureLost()

Protected function Virtual

void

 

NativeOnMouseCaptureLost

(
    const FCaptureLostEvent & CaptureLo...
)

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

FNavigationR ...

 

NativeOnNavigation

(
    const FGeometry & MyGeometry,
    const FNavigationEvent & InNavigati...,
    const FNavigationReply & InDefaultR...
)

Protected function Virtual

FNavigationR ...

 

NativeOnNavigation

(
    const FGeometry & InGeometry,
    const FNavigationEvent & InNavigati...
)

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 & InGestureEven...
)

Protected function Virtual

FReply

 

NativeOnTouchForceChanged

(
    const FGeometry & MyGeometry,
    const FPointerEvent & TouchEvent
)

Protected function Virtual

FReply

 

NativeOnTouchGesture

(
    const FGeometry & InGeometry,
    const FPointerEvent & InGestureEven...
)

Protected function Virtual

FReply

 

NativeOnTouchMoved

(
    const FGeometry & InGeometry,
    const FPointerEvent & InGestureEven...
)

Protected function Virtual

FReply

 

NativeOnTouchStarted

(
    const FGeometry & InGeometry,
    const FPointerEvent & InGestureEven...
)

Protected function Virtual

int32

 

NativePaint

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

Native implemented paint function for the Widget Returns the maximum LayerID painted on

Protected function Virtual

void

 

NativePaint

(
    FPaintContext & InContext
)

Protected function Virtual

void

 

NativePreConstruct()

Protected function Virtual

bool

 

NativeSupportsCustomNavigation()

Protected function Virtual

bool

 

NativeSupportsKeyboardFocus()

Protected function Virtual

void

 

NativeTick

(
    const FGeometry & MyGeometry,
    float InDeltaTime
)

Public function

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

FEventReply

 

OnAnalogValueChanged

(
    FGeometry MyGeometry,
    FAnalogInputEvent InAnalogInputEven...
)

Called when an analog value changes on a button that supports analog

Public function

void

 

OnAnimationFinished

(
    const UWidgetAnimation * Animat...
)

Called when an animation has either played all the way through or is stopped

Public function Virtual

void

 

OnAnimationFinished_Implementation

(
    const UWidgetAnimation * Animat...
)

Public function

void

 

OnAnimationFinishedPlaying

(
    UUMGSequencePlayer & Player
)

Called when a sequence player is finished playing an animation

Public function

void

 

OnAnimationStarted

(
    const UWidgetAnimation * Animat...
)

Called when an animation is started.

Public function Virtual

void

 

OnAnimationStarted_Implementation

(
    const UWidgetAnimation * Animat...
)

Public function

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

void

 

OnDragDetected

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

TODO.

Public function

void

 

OnDragEnter

(
    FGeometry MyGeometry,
    FPointerEvent PointerEvent,
    UDragDropOperation * Operation
)

Called during drag and drop when the drag enters the widget.

Public function

void

 

OnDragLeave

(
    FPointerEvent PointerEvent,
    UDragDropOperation * Operation
)

Called during drag and drop when the drag leaves the widget.

Public function

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

bool

 

OnDrop

(
    FGeometry MyGeometry,
    FPointerEvent PointerEvent,
    UDragDropOperation * Operation
)

Called when the user is dropping something onto a widget.

Public function

void

 

OnFocusLost

(
    FFocusEvent InFocusEvent
)

Called when this widget loses focus. This event does not bubble.

Public function

FEventReply

 

OnFocusReceived

(
    FGeometry MyGeometry,
    FFocusEvent InFocusEvent
)

Called when keyboard focus is given to this widget.

Public function

void

 

OnInitialized()

Called once only at game time on non-template instances.

Protected function

void

 

OnInputAction

(
    FOnInputAction Callback
)

Public function

FEventReply

 

OnKeyChar

(
    FGeometry MyGeometry,
    FCharacterEvent InCharacterEvent
)

Called after a character is entered while this widget has focus

Public function

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

FEventReply

 

OnKeyUp

(
    FGeometry MyGeometry,
    FKeyEvent InKeyEvent
)

Called after a key (keyboard, controller, ...) is released when this widget has focus

Protected function Virtual

void

 

OnLevelRemovedFromWorld

(
    ULevel * InLevel,
    UWorld * InWorld
)

Called when a top level widget is in the viewport and the world is potentially coming to and end.

Public function

FEventReply

 

OnMotionDetected

(
    FGeometry MyGeometry,
    FMotionEvent InMotionEvent
)

Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller.

Public function

FEventReply

 

OnMouseButtonDoubleClick

(
    FGeometry InMyGeometry,
    const FPointerEvent & InMouseEvent
)

Called when a mouse button is double clicked.

Public function

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

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

void

 

OnMouseCaptureLost()

Called when mouse capture is lost if it was owned by this widget.

Public function

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

void

 

OnMouseLeave

(
    const FPointerEvent & MouseEvent
)

The system will use this event to notify a widget that the cursor has left it.

Public function

FEventReply

 

OnMouseMove

(
    FGeometry MyGeometry,
    const FPointerEvent & MouseEvent
)

The system calls this method to notify the widget that a mouse moved within it.

Public function

FEventReply

 

OnMouseWheel

(
    FGeometry MyGeometry,
    const FPointerEvent & MouseEvent
)

Called when the mouse wheel is spun.

Public function

void

 

OnPaint

(
    FPaintContext & Context
)

Public function

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

FEventReply

 

OnPreviewMouseButtonDown

(
    FGeometry MyGeometry,
    const FPointerEvent & MouseEvent
)

Just like OnMouseButtonDown, but tunnels instead of bubbling.

Public function

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

FEventReply

 

OnTouchEnded

(
    FGeometry MyGeometry,
    const FPointerEvent & InTouchEvent
)

Called when a touchpad touch is ended (finger lifted)

Public function

FEventReply

 

OnTouchForceChanged

(
    FGeometry MyGeometry,
    const FPointerEvent & InTouchEvent
)

Called when a touchpad force has changed (user pressed down harder or let up)

Public function

FEventReply

 

OnTouchGesture

(
    FGeometry MyGeometry,
    const FPointerEvent & GestureEvent
)

Called when the user performs a gesture on trackpad.

Public function

FEventReply

 

OnTouchMoved

(
    FGeometry MyGeometry,
    const FPointerEvent & InTouchEvent
)

Called when a touchpad touch is moved (finger moved)

Public function

FEventReply

 

OnTouchStarted

(
    FGeometry MyGeometry,
    const FPointerEvent & InTouchEvent
)

Called when a touchpad touch is started (finger down)

Public function

float

 

PauseAnimation

(
    const UWidgetAnimation * InAnim...
)

Pauses an already running animation in this widget

Public function

void

 

PlayAnimation

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

Plays an animation in this widget a specified number of times

Public function

void

 

PlayAnimationTo

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

Plays an animation in this widget a specified number of times stoping at a specified time

Public function

void

 

PlaySound

(
    USoundBase * SoundToPlay
)

Plays a sound through the UI

Public function

void

 

PreConstruct

(
    bool IsDesignTime
)

Called by both the game and the editor.

Protected function

void

 

RegisterInputComponent()

ListenForInputAction will automatically Register an Input Component with the player input system.

Public function

void

 

RemoveFromViewport()

Removes the widget from the viewport.

Protected function

void

 

RemoveObsoleteBindings

(
    const TArray < FName >& NamedSlots
)

Public function

void

 

ReverseAnimation

(
    const UWidgetAnimation * InAnim...
)

If an animation is playing, this function will reverse the playback.

Public function

void

 

SetAlignmentInViewport

(
    FVector2D Alignment
)

Public function

void

 

SetAnchorsInViewport

(
    FAnchors Anchors
)

Public function

void

 

SetColorAndOpacity

(
    FLinearColor InColorAndOpacity
)

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

Public function

void

 

SetDesiredSizeInViewport

(
    FVector2D Size
)

Public function

void

 

SetForegroundColor

(
    FSlateColor InForegroundColor
)

Sets the foreground color of the widget, this is inherited by sub widgets.

Protected function

void

 

SetInputActionBlocking

(
    bool bShouldBlock
)

Protected function

void

 

SetInputActionPriority

(
    int32 NewPriority
)

Public function

void

 

SetNumLoopsToPlay

(
    const UWidgetAnimation * InAnim...,
    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

void

 

SetOwningPlayer

(
    APlayerController * LocalPlayer...
)

Sets the local player associated with this UI via PlayerController reference.

Public function

void

 

SetPadding

(
    FMargin InPadding
)

Public function

void

 

SetPlaybackSpeed

(
    const UWidgetAnimation * InAnim...,
    float PlaybackSpeed
)

Changes the playback rate of a playing animation

Public function

void

 

SetPlayerContext

(
    const FLocalPlayerContext & InPlaye...
)

Sets the player context associated with this UI.

Public function

void

 

SetPositionInViewport

(
    FVector2D Position,
    bool bRemoveDPIScale
)

Sets the widgets position in the viewport.

Protected function

bool

 

ShouldSerializeWidgetTree

(
    const ITargetPlatform * TargetP...
)

Public function

void

 

StopAllAnimations()

Stop All actively running animations.

Public function

void

 

StopAnimation

(
    const UWidgetAnimation * InAnim...
)

Stops an already running animation in this widget

Public function

void

 

StopAnimationsAndLatentActions()

Cancels any pending Delays or timer callbacks for this widget, and stops all active animations on the widget.

Protected function

void

 

StopListeningForAllInputActions()

Stops listening to all input actions, and unregisters the input component with the player controller.

Protected function

void

 

StopListeningForInputAction

(
    FName ActionName,
    TEnumAsByte < EInputEvent > EventTyp...
)

Removes the binding for a particular action's callback.

Public function

void

 

TemplateInit()

Protected function Virtual

void

 

TemplateInitInner()

Public function

void

 

Tick

(
    FGeometry MyGeometry,
    float InDeltaTime
)

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

Protected function

void

 

TickActionsAndAnimation

(
    const FGeometry & MyGeometry,
    float InDeltaTime
)

Ticks the active sequences and latent actions that have been scheduled for this Widget.

Protected function

void

 

UnregisterInputComponent()

StopListeningForAllInputActions will automatically Register an Input Component with the player input system.

Public function

void

 

ValidateBlueprint

(
    const UWidgetTree & BlueprintWidget...,
    FCompilerResultsLog & OutErrors
)

Final step of Widget Blueprint compilation.

Public function Virtual

void

 

ValidateCompiledWidgetTree

(
    const UWidgetTree & BlueprintWidget...,
    FCompilerResultsLog & OutErrors
)

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

Public function

bool

 

VerifyTemplateIntegrity

(
    TArray < FText >& OutErrors
)

Protected function

bool

 

VerifyTemplateIntegrity

(
    UUserWidget * TemplateRoot,
    TArray < FText >& OutErrors
)

Overridden from UWidget

Name Description

Public function Virtual

T *

 

GetOwningLocalPlayer()

Gets the local player associated with this UI cast to the template type.

Public function Virtual

ULocalPlayer ...

 

GetOwningLocalPlayer()

Gets the local player associated with this UI.

The owning local player.

Public function Virtual

T *

 

GetOwningPlayer()

Gets the player controller associated with this UI cast to the template type.

Public function Virtual

APlayerContr ...

 

GetOwningPlayer()

Gets the player controller associated with this UI.

The player controller that owns the UI.

Public function Virtual

const FText

 

GetPaletteCategory()

Gets the palette category of the widget

Public function Virtual

UWorld *

 

GetWorld()

UObject interface.

Public function Virtual

void

 

OnDesignerChanged

(
    const FDesignerChangedEventArgs & E...
)

Protected function Virtual

void

 

OnWidgetRebuilt()

Function called after the underlying SWidget is constructed.

Protected function Virtual

TSharedRef < ...

 

RebuildWidget()

Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Public function Virtual

void

 

RemoveFromParent()

Removes the widget from its parent widget.

Public function Virtual

void

 

SetDesignerFlags

(
    EWidgetDesignFlags::Type NewFlags
)

Sets the designer flags on the widget.

Public function Virtual

void

 

SynchronizeProperties()

Applies all properties to the native widget if possible.

Overridden from UVisual

Name Description

Public function Virtual

void

 

ReleaseSlateResources

(
    bool bReleaseChildren
)

UVisual interface.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual

bool

 

IsAsset()

Returns true if this object is considered an asset.

Public function Virtual

void

 

PostDuplicate

(
    bool bDuplicateForPIE
)

Called after duplication & serialization and before PostLoad.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent & PropertyCha...
)

UObject interface.

Public function Virtual

void

 

PostEditImport()

Called after importing property values for this object (paste, duplicate or .t3d import) Allow the object to perform any cleanup for properties which shouldn't be duplicated or are unsupported by the script serialization

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object, and immediately after any undo/redo.

Public function Virtual

void

 

PreSave

(
    const ITargetPlatform * TargetP...
)

Presave function.

Public function Virtual

void

 

Serialize

(
    FArchive & Ar
)

UObject serializer.

Overridden from INamedSlotInterface

Name Description

Public function Virtual

UWidget *...

 

GetContentForSlot

(
    FName SlotName
)

Public function Virtual

void

 

GetSlotNames

(
    TArray < FName >& SlotNames
)

UNamedSlotInterface Begin.

Public function Virtual

void

 

SetContentForSlot

(
    FName SlotName,
    UWidget * Content
)

Constants

References

Module

UMG

Header

Runtime/UMG/Public/Blueprint/UserWidget.h