Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine Blueprint API Reference > Interaction

Light Theme

Dark Theme

Interaction

Interaction

Windows

MacOS

Linux

On this page

Actions
Categories

Actions

Get 2DHit Location	Gets the last hit location on the widget in 2D, local pixel units of the render target. Target is Widget Interaction Component
Get Hovered Widget Component	Get the currently hovered widget component. Target is Widget Interaction Component
Get Last Hit Result	Gets the last hit result generated by the component. Returns the custom hit result if that was set. Target is Widget Interaction Component
Is Over Focusable Widget	Returns true if a widget under the hit result is focusable. e.g. Slate widgets that return true for SupportsKeyboardFocus(). Target is Widget Interaction Component
Is Over Hit Test Visible Widget	Returns true if a widget under the hit result is has a visibility that makes it hit test e.g. Slate widgets that return true for GetVisibility().IsHitTestVisible(). Target is Widget Interaction Component
Is Over Interactable Widget	Returns true if a widget under the hit result is interactive. e.g. Slate widgets that return true for IsInteractable(). Target is Widget Interaction Component
Press and Release Key	Does both the press and release of a simulated keyboard key. Target is Widget Interaction Component
Press Key	Press a key as if it had come from the keyboard. Avoid using this for 'a-z\|A-Z', things like the Editable Textbox in Slate expect OnKeyChar to be called to signal a specific character being send to the widget. So for those cases you should use SendKeyChar. Target is Widget Interaction Component
Press Pointer Key	Presses a key as if the mouse/pointer were the source of it. Normally you would just use Left/Right mouse button for the Key. However - advanced uses could also be imagined where you send other keys to signal widgets to take special actions if they're under the cursor. Target is Widget Interaction Component
Release Key	Releases a key as if it had been released by the keyboard. Target is Widget Interaction Component
Release Pointer Key	Releases a key as if the mouse/pointer were the source of it. Normally you would just use Left/Right mouse button for the Key. However - advanced uses could also be imagined where you send other keys to signal widgets to take special actions if they're under the cursor. Target is Widget Interaction Component
Scroll Wheel	Sends a scroll wheel event to the widget under the last hit result. Target is Widget Interaction Component
Send Key Char	Transmits a list of characters to a widget by simulating a OnKeyChar event for each key listed in the string. Target is Widget Interaction Component
Set Custom Hit Result	Set custom hit result. This is only taken into account if InteractionSource is set to EWidgetInteractionSource::Custom. Target is Widget Interaction Component
Set Focus	Set the focus target of the virtual user managed by this component Target is Widget Interaction Component

Categories

Event

Event

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

Take our survey

Dismiss