Module |
|
Header |
/Engine/Source/Runtime/UMG/Public/Blueprint/UserWidget.h |
Include |
#include "Blueprint/UserWidget.h" |
class UUserWidget :
public UWidget,
public INamedSlotInterface
A widget that enables UI extensibility through 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 |
|
ColorAndOpacityDelegate |
||
|
EDesignPreviewS... |
DesignSizeMode |
|
|
FVector2D |
DesignTimeSize |
Stores the design time desired size of the user widget |
|
ForegroundColorDelegate |
||
|
TObjectPtr< cla... |
InputComponent |
|
|
K2_Cache_ColorAndOpacity |
||
|
K2_Cache_ForegroundColor |
||
|
OnNativeVisibilityChanged |
||
|
OnVisibilityChanged |
Called when the visibility has changed |
|
|
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. |
|
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 | ||
---|---|---|---|
|
ExtensionTyp... |
AddExtension() |
Add the extension of the requested type. |
|
UUserWidgetE... |
AddExtension ( |
Add the extension of the requested type. |
|
bool |
AddToPlayerScreen ( |
Adds the widget to the game's viewport in a section dedicated to the player. |
|
void |
AddToViewport ( |
Adds it to the game's viewport and fills the entire screen, unless SetDesiredSizeInViewport is called to explicitly set the size. |
|
void |
AssignGUIDToBindings() |
Add the GUID of each Namedslot widget to its corresponding binding, if any. |
|
void |
BindToAnimationEvent ( |
Allows binding to a specific animation's event. |
|
void |
BindToAnimationFinished ( |
Bind an animation finished delegate. |
|
void |
BindToAnimationStarted ( |
Bind an animation started delegate. |
|
void |
BroadcastAnimationStateChange ( |
Broadcast any events based on a state transition for the sequence player, started, finished...etc. |
|
void |
CancelLatentActions() |
Cancels any pending Delays or timer callbacks for this widget. |
|
void |
ConditionalTearDownAnimations() |
|
|
void |
Construct() |
Called after the underlying slate widget is constructed. |
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
UUserWidget ... |
CreateWidgetInstance ( |
|
|
void |
Destruct() |
Called when a widget is no longer referenced causing the slate resource to destroyed. |
|
void |
DisableAnimations() |
|
|
void |
DuplicateAndInitializeFromWidgetTree ( |
|
|
void |
FlushAnimations() |
Flushes all animations on all widgets to guarantee that any queued updates are processed before this call returns |
|
FVector2D |
GetAlignmentInViewport() |
|
|
GetAnchorsInViewport() |
||
|
float |
GetAnimationCurrentTime ( |
Gets the current time of the animation in this widget |
|
const FLinea... |
GetColorAndOpacity() |
Gets the tint of the widget. |
|
UWidget *... |
GetDesiredFocusWidget() |
|
|
GetDesiredFocusWidgetName() |
||
|
EWidgetTickF... |
GetDesiredTickFrequency() |
|
|
ExtensionTyp... |
GetExtension() |
Find the first extension of the requested type. |
|
UUserWidgetE... |
GetExtension ( |
Find the first extension of the requested type. |
|
GetExtensions ( |
Find the extensions of the requested type. |
|
|
const FSlate... |
GetForegroundColor() |
Gets the foreground color of the widget, this is inherited by sub widgets. |
|
int32 |
GetInputActionPriority() |
Gets the priority of the input action. |
|
FVector2D |
GetMinimumDesiredSize() |
|
|
UUMGSequence... |
GetOrAddSequencePlayer ( |
|
|
APlayerCamer... |
GetOwningPlayerCameraManager() |
Gets the player camera manager associated with this UI. |
|
T * |
GetOwningPlayerCameraManager() |
Gets the player camera manager associated with this UI cast to the template type. |
|
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. |
|
GetPadding() |
Gets the padding for the user widget. |
|
|
const FLocal... |
GetPlayerContext() |
Gets the player context associated with this UI. |
|
UWidget *... |
GetRootWidget() |
|
|
UUMGSequence... |
GetSequencePlayer ( |
|
|
TSharedPtr< ... |
GetSlateWidgetFromName ( |
|
|
UWidget *... |
GetWidgetFromName ( |
|
|
UWidget *... |
GetWidgetHandle ( |
|
|
UWidgetBluep... |
GetWidgetTreeOwningClass() |
Returns the BlueprintGeneratedClass that generated the WidgetTree. |
|
bool |
Initialize() |
|
|
void |
InitializeInputComponent() |
|
|
void |
InitializeNamedSlots() |
|
|
void |
InitializeNativeClassData() |
The function is implemented only in nativized widgets (automatically converted from BP to c++) |
|
void |
Invalidate ( |
|
|
bool |
IsAnimationPlaying ( |
Gets whether an animation is currently playing on this widget. |
|
bool |
IsAnimationPlayingForward ( |
Returns true if the animation is currently playing forward, false otherwise. |
|
bool |
IsAnyAnimationPlaying() |
|
|
bool |
IsEditorUtility() |
Is this widget an editor utility widget. |
|
bool |
IsFocusable() |
Sets whether this widget to accept focus when clicked, or when navigated to. |
|
bool |
IsInputActionBlocking() |
Returns whether the input action is blocking. |
|
bool |
IsInteractable() |
Gets a value indicating if the widget is interactive. |
|
bool |
IsListeningForInputAction ( |
Checks if the action has a registered callback with the input component. |
|
bool |
IsPlayingAnimation() |
Are we currently playing any animations? |
|
K2_Gate_ColorAndOpacity() |
||
|
K2_Gate_ForegroundColor() |
||
|
void |
ListenForInputAction ( |
Listens for a particular Player Input Action by name. |
|
void |
NativeConstruct() |
|
|
void |
NativeDestruct() |
|
|
bool |
NativeIsInteractable() |
|
|
void |
NativeOnAddedToFocusPath ( |
|
|
NativeOnAnalogValueChanged ( |
||
|
NativeOnCursorQuery ( |
||
|
void |
NativeOnDragCancelled ( |
|
|
void |
NativeOnDragDetected ( |
|
|
void |
NativeOnDragEnter ( |
|
|
void |
NativeOnDragLeave ( |
|
|
bool |
NativeOnDragOver ( |
|
|
bool |
NativeOnDrop ( |
|
|
void |
NativeOnFocusChanging ( |
|
|
void |
NativeOnFocusLost ( |
|
|
NativeOnFocusReceived ( |
||
|
void |
NativeOnInitialized() |
|
|
NativeOnKeyChar ( |
||
|
NativeOnKeyDown |
||
|
NativeOnKeyUp |
||
|
NativeOnMotionDetected ( |
||
|
NativeOnMouseButtonDoubleClick ( |
||
|
NativeOnMouseButtonDown ( |
||
|
NativeOnMouseButtonUp ( |
||
|
void |
NativeOnMouseCaptureLost ( |
|
|
void |
NativeOnMouseEnter ( |
|
|
void |
NativeOnMouseLeave ( |
|
|
NativeOnMouseMove ( |
||
|
NativeOnMouseWheel ( |
||
|
FNavigationR... |
NativeOnNavigation ( |
|
|
FNavigationR... |
NativeOnNavigation ( |
|
|
NativeOnPreviewKeyDown |
||
|
NativeOnPreviewMouseButtonDown ( |
||
|
void |
NativeOnRemovedFromFocusPath ( |
|
|
NativeOnTouchEnded ( |
||
|
NativeOnTouchForceChanged ( |
||
|
NativeOnTouchGesture ( |
||
|
NativeOnTouchMoved ( |
||
|
NativeOnTouchStarted ( |
||
|
int32 |
NativePaint ( |
Native implemented paint function for the Widget Returns the maximum LayerID painted on |
|
void |
NativePreConstruct() |
|
|
bool |
NativeSupportsCustomNavigation() |
|
|
bool |
NativeSupportsKeyboardFocus() |
|
|
void |
NativeTick ( |
|
|
void |
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 |
|
|
void |
OnAnimationFinished ( |
Called when an animation has either played all the way through or is stopped |
|
void |
OnAnimationFinished_Implementation ( |
|
|
void |
OnAnimationFinishedPlaying ( |
Called when a sequence player is finished playing an animation |
|
void |
OnAnimationStarted ( |
Called when an animation is started. |
|
void |
OnAnimationStarted_Implementation ( |
|
|
void |
OnAnimationStartedPlaying ( |
Called when a sequence player is finished playing an animation |
|
void |
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. |
|
void |
OnDragDetected ( |
TODO. |
|
void |
OnDragEnter ( |
Called during drag and drop when the drag enters the widget. |
|
void |
OnDragLeave ( |
Called during drag and drop when the drag leaves the widget. |
|
bool |
OnDragOver ( |
Called during drag and drop when the the mouse is being dragged over a widget. |
|
bool |
OnDrop ( |
Called when the user is dropping something onto a widget. |
|
void |
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. |
|
|
void |
OnInitialized() |
Called once only at game time on non-template instances. |
|
void |
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 |
|
|
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. |
|
|
void |
OnMouseCaptureLost() |
Called when mouse capture is lost if it was owned by this widget. |
|
void |
OnMouseEnter ( |
The system will use this event to notify a widget that the cursor has entered it. |
|
void |
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. |
|
|
void |
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. |
|
|
void |
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 |
|
void |
PlaySound ( |
Plays a sound through the UI |
|
void |
PostTickActionsAndAnimation ( |
Ticks the active sequences and latent actions that have been scheduled for this Widget. |
|
void |
PreConstruct ( |
Called by both the game and the editor. |
|
void |
RegisterInputComponent() |
ListenForInputAction will automatically Register an Input Component with the player input system. |
|
void |
RemoveExtension ( |
Remove the extension. |
|
void |
RemoveExtensions() |
Remove all extensions of the requested type. |
|
void |
RemoveExtensions ( |
Remove all extensions of the requested type. |
|
void |
RemoveObsoleteBindings |
|
|
void |
ReverseAnimation ( |
If an animation is playing, this function will reverse the playback. |
|
void |
SetAlignmentInViewport ( |
|
|
void |
SetAnchorsInViewport ( |
|
|
void |
SetAnimationCurrentTime ( |
Sets the current time of the animation in this widget. Does not change state. |
|
void |
SetColorAndOpacity ( |
Sets the tint of the widget, this affects all child widgets. |
|
bool |
SetDesiredFocusWidget ( |
Sets the child Widget that should receive focus when this UserWidget gets focus using it's name. |
|
bool |
SetDesiredFocusWidget ( |
Sets the child Widget that should receive focus when this UserWidget gets focus. |
|
void |
SetDesiredSizeInViewport ( |
|
|
void |
SetForegroundColor ( |
Sets the foreground color of the widget, this is inherited by sub widgets. |
|
void |
SetInputActionBlocking ( |
|
|
void |
SetInputActionPriority ( |
|
|
void |
SetIsFocusable ( |
|
|
void |
SetMinimumDesiredSize ( |
|
|
void |
SetNumLoopsToPlay ( |
Changes the number of loops to play given a playing animation |
|
void |
SetOwningLocalPlayer ( |
Sets the player associated with this UI via LocalPlayer reference. |
|
void |
SetOwningPlayer ( |
Sets the local player associated with this UI via PlayerController reference. |
|
void |
SetPadding ( |
Sets the padding for the user widget, putting a larger gap between the widget border and it's root widget. |
|
void |
SetPlaybackSpeed ( |
Changes the playback rate of a playing animation |
|
void |
SetPlayerContext ( |
Sets the player context associated with this UI. |
|
void |
SetPositionInViewport ( |
Sets the widgets position in the viewport. |
|
void |
StopAllAnimations() |
Stop All actively running animations. |
|
void |
StopAnimation ( |
Stops an already running animation in this widget |
|
void |
StopAnimationsAndLatentActions() |
Cancels any pending Delays or timer callbacks for this widget, and stops all active animations on the widget. |
|
void |
StopListeningForAllInputActions() |
Stops listening to all input actions, and unregisters the input component with the player controller. |
|
void |
StopListeningForInputAction ( |
Removes the binding for a particular action's callback. |
|
void |
TearDownAnimations() |
|
|
void |
Tick ( |
Ticks this widget. Override in derived classes, but always call the parent implementation. |
|
void |
TickActionsAndAnimation ( |
Ticks the active sequences and latent actions that have been scheduled for this Widget. |
|
void |
UnbindAllFromAnimationFinished ( |
|
|
void |
UnbindAllFromAnimationStarted ( |
|
|
void |
UnbindFromAnimationFinished ( |
Unbind an animation finished delegate. |
|
void |
UnbindFromAnimationStarted ( |
Unbind an animation started delegate. |
|
void |
UnregisterInputComponent() |
StopListeningForAllInputActions will automatically Register an Input Component with the player input system. |
|
void |
UpdateBindingForSlot ( |
Update the binding for this namedslot if the name is not found but GUID is matched. |
|
void |
UpdateCanTick() |
|
|
void |
ValidateBlueprint ( |
Final step of Widget Blueprint compilation. |
|
void |
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. |
|
APlayerContr... |
GetOwningPlayer() |
Gets the player controller associated with this UI. |
|
T * |
GetOwningPlayer() |
Gets the player controller associated with this UI cast to the template type. |
|
const FText |
GetPaletteCategory() |
Gets the palette category of the widget |
|
UWorld * |
GetWorld() |
|
|
void |
OnDesignerChanged ( |
|
|
void |
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. |
|
void |
SetDesignerFlags ( |
Sets the designer flags on the widget. |
|
void |
SetVisibility ( |
Sets the visibility of the widget. |
|
void |
SynchronizeProperties() |
Applies all properties to the native widget if possible. |
Name | Description | ||
---|---|---|---|
|
void |
ReleaseSlateResources ( |
Name | Description | ||
---|---|---|---|
|
void |
BeginDestroy() |
Called before destroying the object. |
|
bool |
IsAsset() |
Returns true if this object is considered an asset. |
|
void |
PostDuplicate ( |
Called after duplication & serialization and before PostLoad. |
|
void |
PostEditChangeProperty ( |
Called when a property on this object has been modified externally |
|
void |
PostLoad() |
Do any object-specific cleanup required immediately after loading an object. |
|
void |
PreSave ( |
Presave function. |
Name | Description | ||
---|---|---|---|
|
UWidget *... |
GetContentForSlot ( |
Gets the widget for a given slot by name, will return nullptr if no widget is in the slot. |
|
void |
GetSlotNames |
Gets the names for slots that we can store widgets into. |
|
void |
SetContentForSlot |
Sets the widget for a given slot by name. |
Name |
Description |
|
---|---|---|
|
FNativeOnVisibilityChangedEvent |
Name |
Description |
---|---|
bInitializingFromWidgetTree |
|
bTemplateInitializing |
Name | Description | ||
---|---|---|---|
|
uint8: 1 |
bIsFocusable |
Direct access to bIsFocusable is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime. |
|
uint8: 1 |
bStopAction |
Direct access to bStopAction is deprecated. Please use the getter or setter. |
|
ColorAndOpacity |
Direct access to ColorAndOpacity is deprecated. Please use the getter or setter. |
|
|
ForegroundColor |
Direct access to ForegroundColor is deprecated. Please use the getter or setter. |
|
|
Padding |
Direct access to Padding is deprecated. Please use the getter or setter. |
|
|
int32 |
Priority |
Direct access to Priority is deprecated. Please use the getter or setter. |
Name | Description | ||
---|---|---|---|
|
GetFullScreenOffset() |
GetFullScreenOffset is deprecated. Use the GameViewportSubsystem. |
|
|
bool |
GetIsVisible() |
GetIsVisible is deprecated. Please use IsInViewport instead. |
|
void |
RemoveFromViewport() |
RemoveFromViewport is deprecated. Use RemoveFromParent instead. |