1. Epic GamesDeveloper
  3. UWidgetBlueprintLibrary

UWidgetBlueprintLibrary

API > API/Runtime > API/Runtime/UMG

   
Name UWidgetBlueprintLibrary
Type class
Header File /Engine/Source/Runtime/UMG/Public/Blueprint/WidgetBlueprintLibrary.h
Include Path #include "Blueprint/WidgetBlueprintLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="WidgetLibrary"), MinimalAPI)  
class UWidgetBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UWidgetBlueprintLibrary ( const FObjectInitializer& ObjectInitializer
)

   Blueprint/WidgetBlueprintLibrary.h  

Classes

Name Remarks
FOnGameWindowCloseButtonClickedDelegate  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void CancelDragDrop()

 Cancels any current drag drop operation. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Drag and Drop"

static FEventReply CaptureJoystick ( FEventReply& Reply,
UWidget* CapturingWidget,
bool bInAllJoysticks
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DeprecatedFunction, DeprecationMessage="Use SetUserFocus() instead")
  • Category="Widget|Event Reply"

static FEventReply CaptureMouse ( FEventReply& Reply,
UWidget* CapturingWidget
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DefaultToSelf="CapturingWidget")
  • Category="Widget|Event Reply"

static FEventReply ClearUserFocus ( FEventReply& Reply,
bool bInAllUsers
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Meta=(HidePin="CapturingWidget", DefaultToSelf="CapturingWidget")
  • Category="Widget|Event Reply"

static UUserWidget * Create ( UObject* WorldContextObject,
TSubclassOf< class UUserWidget > WidgetType,
APlayerController* OwningPlayer
)

 Creates a widget Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Meta=(WorldContext="WorldContextObject", DisplayName="Create Widget", BlueprintInternalUseOnly="true")
  • Category="Widget"

static UDragDropOperation * CreateDragDropOperation ( TSubclassOf< UDragDropOperation > OperationClass
)

 Creates a new drag and drop operation that can be returned from a drag begin to inform the UI what i being dragged and dropped and what it looks like. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Drag and Drop"
  • Meta=(BlueprintInternalUseOnly="true")

static FEventReply DetectDrag ( FEventReply& Reply,
UWidget* WidgetDetectingDrag,
FKey DragKey
)

 Ask Slate to detect if a user starts dragging in this widget later. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Meta=(HidePin="WidgetDetectingDrag", DefaultToSelf="WidgetDetectingDrag")
  • Category="Widget|Drag and Drop|Event Reply"

static FEventReply DetectDragIfPressed ( const FPointerEvent& PointerEvent,
UWidget* WidgetDetectingDrag,
FKey DragKey
)

 Given the pointer event, emit the DetectDrag reply if the provided key was pressed. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Meta=(HidePin="WidgetDetectingDrag", DefaultToSelf="WidgetDetectingDrag")
  • Category="Widget|Drag and Drop|Event Reply"

static void DismissAllMenus()

 Closes any popup menu Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget|Menu"

static void DrawBox ( FPaintContext& Context,
FVector2D Position,
FVector2D Size,
USlateBrushAsset* Brush,
FLinearColor Tint
)

 Draws a box Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Painting"

static void DrawLine ( FPaintContext& Context,
FVector2D PositionA,
FVector2D PositionB,
FLinearColor Tint,
bool bAntiAlias,
float Thickness
)

 Draws a line. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Meta=(AdvancedDisplay="4")
  • Category="Painting"

static void DrawLines ( FPaintContext& Context,
const TArray< FVector2D >& Points,
FLinearColor Tint,
bool bAntiAlias,
float Thickness
)

 Draws several line segments. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Meta=(AdvancedDisplay="3")
  • Category="Painting"

static void DrawSpline ( FPaintContext& Context,
FVector2D Start,
FVector2D StartDir,
FVector2D End,
FVector2D EndDir,
FLinearColor Tint,
float Thickness
)

 Draws a hermite spline. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Meta=(AdvancedDisplay="6")
  • Category="Painting"

static void DrawText ( FPaintContext& Context,
const FString& InString,
FVector2D Position,
FLinearColor Tint
)

 Draws text. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Painting"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use Draw Text instead", DisplayName="Draw String")

