diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-10-08 15:43:01 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-10-08 16:56:00 +0300 |
commit | 4d71138738ca8ba7e4908328d81d1f6c95fc84cd (patch) | |
tree | f6661733075690beace0d84dff6c2f44770bcb49 /source/blender/python/intern/bpy_msgbus.c | |
parent | bff3dcf3307a475916781994027dbd7d36f31b98 (diff) |
Docs: note that message-bus subscribers are reset on file load
Diffstat (limited to 'source/blender/python/intern/bpy_msgbus.c')
-rw-r--r-- | source/blender/python/intern/bpy_msgbus.c | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/source/blender/python/intern/bpy_msgbus.c b/source/blender/python/intern/bpy_msgbus.c index bf70f8158d2..9e165bbf1c0 100644 --- a/source/blender/python/intern/bpy_msgbus.c +++ b/source/blender/python/intern/bpy_msgbus.c @@ -218,7 +218,12 @@ PyDoc_STRVAR( "\n" " - ``PERSISTENT`` when set, the subscriber will be kept when remapping ID data.\n" "\n" - " :type options: set of str.\n"); + " :type options: set of str.\n" + "\n" + ".. note::\n" + "\n" + " All subscribers will be cleared on file-load. Subscribers can be re-registered on load,\n" + " see :mod:`bpy.app.handlers.load_post`.\n"); static PyObject *bpy_msgbus_subscribe_rna(PyObject *UNUSED(self), PyObject *args, PyObject *kw) { const char *error_prefix = "subscribe_rna"; |