Docs
Download

Operators

The actions of your add-on, the shortcuts that run them and the nodes for modal tools.

In Blender, everything you can click does its work through an operator. Add Cube, Shade Smooth, Save, Undo: each is an operator, a named action with settings. A button in a panel, a menu entry, a keyboard shortcut and the operator search (F3) only point at one. So when your add-on needs a button that does something, you make an operator for it and let the button run it.

The operator nodes are under Add › Operators, the nodes for modal operators under Add › Operators › Modal.

An Operator node running Blender's Add Cube and reporting it, and a sidebar panel with a button that runs the operator

A minimal setup:

Add an Operator node and type its Label, e.g. "Add Small Cube". That's the button's text and the name in the operator search.

Connect what it should do to Execute, e.g. a Run Operator set to Blender's Add Cube with size 0.5. The play button on the Operator node runs it to try it out.

Draw a Button in a Panel and pick your operator in it. You can also give it a Shortcut.

Nodes

NodeDoes
OperatorAn operator of your add-on: what it does (Execute), its properties, its dialog
Run OperatorRuns one of your operators or any of Blender's from a flow
ReportShows an info, warning or error message in the status bar
ShortcutA keyboard shortcut that runs an operator or opens a menu
File HandlerRuns an operator when files are dragged onto Blender
ReturnEnds the operator's flow: finish, cancel, or (modal) pass the event on or wait
Is KeyWhether an event is a given key or mouse button, pressed or released
Event InfoThe event's key, modifier keys, mouse position and movement, tablet pressure
Set Header TextShows a text at the top of the editor, e.g. what a modal tool does
Set Status TextShows a text in the status bar, e.g. the keys a modal tool reacts to
Set CursorChanges the mouse cursor until it's set back

Two settings windows belong to these nodes: Operator Settings is the popup behind Settings on the Operator node (see Settings), and Record Shortcut is the key button on the Shortcut node that listens for the keys you press (see Shortcuts).

Pages

To run nodes when something happens in Blender instead of when someone clicks, see Events.