Executing operators with parameters

When making your own custom operators, sometimes it is necessary to pass them certain values – execute operator with parameters.

The passed parameter must be defined as an operator property.

Let’s write a simple operator class to print a text value, passed to it through the parameter.

Define an operator class:

class TestOperator(bpy.types.Operator):
    
    bl_idname = 'test.operator'
    bl_label = 'test'

class TestOperator(bpy.types.Operator):

bl_idname = 'test.operator'

bl_label = 'test'

Add a string property with the “text” name:

text: bpy.props.StringProperty(
    name = 'text',
    default = ''
    )

text: bpy.props.StringProperty(

name = 'text',

default = ''

)

And define an “execute” function to run when the operator is called:

def execute(self, context):
    print(self.text)
    return {'FINISHED'}

def execute(self, context):

print(self.text)

return {'FINISHED'}

This function prints the value of the “text” property, which we will pass as a parameter when calling an operator.

def register():
    bpy.utils.register_class(TestOperator)
    

if __name__ == '__main__':
    register()

def register():

bpy.utils.register_class(TestOperator)

if __name__ == '__main__':

Complete text:

import bpy

class TestOperator(bpy.types.Operator):
    
    bl_idname = 'test.operator'
    bl_label = 'test'
    
    text: bpy.props.StringProperty(
        name = 'text',
        default = ''
        )
        
    def execute(self, context):
        print(self.text)
        return {'FINISHED'}

def register():
    bpy.utils.register_class(TestOperator)
    

if __name__ == '__main__':
    register()

import bpy