static void DrawTextFormatted ( FPaintContext& Context,
const FText& Text,
FVector2D Position,
UFont* Font,
float FontSize,
FName FontTypeFace,
FLinearColor Tint
)

 Draws text. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Painting"
  • Meta=(DisplayName="Draw Text")

static FEventReply EndDragDrop ( FEventReply& Reply
)

 An event should return FReply::Handled().EndDragDrop() to request that the current drag/drop operation be terminated. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Drag and Drop|Event Reply"

static void GetAllWidgetsOfClass ( const UObject* WorldContextObject,
TArray< UUserWidget* >& FoundWidgets,
TSubclassOf< UUserWidget > WidgetClass,
bool TopLevelOnly
)

 Find all widgets of a certain class. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget"
  • Meta=(WorldContext="WorldContextObject", DeterminesOutputType="WidgetClass", DynamicOutputParam="FoundWidgets")

static void GetAllWidgetsWithInterface ( const UObject* WorldContextObject,
TArray< UUserWidget* >& FoundWidgets,
TSubclassOf< UInterface > Interface,
bool TopLevelOnly
)

 Find all widgets in the world with the specified interface. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget"
  • Meta=(WorldContext="WorldContextObject", DeterminesOutputType="WidgetClass", DynamicOutputParam="FoundWidgets")

static UObject * GetBrushResource ( const FSlateBrush& Brush
)

 Gets the resource object on a brush. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static UMaterialInterface * GetBrushResourceAsMaterial ( const FSlateBrush& Brush
)

 Gets the brush resource as a material. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static UTexture2D * GetBrushResourceAsTexture2D ( const FSlateBrush& Brush
)

 Gets the brush resource as a texture 2D. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static UDragDropOperation * GetDragDroppingContent()

 Returns the drag and drop operation that is currently occurring if any, otherwise nothing. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Widget|Drag and Drop"
