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 > FReply::LockMouseToWidget

Light Theme

Dark Theme

FReply::LockMouseToWidget

An event should return [FReply::Handled()](API\Runtime\SlateCore\Input\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.

Windows

MacOS

Linux

References

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

Syntax

FReply & LockMouseToWidget
(
TSharedRef< SWidget > InWidget
)

Remarks

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.

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

Take our survey

Dismiss