Cleanup: API docs
[blender.git] / doc / python_api / examples / bpy.types.Operator.py
1 """
2 Basic Operator Example
3 ++++++++++++++++++++++
4
5 This script shows simple operator which prints a message.
6
7 Since the operator only has an :class:`Operator.execute` function it takes no
8 user input.
9
10 .. note::
11
12    Operator subclasses must be registered before accessing them from blender.
13 """
14 import bpy
15
16
17 class HelloWorldOperator(bpy.types.Operator):
18     bl_idname = "wm.hello_world"
19     bl_label = "Minimal Operator"
20
21     def execute(self, context):
22         print("Hello World")
23         return {'FINISHED'}
24
25 bpy.utils.register_class(HelloWorldOperator)
26
27 # test call to the newly defined operator
28 bpy.ops.wm.hello_world()