diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-05-11 08:26:57 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-05-11 08:48:51 +0300 |
commit | f4d65b0d6eeab7da5955aacd5eb99e717fbb77d5 (patch) | |
tree | af43c2777b49586c246c76c0355808df7f2c7b35 /doc | |
parent | 6222a9bf27017ae6791af65e38b079941e143991 (diff) |
Docs: update API docs, adding reference to bl_rna_get_subclass.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/python_api/rst/info_overview.rst | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/python_api/rst/info_overview.rst b/doc/python_api/rst/info_overview.rst index e341453fe93..562076c6c43 100644 --- a/doc/python_api/rst/info_overview.rst +++ b/doc/python_api/rst/info_overview.rst @@ -253,7 +253,13 @@ Registering a class with Blender results in the class definition being loaded in where it becomes available alongside existing functionality. Once this class is loaded you can access it from :mod:`bpy.types`, -using the bl_idname rather than the classes original name. +using the ``bl_idname`` rather than the classes original name. + +.. note:: + + There are some exceptions to this for class names which aren't guarantee to be unique. + In this case use: :func:`bpy.types.Struct.bl_rna_get_subclass`. + When loading a class, Blender performs sanity checks making sure all required properties and functions are found, that properties have the correct type, and that functions have the right number of arguments. |