Gets the material that allows changes to parameters at runtime. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static FInputEvent GetInputEventFromCharacterEvent ( const FCharacterEvent& Event
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget"
  • Meta=(CompactNodeTitle="->", BlueprintAutocast)

static FInputEvent GetInputEventFromKeyEvent ( const FKeyEvent& Event
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget"
  • Meta=(CompactNodeTitle="->", BlueprintAutocast)

static FInputEvent GetInputEventFromNavigationEvent ( const FNavigationEvent& Event
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget"
  • Meta=(CompactNodeTitle="->", BlueprintAutocast)

static FInputEvent GetInputEventFromPointerEvent ( const FPointerEvent& Event
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget"
  • Meta=(CompactNodeTitle="->", BlueprintAutocast)

static FKeyEvent GetKeyEventFromAnalogInputEvent ( const FAnalogInputEvent& Event
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget"
  • Meta=(CompactNodeTitle="->", BlueprintAutocast)

static void GetSafeZonePadding ( const UObject* WorldContextObject,
FVector4& SafePadding,
FVector2D& SafePaddingScale,
FVector4& SpillOverPadding
)

 Gets the amount of padding that needs to be added when accounting for the safe zone on TVs. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Safe Zone"
  • Meta=(WorldContext="WorldContextObject")

static FEventReply Handled ()

 The event reply to use when you choose to handle an event. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Event Reply"

static bool IsDragDropping()

 Returns true if a drag/drop event is occurring that a widget can handle. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • BlueprintCosmetic
  • Category="Widget|Drag and Drop"

static FEventReply LockMouse ( FEventReply& Reply,
UWidget* CapturingWidget
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Event Reply"
  • Meta=(HidePin="CapturingWidget", DefaultToSelf="CapturingWidget")

static FSlateBrush MakeBrushFromAsset ( USlateBrushAsset* BrushAsset
)

 Creates a Slate Brush from a Slate Brush Asset Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static FSlateBrush MakeBrushFromMaterial ( UMaterialInterface* Material,
int32 Width,
int32 Height
)

 Creates a Slate Brush from a Material. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static FSlateBrush MakeBrushFromTexture ( UTexture2D* Texture,
int32 Width,
int32 Height
)

 Creates a Slate Brush from a Texture2D Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static FSlateBrush NoResourceBrush()

 Creates a Slate Brush that wont draw anything, the "Null Brush". Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Brush"

static FEventReply ReleaseJoystickCapture ( FEventReply& Reply,
bool bInAllJoysticks
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Meta=(DeprecatedFunction, DeprecationMessage="Use ClearUserFocus() instead")
  • Category="Widget|Event Reply"

static FEventReply ReleaseMouseCapture ( FEventReply& Reply
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Event Reply"

static void RestorePreviousWindowTitleBarState()

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Window Title Bar"

static void SetBrushResourceToMaterial ( FSlateBrush& Brush,
UMaterialInterface* Material
)

 Sets the resource on a brush to be a Material. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Brush"

static void SetBrushResourceToTexture ( FSlateBrush& Brush,
UTexture2D* Texture
)

 Sets the resource on a brush to be a UTexture2D. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Brush"

static void SetColorVisionDeficiencyType ( EColorVisionDeficiency Type,
float Severity,
bool CorrectDeficiency,
bool ShowCorrectionWithDeficiency
)

 Apply color deficiency correction settings to the game window Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Widget|Accessibility"
  • Meta=(AdvancedDisplay="3")

static void SetFocusToGameViewport()

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Focus"

static bool SetHardwareCursor ( const UObject* WorldContextObject,
EMouseCursor::Type CursorShape,
FName CursorName,
FVector2D HotSpot
)

 Loads or sets a hardware cursor from the content directory in the game. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Hardware Cursor"
  • Meta=(WorldContext="WorldContextObject")

static void SetInputMode_GameAndUIEx ( APlayerController* PlayerController,
UWidget* InWidgetToFocus,
EMouseLockMode InMouseLockMode,
bool bHideCursorDuringCapture,
const bool bFlushInput
)

 Setup an input mode that allows only the UI to respond to user input, and if the UI doesn't handle it player input / player controller gets a chance. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Input"
  • Meta=(DisplayName="Set Input Mode Game And UI")

static void SetInputMode_GameOnly ( APlayerController* PlayerController,
const bool bFlushInput
)

 Setup an input mode that allows only player input / player controller to respond to user input. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Input"

static void SetInputMode_UIOnlyEx ( APlayerController* PlayerController,
UWidget* InWidgetToFocus,
EMouseLockMode InMouseLockMode,
const bool bFlushInput
)

 Setup an input mode that allows only the UI to respond to user input. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • BlueprintCosmetic
  • Category="Input"
  • Meta=(DisplayName="Set Input Mode UI Only")

static FEventReply SetMousePosition ( FEventReply& Reply,
FVector2D NewMousePosition
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Event Reply"

static FEventReply SetUserFocus ( FEventReply& Reply,
UWidget* FocusWidget,
bool bInAllUsers
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Meta=(HidePin="CapturingWidget", DefaultToSelf="CapturingWidget")
  • Category="Widget|Event Reply"

static void SetWindowTitleBarCloseButtonActive ( bool bActive
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Window Title Bar"

static void SetWindowTitleBarOnCloseClickedDelegate ( FOnGameWindowCloseButtonClickedDelegate Delegate
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Window Title Bar"

static void SetWindowTitleBarState ( UWidget* TitleBarContent,
EWindowTitleBarMode Mode,
bool bTitleBarDragEnabled,
bool bWindowButtonsVisible,
bool bTitleBarVisible
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintCallable
  • Category="Widget|Window Title Bar"

static FEventReply Unhandled()

 The event reply to use when you choose not to handle an event. Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Event Reply"

static FEventReply UnlockMouse ( FEventReply& Reply
)

   Blueprint/WidgetBlueprintLibrary.h
  • BlueprintPure
  • Category="Widget|Event Reply"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page