MouseSensor(Sensor)

base classes — bpy_struct, Sensor

class bpy.types.MouseSensor(Sensor)

Sensor to detect mouse events

mask

Mask filter compared with object’s collision group (array of 16 items, default (False, False, False, False, False, False, False, False, False, False, False, False, False, False, False, False))

Type:

bpy_prop_array[bool]

material

Only look for objects with this material (blank = all objects) (default “”, never None)

Type:

str

mouse_event

Type of event this mouse sensor should trigger on (default 'LEFTCLICK')

Type:

Literal[‘LEFTCLICK’, ‘MIDDLECLICK’, ‘RIGHTCLICK’, ‘BUTTON4CLICK’, ‘BUTTON5CLICK’, ‘BUTTON6CLICK’, ‘BUTTON7CLICK’, ‘WHEELUP’, ‘WHEELDOWN’, ‘MOVEMENT’, ‘MOUSEOVER’, ‘MOUSEOVERANY’]

property

Only look for objects with this property (blank = all objects) (default “”, never None)

Type:

str

use_material

Toggle collision on material or property (default 'PROPERTY')

  • PROPERTY Property – Use a property for ray intersections.

  • MATERIAL Material – Use a material for ray intersections.

Type:

Literal[‘PROPERTY’, ‘MATERIAL’]

use_pulse

Moving the mouse over a different object generates a pulse (default False)

Type:

bool

use_x_ray

Toggle X-Ray option (see through objects that don’t have the property) (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