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 API Reference > Runtime > SlateCore > Input > FReply

Light Theme

Dark Theme

FReply

A Reply is something that a Slate event returns to the system to notify it about certain aspect of how an event was handled.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FReplyBase

TReplyBase

FReply

References

Module	SlateCore
Header	/Engine/Source/Runtime/SlateCore/Public/Input/Reply.h
Include	#include "Input/Reply.h"

Syntax

class FReply : public TReplyBase< FReply >

Remarks

A Reply is something that a Slate event returns to the system to notify it about certain aspect of how an event was handled. For example, a widget may handle an OnMouseDown event by asking the system to give mouse capture to a specific Widget. To do this, return FReply::CaptureMouse( NewMouseCapture ).

Constructors

No constructors are accessible with public or protected access.

Functions

	Name	Description
bool	AffectsAllUsers()	If the event replied with a request to change the user focus whether it should do it for all users or just the current UserIndex
FReply &	BeginDragDrop ( TSharedRef< FDragDropOperation > In... )	An event should return FReply::Handled().BeginDragDrop( Content ) to initiate a drag and drop operation.
FReply &	CancelFocusRequest()	An event should rarely invoke FReply::CancelFocusRequest.
FReply &	CaptureMouse ( TSharedRef< SWidget > InMouseCaptor )	An event should return a FReply::Handled().CaptureMouse( SomeWidget ) as a means of asking the system to forward all mouse events to SomeWidget
FReply &	ClearUserFocus ( EFocusCause ReasonFocusIsChanging, bool bInAllUsers )	An event should return a FReply::Handled().ClearUserFocus() to ask the system to clear user focus
FReply &	ClearUserFocus ( bool bInAllUsers )	An event should return a FReply::Handled().ClearUserFocus() to ask the system to clear user focus
FReply &	DetectDrag ( const TSharedRef< SWidget >& Detec..., FKey MouseButton )	Ask Slate to detect if a user started dragging in this widget.
FReply &	EndDragDrop()	An event should return FReply::Handled().EndDragDrop() to request that the current drag/drop operation be terminated.
TSharedPtr< ...	GetDetectDragRequest()
FKey	GetDetectDragRequestButton()
const TShare...	GetDragDropContent()
EFocusCause	GetFocusCause()	Get the reason that a focus change is being requested.
TSharedPtr< ...	GetMouseCaptor()	If the event replied with a request to capture the mouse, this returns the desired mouse captor.
TSharedPtr< ...	GetMouseLockWidget()	Returns the widget that the mouse should be locked to (if any)
TSharedPtr< ...	GetNavigationDestination()	Get the widget that is the navigation destination.
ENavigationG...	GetNavigationGenesis()	Get the genesis of the navigation.
ENavigationS...	GetNavigationSource()	Get the source of the navigation.
EUINavigatio...	GetNavigationType()	Get the navigation type (Invalid if no navigation is requested).
const TOptio...	GetRequestedMousePos()
TSharedPtr< ...	GetUserFocusRecepient()	When not nullptr, user focus has been requested to be set on the FocusRecipient.
FReply	Handled()	An event should return a FReply::Handled() to let the system know that an event was handled.
FReply &	LockMouseToWidget ( TSharedRef< SWidget > InWidget )	An event should return FReply::Handled().LockMouseToWidget( SomeWidget ) as a means of asking the system to Lock the mouse so it cannot move out of the bounds of the widget.
FReply &	PreventThrottling()	Ensures throttling for SlateUI responsiveness is not done on mouse down
FReply &	ReleaseMouseCapture()	An event should return a FReply::Handled().ReleaseMouse() to ask the system to release mouse capture
FReply &	ReleaseMouseLock()	An event should return a FReply::Handled().ReleaseMouseLock() to ask the system to release mouse lock on a widget
FReply &	SetMousePos ( const FIntPoint& NewMousePos )	An event should return FReply::Handled().SetMousePos to ask Slate to move the mouse cursor to a different location
FReply &	SetNavigation ( EUINavigation InNavigationType, const ENavigationGenesis InNavigati..., const ENavigationSource InNavigatio... )	An event should return FReply::Handled().SetNavigation( NavigationType ) as a means of asking the system to attempt a navigation
FReply &	SetNavigation ( TSharedRef< SWidget > InNavigationD..., const ENavigationGenesis InNavigati..., const ENavigationSource InNavigatio... )	An event should return FReply::Handled().SetNavigation( NavigationDestination ) as a means of asking the system to attempt a navigation to the specified destination
FReply &	SetUserFocus ( TSharedRef< SWidget > GiveMeFocus, EFocusCause ReasonFocusIsChanging, bool bInAllUsers )	An event should return FReply::Handled().SetUserFocus( SomeWidget ) as a means of asking the system to set users focus to the provided widget
bool	ShouldEndDragDrop()
bool	ShouldReleaseMouse()	True if this reply indicated that we should release mouse capture as a result of the event being handled
bool	ShouldReleaseMouseLock()	True if the reply indicated that we should release mouse lock
bool	ShouldReleaseUserFocus()	True if this reply indicated that we should release focus as a result of the event being handled
bool	ShouldSetUserFocus()	True if this reply indicated that we should set focus as a result of the event being handled
bool	ShouldThrottle()	Whether or not we should throttle on mouse down
bool	ShouldUseHighPrecisionMouse()	True if this reply indicated that we should use high precision mouse movement
FString	ToString()	Converts the reply into an string representation.
FReply	Unhandled()	An event should return a FReply::Unhandled() to let the system know that an event was unhandled.
FReply &	UseHighPrecisionMouseMovement ( TSharedRef< SWidget > InMouseCaptor )	Enables the use of high precision (raw input) mouse movement, for more accurate mouse movement without mouse ballistics