Fix: PyAPI Docs: Document more msgbus limitations
Added the following notes to documentation: - `msgbus` interaction with undo system that particularly makes it not completely reliable, since users they easily skip it's effect. - Details on when and how often message bus updates are triggered. Pull Request: https://projects.blender.org/blender/blender/pulls/138557
This commit is contained in:
committed by
Pratik Borhade
parent
66d361bd29
commit
6e70b755ce
@@ -17,6 +17,13 @@ The following updates do **not** trigger message bus notifications:
|
||||
- Moving objects in the 3D Viewport.
|
||||
- Changes performed by the animation system.
|
||||
|
||||
Changes done from ``msgbus`` callbacks are not included in related undo steps,
|
||||
so users can easily skip their effects by using Undo followed by Redo.
|
||||
|
||||
Unlike properties ``update`` callbacks, message bus update callbacks are postponed
|
||||
until all operators have finished executing.
|
||||
Additionally, for each property the callback is only triggered once per update cycle,
|
||||
even if the property was changed multiple times during that period.
|
||||
|
||||
Example Use
|
||||
-----------
|
||||
|
||||
Reference in New Issue
Block a user