unreal.MouseCaptureMode

class unreal.MouseCaptureMode

Bases: EnumBase

EMouse Capture Mode

C++ Source:

  • Module: Engine

  • File: EngineBaseTypes.h

CAPTURE_DURING_MOUSE_DOWN: MouseCaptureMode

Capture the mouse during a mouse down, releases on mouse up

Type:

3

CAPTURE_DURING_RIGHT_MOUSE_DOWN: MouseCaptureMode

Capture only when the right mouse button is down, not any of the other mouse buttons

Type:

4

CAPTURE_PERMANENTLY: MouseCaptureMode

Capture the mouse permanently when the viewport is clicked, and consume the initial mouse down that caused the capture so it isn’t processed by player input

Type:

1

CAPTURE_PERMANENTLY_INCLUDING_INITIAL_MOUSE_DOWN: MouseCaptureMode

Capture the mouse permanently when the viewport is clicked, and allow player input to process the mouse down that caused the capture

Type:

2

NO_CAPTURE: MouseCaptureMode

Do not capture the mouse at all

Type:

0