Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/UMG/Public/Blueprint/UserWidget.h |
Include |
#include "Blueprint/UserWidget.h" |
class UUserWidget :
public UWidget,
public INamedSlotInterface
The user widget is extensible by users through the WidgetBlueprint.
Name | Description | ||
---|---|---|---|
|
ActiveSequencePlayers |
All the sequence players currently playing |
|
|
AnimationCallbacks |
||
|
TObjectPtr< UUM... |
AnimationTickManager |
|
|
uint8: 1 |
bHasScriptImplementedPaint |
If a widget has an implemented paint blueprint function |
|
uint8: 1 |
bHasScriptImplementedTick |
If a widget has an implemented tick blueprint function |
|
uint8: 1 |
bInitialized |
Has this widget been initialized by its class yet? |
|
uint8: 1 |
bIsFocusable |
Setting this flag to true, allows this widget to accept focus when clicked, or when navigated to. |
|
uint8: 1 |
bStopAction |
|
|
uint8: 1 |
bStoppingAllAnimations |
If we're stopping all animations, don't allow new animations to be created as side-effects. |
|
ColorAndOpacity |
The color and opacity of this widget. Tints all child widgets. |
|
|
FGetLinearColor |
ColorAndOpacityDelegate |
|
|
DesignSizeMode |
||
|
DesignTimeSize |
Stores the design time desired size of the user widget |
|
|
ForegroundColor |
The foreground color of the widget, this is inherited by sub widgets. |
|
|
ForegroundColorDelegate |
||
|
TObjectPtr< cla... |
InputComponent |
|
|
K2_Cache_ColorAndOpacity |
||
|
K2_Cache_ForegroundColor |
||
|
OnNativeVisibilityChanged |
||
|
OnVisibilityChanged |
Called when the visibility has changed |
|
|
Padding |
The padding area around the content. |
|
|
PaletteCategory |
The category this widget appears in the palette. |
|
|
TObjectPtr< UTe... |
PreviewBackground |
A preview background that you can use when designing the UI to get a sense of scale on the screen. |
|
Priority |
||
|
StoppedSequencePlayers |
List of sequence players to cache and clean up when safe |
|
|
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. |
|
friend |
UUMGSequenceTickManager |
|
|
TObjectPtr< UWi... |
WidgetTree |
The widget tree contained inside this user widget initialized by the blueprint |
Name | Description | |
---|---|---|
|
UUserWidget ( |
Name | Description | ||
---|---|---|---|
|
AddToPlayerScreen ( |
Adds the widget to the game's viewport in a section dedicated to the player. |
|
|
AddToScreen ( |
Adds the widget to the screen, either to the viewport or to the player's screen depending on if the LocalPlayer is null. |
|
|
AddToViewport ( |
Adds it to the game's viewport and fills the entire screen, unless SetDesiredSizeInViewport is called to explicitly set the size. |
|
|
BindToAnimationEvent ( |
Allows binding to a specific animation's event. |
|
|
BindToAnimationFinished ( |
Bind an animation finished delegate. |
|
|
BindToAnimationStarted ( |
Bind an animation started delegate. |
|
|
BroadcastAnimationStateChange ( |
Broadcast any events based on a state transition for the sequence player, started, finished...etc. |
|
|
CancelLatentActions() |
Cancels any pending Delays or timer callbacks for this widget. |
|
|
Construct() |
Called after the underlying slate widget is constructed. |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
Destruct() |
Called when a widget is no longer referenced causing the slate resource to destroyed. |
|
|
DisableAnimations() |
||
|
DuplicateAndInitializeFromWidgetTree ( |
||
|
FlushAnimations() |
Flushes all animations on all widgets to guarantee that any queued updates are processed before this call returns |
|
|
GetAlignmentInViewport() |
||
|
GetAnchorsInViewport() |
||
|
float |
GetAnimationCurrentTime ( |
Gets the current time of the animation in this widget |
|
EWidgetTickF... |
GetDesiredTickFrequency() |
|
|
GetFullScreenOffset() |
||
|
GetIsVisible() |
||
|
GetMinimumDesiredSize() |
||
|
UUMGSequence... |
GetOrAddSequencePlayer ( |
|
|
T * |
GetOwningPlayerCameraManager() |
Gets the player camera manager associated with this UI cast to the template type. |
|
APlayerCamer... |
GetOwningPlayerCameraManager() |
Gets the player camera manager associated with this UI. |
|
T * |
GetOwningPlayerPawn() |
Gets the player pawn associated with this UI cast to the template type. |
|
APawn * |
GetOwningPlayerPawn() |
Gets the player pawn associated with this UI. |
|
TPlayerState... |
GetOwningPlayerState ( |
Get the owning player's PlayerState. |
|
const FLocal... |
GetPlayerContext() |
Gets the player context associated with this UI. |
|
UWidget *... |
GetRootWidget() |
|
|
UUMGSequence... |
GetSequencePlayer ( |
|
|
TSharedPtr< ... |
GetSlateWidgetFromName ( |
|
|
UWidget *... |
GetWidgetFromName ( |
|
|
UWidget *... |
GetWidgetHandle ( |
|
|
UWidgetBluep... |
GetWidgetTreeOwningClass() |
|
|
Initialize() |
||
|
InitializeInputComponent() |
||
|
InitializeNamedSlots ( |
||
|
InitializeNativeClassData() |
The function is implemented only in nativized widgets (automatically converted from BP to c++) |
|
|
Invalidate ( |
||
|
IsAnimationPlaying ( |
Gets whether an animation is currently playing on this widget. |
|
|
IsAnimationPlayingForward ( |
Returns true if the animation is currently playing forward, false otherwise. |
|
|
IsAnyAnimationPlaying() |
||
|
IsEditorUtility() |
Is this widget an editor utility widget. |
|
|
IsInteractable() |
Gets a value indicating if the widget is interactive. |
|
|
IsInViewport() |
||
|
IsListeningForInputAction ( |
Checks if the action has a registered callback with the input component. |
|
|
IsPlayingAnimation() |
Are we currently playing any animations? |
|
|
K2_Gate_ColorAndOpacity() |
||
|
K2_Gate_ForegroundColor() |
||
|
ListenForInputAction ( |
Listens for a particular Player Input Action by name. |
|
|
NativeConstruct() |
||
|
NativeDestruct() |
||
|
NativeIsInteractable() |
||
|
NativeOnAddedToFocusPath ( |
||
|
NativeOnAnalogValueChanged ( |
||
|
NativeOnCursorQuery ( |
||
|
NativeOnDragCancelled ( |
||
|
NativeOnDragDetected ( |
||
|
NativeOnDragEnter ( |
||
|
NativeOnDragLeave ( |
||
|
NativeOnDragOver ( |
||
|
NativeOnDrop ( |
||
|
NativeOnFocusChanging ( |
||
|
NativeOnFocusLost ( |
||
|
NativeOnFocusReceived ( |
||
|
NativeOnInitialized() |
||
|
NativeOnKeyChar ( |
||
|
NativeOnKeyDown |
||
|
NativeOnKeyUp |
||
|
NativeOnMotionDetected ( |
||
|
NativeOnMouseButtonDoubleClick ( |
||
|
NativeOnMouseButtonDown ( |
||
|
NativeOnMouseButtonUp ( |
||
|
NativeOnMouseCaptureLost ( |
||
|
NativeOnMouseEnter ( |
||
|
NativeOnMouseLeave ( |
||
|
NativeOnMouseMove ( |
||
|
NativeOnMouseWheel ( |
||
|
FNavigationR... |
NativeOnNavigation ( |
|
|
FNavigationR... |
NativeOnNavigation ( |
|
|
NativeOnPreviewKeyDown |
||
|
NativeOnPreviewMouseButtonDown ( |
||
|
NativeOnRemovedFromFocusPath ( |
||
|
NativeOnTouchEnded ( |
||
|
NativeOnTouchForceChanged ( |
||
|
NativeOnTouchGesture ( |
||
|
NativeOnTouchMoved ( |
||
|
NativeOnTouchStarted ( |
||
|
NativePaint ( |
Native implemented paint function for the Widget Returns the maximum LayerID painted on |
|
|
NativePreConstruct() |
||
|
NativeSupportsCustomNavigation() |
||
|
NativeSupportsKeyboardFocus() |
||
|
NativeTick ( |
||
|
OnAddedToFocusPath ( |
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. |
|
|
OnAnalogValueChanged ( |
Called when an analog value changes on a button that supports analog |
|
|
OnAnimationFinished ( |
Called when an animation has either played all the way through or is stopped |
|
|
OnAnimationFinished_Implementation ( |
||
|
OnAnimationFinishedPlaying ( |
Called when a sequence player is finished playing an animation |
|
|
OnAnimationStarted ( |
Called when an animation is started. |
|
|
OnAnimationStarted_Implementation ( |
||
|
OnAnimationStartedPlaying ( |
Called when a sequence player is finished playing an animation |
|
|
OnDragCancelled ( |
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. |
|
|
OnDragDetected ( |
TODO. |
|
|
OnDragEnter ( |
Called during drag and drop when the drag enters the widget. |
|
|
OnDragLeave ( |
Called during drag and drop when the drag leaves the widget. |
|
|
OnDragOver ( |
Called during drag and drop when the the mouse is being dragged over a widget. |
|
|
OnDrop ( |
Called when the user is dropping something onto a widget. |
|
|
OnFocusLost ( |
Called when this widget loses focus. This event does not bubble. |
|
|
OnFocusReceived ( |
Called when keyboard focus is given to this widget. This event does not bubble. |
|
|
OnInitialized() |
Called once only at game time on non-template instances. |
|
|
OnInputAction ( |
||
|
OnKeyChar ( |
Called after a character is entered while this widget has focus |
|
|
OnKeyDown |
Called after a key (keyboard, controller, ...) is pressed when this widget has focus (this event bubbles if not handled) |
|
|
OnKeyUp |
Called after a key (keyboard, controller, ...) is released when this widget has focus |
|
|
OnLevelRemovedFromWorld |
Called when a top level widget is in the viewport and the world is potentially coming to and end. |
|
|
OnMotionDetected ( |
Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller. |
|
|
OnMouseButtonDoubleClick ( |
Called when a mouse button is double clicked. Override this in derived classes. |
|
|
OnMouseButtonDown ( |
The system calls this method to notify the widget that a mouse button was pressed within it. |
|
|
OnMouseButtonUp ( |
The system calls this method to notify the widget that a mouse button was release within it. |
|
|
OnMouseCaptureLost() |
Called when mouse capture is lost if it was owned by this widget. |
|
|
OnMouseEnter ( |
The system will use this event to notify a widget that the cursor has entered it. |
|
|
OnMouseLeave ( |
The system will use this event to notify a widget that the cursor has left it. |
|
|
OnMouseMove ( |
The system calls this method to notify the widget that a mouse moved within it. |
|
|
OnMouseWheel ( |
Called when the mouse wheel is spun. This event is bubbled. |
|
|
OnPaint ( |
||
|
OnPreviewKeyDown |
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. |
|
|
OnPreviewMouseButtonDown ( |
Just like OnMouseButtonDown, but tunnels instead of bubbling. |
|
|
OnRemovedFromFocusPath ( |
If focus is lost on on this widget or on a child widget and this widget is no longer part of the focus path. |
|
|
OnTouchEnded ( |
Called when a touchpad touch is ended (finger lifted) |
|
|
OnTouchForceChanged ( |
Called when a touchpad force has changed (user pressed down harder or let up) |
|
|
OnTouchGesture ( |
Called when the user performs a gesture on trackpad. This event is bubbled. |
|
|
OnTouchMoved ( |
Called when a touchpad touch is moved (finger moved) |
|
|
OnTouchStarted ( |
Called when a touchpad touch is started (finger down) |
|
|
float |
PauseAnimation ( |
Pauses an already running animation in this widget |
|
UUMGSequence... |
PlayAnimation ( |
Plays an animation in this widget a specified number of times |
|
UUMGSequence... |
PlayAnimationForward ( |
Plays an animation on this widget relative to it's current state forward. |
|
UUMGSequence... |
PlayAnimationReverse ( |
Plays an animation on this widget relative to it's current state in reverse. |
|
UUMGSequence... |
PlayAnimationTimeRange ( |
Plays an animation in this widget a specified number of times stopping at a specified time |
|
PlaySound ( |
Plays a sound through the UI |
|
|
PostTickActionsAndAnimation ( |
Ticks the active sequences and latent actions that have been scheduled for this Widget. |
|
|
PreConstruct ( |
Called by both the game and the editor. |
|
|
RegisterInputComponent() |
ListenForInputAction will automatically Register an Input Component with the player input system. |
|
|
RemoveFromViewport() |
Removes the widget from the viewport. |
|
|
RemoveObsoleteBindings |
||
|
ReverseAnimation ( |
If an animation is playing, this function will reverse the playback. |
|
|
SetAlignmentInViewport ( |
||
|
SetAnchorsInViewport ( |
||
|
SetAnimationCurrentTime ( |
Sets the current time of the animation in this widget. Does not change state. |
|
|
SetColorAndOpacity ( |
Sets the tint of the widget, this affects all child widgets. |
|
|
SetDesiredSizeInViewport ( |
||
|
SetForegroundColor ( |
Sets the foreground color of the widget, this is inherited by sub widgets. |
|
|
SetInputActionBlocking ( |
||
|
SetInputActionPriority ( |
||
|
SetMinimumDesiredSize ( |
||
|
SetNumLoopsToPlay ( |
Changes the number of loops to play given a playing animation |
|
|
SetOwningLocalPlayer ( |
Sets the player associated with this UI via LocalPlayer reference. |
|
|
SetOwningPlayer ( |
Sets the local player associated with this UI via PlayerController reference. |
|
|
SetPadding ( |
Sets the padding for the user widget, putting a larger gap between the widget border and it's root widget. |
|
|
SetPlaybackSpeed ( |
Changes the playback rate of a playing animation |
|
|
SetPlayerContext ( |
Sets the player context associated with this UI. |
|
|
SetPositionInViewport |
Sets the widgets position in the viewport. |
|
|
StopAllAnimations() |
Stop All actively running animations. |
|
|
StopAnimation ( |
Stops an already running animation in this widget |
|
|
StopAnimationsAndLatentActions() |
Cancels any pending Delays or timer callbacks for this widget, and stops all active animations on the widget. |
|
|
StopListeningForAllInputActions() |
Stops listening to all input actions, and unregisters the input component with the player controller. |
|
|
StopListeningForInputAction ( |
Removes the binding for a particular action's callback. |
|
|
TearDownAnimations() |
||
|
Tick ( |
Ticks this widget. Override in derived classes, but always call the parent implementation. |
|
|
TickActionsAndAnimation ( |
Ticks the active sequences and latent actions that have been scheduled for this Widget. |
|
|
UnbindAllFromAnimationFinished ( |
||
|
UnbindAllFromAnimationStarted ( |
||
|
UnbindFromAnimationFinished ( |
Unbind an animation finished delegate. |
|
|
UnbindFromAnimationStarted ( |
Unbind an animation started delegate. |
|
|
UnregisterInputComponent() |
StopListeningForAllInputActions will automatically Register an Input Component with the player input system. |
|
|
ValidateBlueprint ( |
Final step of Widget Blueprint compilation. |
|
|
ValidateCompiledWidgetTree ( |
Override to perform any custom inspections of the default widget tree at the end of compilation. |
Name | Description | ||
---|---|---|---|
|
T * |
GetOwningLocalPlayer() |
Gets the local player associated with this UI cast to the template type. |
|
ULocalPlayer... |
GetOwningLocalPlayer() |
Gets the local player associated with this UI. |
|
T * |
GetOwningPlayer() |
Gets the player controller associated with this UI cast to the template type. |
|
APlayerContr... |
GetOwningPlayer() |
Gets the player controller associated with this UI. |
|
const FText |
GetPaletteCategory() |
Gets the palette category of the widget |
|
UWorld * |
GetWorld() |
Begin UObject. |
|
OnDesignerChanged ( |
||
|
OnWidgetRebuilt() |
Function called after the underlying SWidget is constructed. |
|
|
TSharedRef< ... |
RebuildWidget() |
Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. |
|
RemoveFromParent() |
Removes the widget from its parent widget. |
|
|
SetDesignerFlags ( |
Sets the designer flags on the widget. |
|
|
SetVisibility ( |
Sets the visibility of the widget. |
|
|
SynchronizeProperties() |
Applies all properties to the native widget if possible. |
Name | Description | ||
---|---|---|---|
|
ReleaseSlateResources ( |
Name | Description | ||
---|---|---|---|
|
BeginDestroy() |
Called before destroying the object. |
|
|
IsAsset() |
Returns true if this object is considered an asset. |
|
|
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
|
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
|
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
|
PreSave ( |
Presave function. |
|
|
Serialize ( |
Handles reading, writing, and reference collecting using FArchive. |
Name | Description | ||
---|---|---|---|
|
UWidget *... |
GetContentForSlot ( |
|
|
GetSlotNames |
||
|
SetContentForSlot |
Name |
Description |
|
---|---|---|
|
FNativeOnVisibilityChangedEvent |
Name |
Description |
---|---|
bInitializingFromWidgetTree |
|
bTemplateInitializing |
Name | Description | ||
---|---|---|---|
|
uint8: 1 |
bSupportsKeyboardFocus_DEPRECATED |
Name | Description | ||
---|---|---|---|
|
Invalidate() |
You now need to provide the reason you're invalidating. |
|
|
NativeOnMouseCaptureLost() |
Please use NativeOnMouseCaptureLost(const FCaptureLostEvent& CaptureLostEvent) |
|
|
NativePaint ( |
Please override the other version of NativePaint that accepts all the parameters, not just the paint context. |
|
|
UUMGSequence... |
PlayAnimationAtTime ( |
Short lived attempt to clarify what the default PlayAnimation function does, but going to just keep the default one to make things simple by default. |
|
PreSave ( |
Use version that takes FObjectPreSaveContext instead. |