unreal.MouseInputDeviceState

class unreal.MouseInputDeviceState(left: DeviceButtonState = Ellipsis, middle: DeviceButtonState = Ellipsis, right: DeviceButtonState = Ellipsis, wheel_delta: float = 0.0, position2d: Vector2D = Ellipsis, delta2d: Vector2D = Ellipsis, world_ray: Ray = Ellipsis)

Bases: StructBase

Current State of a physical Mouse device at a point in time.

C++ Source:

  • Module: InteractiveToolsFramework

  • File: InputState.h

Editor Properties: (see get_editor_property/set_editor_property)

  • delta2d (Vector2D): [Read-Write] Change in 2D mouse position from last state event

  • left (DeviceButtonState): [Read-Write] State of the left mouse button

  • middle (DeviceButtonState): [Read-Write] State of the middle mouse button

  • position2d (Vector2D): [Read-Write] Current 2D position of the mouse, in application-defined coordinate system

  • right (DeviceButtonState): [Read-Write] State of the right mouse button

  • wheel_delta (float): [Read-Write] Change in ‘ticks’ of the mouse wheel since last state event

  • world_ray (Ray): [Read-Write] Ray into current 3D scene at current 2D mouse position

property delta2d: Vector2D

[Read-Write] Change in 2D mouse position from last state event

Type:

(Vector2D)

property left: DeviceButtonState

[Read-Write] State of the left mouse button

Type:

(DeviceButtonState)

property middle: DeviceButtonState

[Read-Write] State of the middle mouse button

Type:

(DeviceButtonState)

property position2d: Vector2D

[Read-Write] Current 2D position of the mouse, in application-defined coordinate system

Type:

(Vector2D)

property right: DeviceButtonState

[Read-Write] State of the right mouse button

Type:

(DeviceButtonState)

property wheel_delta: float

[Read-Write] Change in ‘ticks’ of the mouse wheel since last state event

Type:

(float)

property world_ray: Ray

[Read-Write] Ray into current 3D scene at current 2D mouse position

Type:

(Ray)