UWidgetBlueprintLibrary::GetAllWidgetsWithInterface

Find all widgets in the world with the specified interface.

Windows
MacOS
Linux

References

Module

UMG

Header

/Engine/Source/Runtime/UMG/Public/Blueprint/WidgetBlueprintLibrary.h

Include

#include "Blueprint/WidgetBlueprintLibrary.h"

Source

/Engine/Source/Runtime/UMG/Private/WidgetBlueprintLibrary.cpp

Syntax

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

Remarks

Find all widgets in the world with the specified interface. This is a slow operation, use with caution e.g. do not use every frame.

Parameters

Parameter

Description

Interface

The interface to find. Must be specified or result array will be empty.

FoundWidgets

Output array of widgets that implement the specified interface.

TopLevelOnly

Only the widgets that are direct children of the viewport will be returned.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss