Cr8-xyz/blender
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Docs: update API docs, adding reference to bl_rna_get_subclass.

Browse Source
This commit is contained in:
Campbell Barton
2020-05-11 15:26:57 +10:00
parent 6222a9bf27
commit f4d65b0d6e
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/python_api/rst/info_overview.rst
View File

@@ -253,7 +253,13 @@ Registering a class with Blender results in the class definition being loaded in
where it becomes available alongside existing functionality. where it becomes available alongside existing functionality.
Once this class is loaded you can access it from :mod:`bpy.types`, 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, 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. that properties have the correct type, and that functions have the right number of arguments.