Macro(bpy_struct)

base class — bpy_struct

class bpy.types.Macro(bpy_struct)

Storage of a macro operator being executed, or registered after execution

bl_cursor_pending

Cursor to use when waiting for the user to select a location to activate the operator (when bl_options has DEPENDS_ON_CURSOR set)

Type

enum in [‘DEFAULT’, ‘NONE’, ‘WAIT’, ‘CROSSHAIR’, ‘MOVE_X’, ‘MOVE_Y’, ‘KNIFE’, ‘TEXT’, ‘PAINT_BRUSH’, ‘PAINT_CROSS’, ‘DOT’, ‘ERASER’, ‘HAND’, ‘SCROLL_X’, ‘SCROLL_Y’, ‘SCROLL_XY’, ‘EYEDROPPER’, ‘PICK_AREA’, ‘STOP’, ‘COPY’, ‘CROSS’, ‘MUTE’, ‘ZOOM_IN’, ‘ZOOM_OUT’], default ‘DEFAULT’

bl_description
Type

string, default “”, (never None)

bl_idname
Type

string, default “”, (never None)

bl_label
Type

string, default “”, (never None)

bl_options

Options for this operator type

  • REGISTER Register – Display in the info window and support the redo toolbar panel.

  • UNDO Undo – Push an undo event (needed for operator redo).

  • UNDO_GROUPED Grouped Undo – Push a single undo event for repeated instances of this operator.

  • BLOCKING Blocking – Block anything else from using the cursor.

  • MACRO Macro – Use to check if an operator is a macro.

  • GRAB_CURSOR Grab Pointer – Use so the operator grabs the mouse focus, enables wrapping when continuous grab is enabled.

  • GRAB_CURSOR_X Grab Pointer X – Grab, only warping the X axis.

  • GRAB_CURSOR_Y Grab Pointer Y – Grab, only warping the Y axis.

  • DEPENDS_ON_CURSOR Depends on Cursor – The initial cursor location is used, when running from a menus or buttons the user is prompted to place the cursor before beginning the operation.

  • PRESET Preset – Display a preset button with the operators settings.

  • INTERNAL Internal – Removes the operator from search results.

Type

enum set in {‘REGISTER’, ‘UNDO’, ‘UNDO_GROUPED’, ‘BLOCKING’, ‘MACRO’, ‘GRAB_CURSOR’, ‘GRAB_CURSOR_X’, ‘GRAB_CURSOR_Y’, ‘DEPENDS_ON_CURSOR’, ‘PRESET’, ‘INTERNAL’}, default {‘REGISTER’}

bl_translation_context
Type

string, default “Operator”, (never None)

bl_undo_group
Type

string, default “”, (never None)

has_reports

Operator has a set of reports (warnings and errors) from last execution

Type

boolean, default False, (readonly)

name
Type

string, default “”, (readonly, never None)

properties
Type

OperatorProperties, (readonly, never None)

report(type, message)

report

Parameters

  • type (enum set in {'DEBUG', 'INFO', 'OPERATOR', 'PROPERTY', 'WARNING', 'ERROR', 'ERROR_INVALID_INPUT', 'ERROR_INVALID_CONTEXT', 'ERROR_OUT_OF_MEMORY'}) – Type

  • message (string, (never None)) – Report Message

classmethod poll(context)

Test if the operator can be called or not

Return type

boolean

draw(context)

Draw function for the operator

classmethod bl_rna_get_subclass(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters

id (string) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References