Meta Developers

The IsdkInteractableWidget handles all the scaffolding and plumbing necessary to display a Widget Blueprint in the world and make it interactable using Interaction SDK interactions.

UI displayed using an Interactable Widget

How do Interactable Widgets work?

The IsdkInteractableWidget takes a UI built with UMG using a Widget Blueprint and displays it using a Widget Component. It also adds components for handling poke and ray interactions and pipes the events from those through to the underlying UI. This means you can interact with a native UMG UI just as you would any other interactable object built manually.

Note: Because the Interaction SDK events are passed through to the UI at a low level, you do not have access to those events in the UI itself to know what interacted with the UI or what type of interaction it was.

The Widget Component section in the properties contains settings for configuring the UI itself. You can tell it what Widget Blueprint to display, the size, and specify some additional appearance-related options. The complete list of options are explained below.

Property	Description
Draw Size	Controls the resolution the UI is rendered at.
Widget Scale	Controls the physical size of the UI in the world.
Widget Class	Specifies the Widget Blueprint asset to use for the UI.
Use Rounded Box Material	If enabled, a specialized material with rounded corners is used for the backplate of the UI.
Corner Radius	Determines the radius of the corners of the backplate when using the rounded box material.
Blend Mode	Determines the blending mode used for the backplate. Available options are: Masked (opacity is either 0.0 or 1.0), Transparent (opacity is a gradient from 0.0 to 1.0).
Two Sided	If enabled, the back side of the UI will be rendered so the UI is visible from behind.

Interactable

The Interactable section in the properties contains settings for configuring what type of interactions the UI will respond to, and, in the case of poke interactions, it provides configuration settings for determining how the interaction will behave.

Property	Description
Create Poke Interactable	If enabled, the components necessary to make the UI interactable using poke interactions are added.
Default Poke Interactable Config Asset	Specifies the Data Asset to use for the config settings.
Normal Offset	An offset added to the EnterHoverNormal, ExitHoverNormal, and CancelSelectNormal settings in the config asset.
Tangent Offset	An offset added to the EnterHoverTangent, ExitHoverTangent, and CancelSelectTangent settings in the config asset.
Create Ray Interactable	If enabled, the components necessary to make the UI interactable using ray casting are added.

Audio

You can play sounds when the user interacts with the UI using either poke or ray casting. There are two AudioComponents on the IsdkInteractableWidget:

Selected Hovered Audio - sound played when the user selects an item in the UI using ray casting.
Selected Empty Audio - sound played when the user selects an item in the UI using a poke interaction.

Learn More

To learn more about using Interactable Widgets, see the Getting Started with Interaction SDK for Unreal Engine

Did you find this page helpful?