blender-archive/doc/python_api/examples/bpy.props.4.py

"""
Update Example
++++++++++++++

It can be useful to perform an action when a property is changed and can be
used to update other properties or synchronize with external data.

All properties define update functions except for CollectionProperty.

.. warning::
   Remember that these callbacks may be executed in threaded context.

"""

import bpy


def update_func(self, context):
    print("my test function", self)


bpy.types.Scene.testprop = bpy.props.FloatProperty(update=update_func)

bpy.context.scene.testprop = 11.0

# >>> my test function <bpy_struct, Scene("Scene")>
- add example for python rna property update - edit the copyright for blender specific cmake find modules 2011-06-20 02:54:56 +00:00			`"""`
			`Update Example`
			`++++++++++++++`

			`It can be useful to perform an action when a property is changed and can be`
			`used to update other properties or synchronize with external data.`

			`All properties define update functions except for CollectionProperty.`
Py API doc: Add warning that py-defined property accessor callbacks may be called in threaded context. At least Depsgraph evaluation and liboverride diffing do process IDs in parallel, so python code in py-defined properties should not access any data outside of their owner ID. Ref. T100203. 2022-08-12 16:21:11 +02:00
			`.. warning::`
			`Remember that these callbacks may be executed in threaded context.`

- add example for python rna property update - edit the copyright for blender specific cmake find modules 2011-06-20 02:54:56 +00:00			`"""`

			`import bpy`

pep8 compliance 2011-06-21 17:17:51 +00:00
- add example for python rna property update - edit the copyright for blender specific cmake find modules 2011-06-20 02:54:56 +00:00			`def update_func(self, context):`
			`print("my test function", self)`

Cleanup: pep8 function indentation 2018-06-26 19:41:37 +02:00
- add example for python rna property update - edit the copyright for blender specific cmake find modules 2011-06-20 02:54:56 +00:00			`bpy.types.Scene.testprop = bpy.props.FloatProperty(update=update_func)`

			`bpy.context.scene.testprop = 11.0`

			`# >>> my test function <bpy_struct, Scene("Scene")>`