MouseActuator(Actuator)

base classes — bpy_struct, Actuator

class bpy.types.MouseActuator(Actuator)
local_x

Apply rotation locally (default False)

Type:

bool

local_y

Apply rotation locally (default False)

Type:

bool

max_x

Maximum positive rotation allowed by X mouse movement (0 for infinite) (in [-inf, inf], default 0.0)

Type:

float

max_y

Maximum positive rotation allowed by Y mouse movement (0 for infinite) (in [-inf, inf], default 0.0)

Type:

float

min_x

Maximum negative rotation allowed by X mouse movement (0 for infinite) (in [-inf, inf], default 0.0)

Type:

float

min_y

Maximum negative rotation allowed by Y mouse movement (0 for infinite) (in [-inf, inf], default 0.0)

Type:

float

mode

(default 'VISIBILITY')

Type:

Literal[‘VISIBILITY’, ‘LOOK’]

object_axis_x

Local object axis mouse movement in the X direction will apply to (default 'OBJECT_AXIS_X')

Type:

Literal[‘OBJECT_AXIS_X’, ‘OBJECT_AXIS_Y’, ‘OBJECT_AXIS_Z’]

object_axis_y

Local object axis mouse movement in the Y direction will apply to (default 'OBJECT_AXIS_X')

Type:

Literal[‘OBJECT_AXIS_X’, ‘OBJECT_AXIS_Y’, ‘OBJECT_AXIS_Z’]

reset_x

Reset the cursor’s X position to the center of the screen space after calculating (default False)

Type:

bool

reset_y

Reset the cursor’s Y position to the center of the screen space after calculating (default False)

Type:

bool

sensitivity_x

Sensitivity of the X axis (in [-inf, inf], default 0.0)

Type:

float

sensitivity_y

Sensitivity of the Y axis (in [-inf, inf], default 0.0)

Type:

float

threshold_x

Amount of X motion before mouse movement will register (in [-inf, inf], default 0.0)

Type:

float

threshold_y

Amount of Y motion before mouse movement will register (in [-inf, inf], default 0.0)

Type:

float

use_axis_x

Calculate mouse movement on the X axis (default False)

Type:

bool

use_axis_y

Calculate mouse movement on the Y axis (default False)

Type:

bool

visible

Make mouse cursor visible (default False)

Type:

bool

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions