fake-bpy-module 20240516__py3-none-any.whl → 20240517__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of fake-bpy-module might be problematic. Click here for more details.

Files changed (533) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +2 -2
  2. addon_utils/__init__.pyi +43 -12
  3. animsys_refactor/__init__.pyi +4 -4
  4. aud/__init__.pyi +7 -7
  5. bgl/__init__.pyi +121 -183
  6. bl_app_override/__init__.pyi +5 -5
  7. bl_app_override/helpers/__init__.pyi +3 -1
  8. bl_app_template_utils/__init__.pyi +5 -5
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +5 -5
  14. bl_i18n_utils/settings/__init__.pyi +4 -2
  15. bl_i18n_utils/utils/__init__.pyi +86 -58
  16. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  17. bl_keymap_utils/io/__init__.pyi +4 -4
  18. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  19. bl_keymap_utils/platform_helpers/__init__.pyi +2 -2
  20. bl_operators/add_mesh_torus/__init__.pyi +126 -41
  21. bl_operators/anim/__init__.pyi +1001 -328
  22. bl_operators/assets/__init__.pyi +376 -123
  23. bl_operators/bmesh/find_adjacent/__init__.pyi +3 -3
  24. bl_operators/clip/__init__.pyi +1250 -409
  25. bl_operators/console/__init__.pyi +626 -205
  26. bl_operators/constraint/__init__.pyi +502 -165
  27. bl_operators/file/__init__.pyi +376 -123
  28. bl_operators/freestyle/__init__.pyi +501 -164
  29. bl_operators/geometry_nodes/__init__.pyi +501 -164
  30. bl_operators/image/__init__.pyi +621 -200
  31. bl_operators/mesh/__init__.pyi +376 -123
  32. bl_operators/node/__init__.pyi +1243 -402
  33. bl_operators/object/__init__.pyi +1876 -615
  34. bl_operators/object_align/__init__.pyi +126 -41
  35. bl_operators/object_quick_effects/__init__.pyi +502 -165
  36. bl_operators/object_randomize_transform/__init__.pyi +126 -41
  37. bl_operators/presets/__init__.pyi +3069 -1027
  38. bl_operators/rigidbody/__init__.pyi +376 -123
  39. bl_operators/screen_play_rendered_anim/__init__.pyi +126 -41
  40. bl_operators/sequencer/__init__.pyi +1009 -331
  41. bl_operators/spreadsheet/__init__.pyi +126 -41
  42. bl_operators/userpref/__init__.pyi +3263 -1078
  43. bl_operators/uvcalc_follow_active/__init__.pyi +126 -41
  44. bl_operators/uvcalc_lightmap/__init__.pyi +137 -47
  45. bl_operators/uvcalc_transform/__init__.pyi +289 -90
  46. bl_operators/vertexpaint_dirt/__init__.pyi +126 -41
  47. bl_operators/view3d/__init__.pyi +868 -279
  48. bl_operators/wm/__init__.pyi +5777 -1934
  49. bl_operators/world/__init__.pyi +126 -41
  50. bl_previews_utils/bl_previews_render/__init__.pyi +1 -1
  51. bl_rna_utils/data_path/__init__.pyi +8 -3
  52. bl_ui/__init__.pyi +338 -131
  53. bl_ui/anim/__init__.pyi +164 -64
  54. bl_ui/asset_shelf/__init__.pyi +129 -42
  55. bl_ui/generic_ui_list/__init__.pyi +412 -135
  56. bl_ui/node_add_menu/__init__.pyi +168 -68
  57. bl_ui/node_add_menu_compositor/__init__.pyi +2921 -1138
  58. bl_ui/node_add_menu_geometry/__init__.pyi +7785 -3032
  59. bl_ui/node_add_menu_shader/__init__.pyi +1621 -630
  60. bl_ui/node_add_menu_texture/__init__.pyi +1459 -567
  61. bl_ui/properties_animviz/__init__.pyi +2 -2
  62. bl_ui/properties_collection/__init__.pyi +806 -274
  63. bl_ui/properties_constraint/__init__.pyi +10253 -3458
  64. bl_ui/properties_data_armature/__init__.pyi +1615 -552
  65. bl_ui/properties_data_bone/__init__.pyi +1288 -425
  66. bl_ui/properties_data_camera/__init__.pyi +1854 -631
  67. bl_ui/properties_data_curve/__init__.pyi +1929 -636
  68. bl_ui/properties_data_curves/__init__.pyi +806 -274
  69. bl_ui/properties_data_empty/__init__.pyi +257 -84
  70. bl_ui/properties_data_gpencil/__init__.pyi +2380 -803
  71. bl_ui/properties_data_grease_pencil/__init__.pyi +1902 -656
  72. bl_ui/properties_data_lattice/__init__.pyi +388 -127
  73. bl_ui/properties_data_light/__init__.pyi +1541 -506
  74. bl_ui/properties_data_lightprobe/__init__.pyi +1667 -548
  75. bl_ui/properties_data_mesh/__init__.pyi +2704 -929
  76. bl_ui/properties_data_metaball/__init__.pyi +644 -211
  77. bl_ui/properties_data_modifier/__init__.pyi +1353 -502
  78. bl_ui/properties_data_pointcloud/__init__.pyi +679 -233
  79. bl_ui/properties_data_shaderfx/__init__.pyi +129 -42
  80. bl_ui/properties_data_speaker/__init__.pyi +644 -211
  81. bl_ui/properties_data_volume/__init__.pyi +1030 -339
  82. bl_ui/properties_freestyle/__init__.pyi +3113 -1035
  83. bl_ui/properties_grease_pencil_common/__init__.pyi +2464 -933
  84. bl_ui/properties_mask_common/__init__.pyi +1101 -420
  85. bl_ui/properties_material/__init__.pyi +2091 -699
  86. bl_ui/properties_material_gpencil/__init__.pyi +1350 -466
  87. bl_ui/properties_object/__init__.pyi +1838 -618
  88. bl_ui/properties_output/__init__.pyi +2414 -831
  89. bl_ui/properties_paint_common/__init__.pyi +412 -289
  90. bl_ui/properties_particle/__init__.pyi +6737 -2241
  91. bl_ui/properties_physics_cloth/__init__.pyi +1825 -612
  92. bl_ui/properties_physics_common/__init__.pyi +129 -42
  93. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2821 -928
  94. bl_ui/properties_physics_field/__init__.pyi +1283 -422
  95. bl_ui/properties_physics_fluid/__init__.pyi +3620 -1203
  96. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -42
  97. bl_ui/properties_physics_rigidbody/__init__.pyi +1027 -338
  98. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1667 -548
  99. bl_ui/properties_physics_softbody/__init__.pyi +1924 -633
  100. bl_ui/properties_render/__init__.pyi +6830 -2263
  101. bl_ui/properties_scene/__init__.pyi +1929 -636
  102. bl_ui/properties_texture/__init__.pyi +3370 -1118
  103. bl_ui/properties_view_layer/__init__.pyi +2346 -782
  104. bl_ui/properties_workspace/__init__.pyi +516 -169
  105. bl_ui/properties_world/__init__.pyi +1284 -421
  106. bl_ui/space_clip/__init__.pyi +10134 -3639
  107. bl_ui/space_console/__init__.pyi +939 -357
  108. bl_ui/space_dopesheet/__init__.pyi +4327 -1562
  109. bl_ui/space_filebrowser/__init__.pyi +4164 -1499
  110. bl_ui/space_graph/__init__.pyi +3108 -1179
  111. bl_ui/space_image/__init__.pyi +9766 -3596
  112. bl_ui/space_info/__init__.pyi +939 -357
  113. bl_ui/space_nla/__init__.pyi +2620 -988
  114. bl_ui/space_node/__init__.pyi +3994 -1434
  115. bl_ui/space_outliner/__init__.pyi +2203 -842
  116. bl_ui/space_properties/__init__.pyi +386 -127
  117. bl_ui/space_sequencer/__init__.pyi +10773 -3878
  118. bl_ui/space_spreadsheet/__init__.pyi +130 -43
  119. bl_ui/space_statusbar/__init__.pyi +129 -42
  120. bl_ui/space_text/__init__.pyi +2458 -925
  121. bl_ui/space_time/__init__.pyi +1033 -378
  122. bl_ui/space_toolsystem_common/__init__.pyi +20 -16
  123. bl_ui/space_toolsystem_toolbar/__init__.pyi +37 -21
  124. bl_ui/space_topbar/__init__.pyi +3980 -1496
  125. bl_ui/space_userpref/__init__.pyi +11373 -3797
  126. bl_ui/space_view3d/__init__.pyi +40865 -15356
  127. bl_ui/space_view3d_toolbar/__init__.pyi +12520 -4647
  128. bl_ui/temp_anim_layers/__init__.pyi +129 -42
  129. bl_ui/utils/__init__.pyi +28 -20
  130. bl_ui_utils/bug_report_url/__init__.pyi +1 -1
  131. bl_ui_utils/layout/__init__.pyi +1 -1
  132. blend_render_info/__init__.pyi +1 -1
  133. blf/__init__.pyi +4 -4
  134. bmesh/geometry/__init__.pyi +2 -3
  135. bmesh/ops/__init__.pyi +372 -419
  136. bmesh/types/__init__.pyi +38 -38
  137. bmesh/utils/__init__.pyi +10 -13
  138. bpy/app/__init__.pyi +4 -4
  139. bpy/app/handlers/__init__.pyi +36 -36
  140. bpy/app/icons/__init__.pyi +8 -8
  141. bpy/app/timers/__init__.pyi +10 -10
  142. bpy/app/translations/__init__.pyi +20 -22
  143. bpy/msgbus/__init__.pyi +2 -4
  144. bpy/ops/action/__init__.pyi +316 -394
  145. bpy/ops/anim/__init__.pyi +442 -548
  146. bpy/ops/armature/__init__.pyi +374 -470
  147. bpy/ops/asset/__init__.pyi +152 -184
  148. bpy/ops/bl_pkg/__init__.pyi +221 -272
  149. bpy/ops/boid/__init__.pyi +50 -66
  150. bpy/ops/brush/__init__.pyi +72 -90
  151. bpy/ops/buttons/__init__.pyi +132 -144
  152. bpy/ops/cachefile/__init__.pyi +128 -138
  153. bpy/ops/camera/__init__.pyi +26 -30
  154. bpy/ops/clip/__init__.pyi +777 -964
  155. bpy/ops/cloth/__init__.pyi +12 -14
  156. bpy/ops/collection/__init__.pyi +68 -86
  157. bpy/ops/console/__init__.pyi +158 -200
  158. bpy/ops/constraint/__init__.pyi +178 -214
  159. bpy/ops/curve/__init__.pyi +473 -576
  160. bpy/ops/curves/__init__.pyi +247 -302
  161. bpy/ops/cycles/__init__.pyi +28 -34
  162. bpy/ops/dpaint/__init__.pyi +34 -44
  163. bpy/ops/ed/__init__.pyi +126 -150
  164. bpy/ops/export_anim/__init__.pyi +22 -24
  165. bpy/ops/export_scene/__init__.pyi +302 -336
  166. bpy/ops/file/__init__.pyi +352 -432
  167. bpy/ops/fluid/__init__.pyi +90 -118
  168. bpy/ops/font/__init__.pyi +258 -304
  169. bpy/ops/geometry/__init__.pyi +100 -120
  170. bpy/ops/gizmogroup/__init__.pyi +22 -26
  171. bpy/ops/gpencil/__init__.pyi +1469 -1778
  172. bpy/ops/graph/__init__.pyi +644 -776
  173. bpy/ops/grease_pencil/__init__.pyi +597 -748
  174. bpy/ops/image/__init__.pyi +648 -744
  175. bpy/ops/import_anim/__init__.pyi +30 -32
  176. bpy/ops/import_curve/__init__.pyi +10 -12
  177. bpy/ops/import_scene/__init__.pyi +88 -96
  178. bpy/ops/info/__init__.pyi +60 -74
  179. bpy/ops/lattice/__init__.pyi +64 -80
  180. bpy/ops/marker/__init__.pyi +108 -130
  181. bpy/ops/mask/__init__.pyi +322 -402
  182. bpy/ops/material/__init__.pyi +18 -24
  183. bpy/ops/mball/__init__.pyi +70 -86
  184. bpy/ops/mesh/__init__.pyi +1986 -2322
  185. bpy/ops/nla/__init__.pyi +333 -411
  186. bpy/ops/node/__init__.pyi +886 -1100
  187. bpy/ops/object/__init__.pyi +2585 -3078
  188. bpy/ops/outliner/__init__.pyi +498 -636
  189. bpy/ops/paint/__init__.pyi +565 -680
  190. bpy/ops/paintcurve/__init__.pyi +64 -80
  191. bpy/ops/palette/__init__.pyi +50 -64
  192. bpy/ops/particle/__init__.pyi +267 -340
  193. bpy/ops/pose/__init__.pyi +336 -414
  194. bpy/ops/poselib/__init__.pyi +72 -90
  195. bpy/ops/preferences/__init__.pyi +386 -463
  196. bpy/ops/ptcache/__init__.pyi +46 -60
  197. bpy/ops/render/__init__.pyi +130 -154
  198. bpy/ops/rigidbody/__init__.pyi +102 -128
  199. bpy/ops/scene/__init__.pyi +280 -358
  200. bpy/ops/screen/__init__.pyi +382 -460
  201. bpy/ops/script/__init__.pyi +24 -30
  202. bpy/ops/sculpt/__init__.pyi +458 -532
  203. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  204. bpy/ops/sequencer/__init__.pyi +1066 -1244
  205. bpy/ops/sound/__init__.pyi +216 -230
  206. bpy/ops/spreadsheet/__init__.pyi +30 -38
  207. bpy/ops/surface/__init__.pyi +108 -120
  208. bpy/ops/text/__init__.pyi +390 -476
  209. bpy/ops/text_editor/__init__.pyi +12 -14
  210. bpy/ops/texture/__init__.pyi +26 -34
  211. bpy/ops/transform/__init__.pyi +792 -878
  212. bpy/ops/ui/__init__.pyi +228 -294
  213. bpy/ops/uilist/__init__.pyi +32 -38
  214. bpy/ops/uv/__init__.pyi +602 -704
  215. bpy/ops/view2d/__init__.pyi +156 -184
  216. bpy/ops/view3d/__init__.pyi +582 -718
  217. bpy/ops/wm/__init__.pyi +2680 -2928
  218. bpy/ops/workspace/__init__.pyi +46 -60
  219. bpy/ops/world/__init__.pyi +12 -16
  220. bpy/path/__init__.pyi +179 -75
  221. bpy/props/__init__.pyi +261 -263
  222. bpy/types/__init__.pyi +17056 -21951
  223. bpy/utils/__init__.pyi +242 -118
  224. bpy/utils/previews/__init__.pyi +58 -28
  225. bpy/utils/units/__init__.pyi +20 -20
  226. bpy_extras/anim_utils/__init__.pyi +68 -28
  227. bpy_extras/bmesh_utils/__init__.pyi +8 -2
  228. bpy_extras/extensions/junction_module/__init__.pyi +5 -2
  229. bpy_extras/id_map_utils/__init__.pyi +3 -3
  230. bpy_extras/image_utils/__init__.pyi +44 -11
  231. bpy_extras/io_utils/__init__.pyi +113 -18
  232. bpy_extras/keyconfig_utils/__init__.pyi +2 -2
  233. bpy_extras/mesh_utils/__init__.pyi +71 -19
  234. bpy_extras/node_shader_utils/__init__.pyi +9 -4
  235. bpy_extras/node_utils/__init__.pyi +9 -2
  236. bpy_extras/object_utils/__init__.pyi +71 -12
  237. bpy_extras/view3d_utils/__init__.pyi +80 -10
  238. bpy_extras/wm_utils/progress_report/__init__.pyi +13 -10
  239. bpy_types/__init__.pyi +4197 -1333
  240. console_python/__init__.pyi +6 -1
  241. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/METADATA +1 -1
  242. fake_bpy_module-20240517.dist-info/RECORD +353 -0
  243. freestyle/chainingiterators/__init__.pyi +4 -4
  244. freestyle/shaders/__init__.pyi +2 -2
  245. freestyle/types/__init__.pyi +84 -96
  246. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  247. freestyle/utils/__init__.pyi +3 -3
  248. gpu/matrix/__init__.pyi +6 -8
  249. gpu/state/__init__.pyi +2 -2
  250. gpu/types/__init__.pyi +12 -12
  251. gpu_extras/presets/__init__.pyi +2 -5
  252. graphviz_export/__init__.pyi +4 -2
  253. idprop/types/__init__.pyi +2 -2
  254. imbuf/__init__.pyi +4 -4
  255. keyingsets_builtins/__init__.pyi +2688 -839
  256. mathutils/__init__.pyi +194 -238
  257. mathutils/bvhtree/__init__.pyi +4 -4
  258. mathutils/geometry/__init__.pyi +153 -155
  259. mathutils/kdtree/__init__.pyi +8 -12
  260. mathutils/noise/__init__.pyi +26 -26
  261. nodeitems_utils/__init__.pyi +1 -1
  262. rna_info/__init__.pyi +17 -15
  263. rna_keymap_ui/__init__.pyi +1 -1
  264. rna_prop_ui/__init__.pyi +16 -14
  265. rna_xml/__init__.pyi +12 -12
  266. _bpy_internal/freedesktop/py.typed +0 -0
  267. bl_app_override/helpers/py.typed +0 -0
  268. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  269. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  270. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  271. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  272. bl_console_utils/autocomplete/py.typed +0 -0
  273. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  274. bl_i18n_utils/merge_po/py.typed +0 -0
  275. bl_i18n_utils/settings/py.typed +0 -0
  276. bl_i18n_utils/utils/py.typed +0 -0
  277. bl_i18n_utils/utils_cli/py.typed +0 -0
  278. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  279. bl_i18n_utils/utils_rtl/py.typed +0 -0
  280. bl_keymap_utils/io/py.typed +0 -0
  281. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  282. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  283. bl_keymap_utils/platform_helpers/py.typed +0 -0
  284. bl_keymap_utils/versioning/py.typed +0 -0
  285. bl_operators/add_mesh_torus/py.typed +0 -0
  286. bl_operators/anim/py.typed +0 -0
  287. bl_operators/assets/py.typed +0 -0
  288. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  289. bl_operators/bmesh/py.typed +0 -0
  290. bl_operators/clip/py.typed +0 -0
  291. bl_operators/console/py.typed +0 -0
  292. bl_operators/constraint/py.typed +0 -0
  293. bl_operators/file/py.typed +0 -0
  294. bl_operators/freestyle/py.typed +0 -0
  295. bl_operators/geometry_nodes/py.typed +0 -0
  296. bl_operators/image/py.typed +0 -0
  297. bl_operators/mesh/py.typed +0 -0
  298. bl_operators/node/py.typed +0 -0
  299. bl_operators/object/py.typed +0 -0
  300. bl_operators/object_align/py.typed +0 -0
  301. bl_operators/object_quick_effects/py.typed +0 -0
  302. bl_operators/object_randomize_transform/py.typed +0 -0
  303. bl_operators/presets/py.typed +0 -0
  304. bl_operators/rigidbody/py.typed +0 -0
  305. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  306. bl_operators/sequencer/py.typed +0 -0
  307. bl_operators/spreadsheet/py.typed +0 -0
  308. bl_operators/userpref/py.typed +0 -0
  309. bl_operators/uvcalc_follow_active/py.typed +0 -0
  310. bl_operators/uvcalc_lightmap/py.typed +0 -0
  311. bl_operators/uvcalc_transform/py.typed +0 -0
  312. bl_operators/vertexpaint_dirt/py.typed +0 -0
  313. bl_operators/view3d/py.typed +0 -0
  314. bl_operators/wm/py.typed +0 -0
  315. bl_operators/world/py.typed +0 -0
  316. bl_previews_utils/bl_previews_render/py.typed +0 -0
  317. bl_rna_utils/data_path/py.typed +0 -0
  318. bl_text_utils/external_editor/py.typed +0 -0
  319. bl_ui/anim/py.typed +0 -0
  320. bl_ui/asset_shelf/py.typed +0 -0
  321. bl_ui/generic_ui_list/py.typed +0 -0
  322. bl_ui/node_add_menu/py.typed +0 -0
  323. bl_ui/node_add_menu_compositor/py.typed +0 -0
  324. bl_ui/node_add_menu_geometry/py.typed +0 -0
  325. bl_ui/node_add_menu_shader/py.typed +0 -0
  326. bl_ui/node_add_menu_texture/py.typed +0 -0
  327. bl_ui/properties_animviz/py.typed +0 -0
  328. bl_ui/properties_collection/py.typed +0 -0
  329. bl_ui/properties_constraint/py.typed +0 -0
  330. bl_ui/properties_data_armature/py.typed +0 -0
  331. bl_ui/properties_data_bone/py.typed +0 -0
  332. bl_ui/properties_data_camera/py.typed +0 -0
  333. bl_ui/properties_data_curve/py.typed +0 -0
  334. bl_ui/properties_data_curves/py.typed +0 -0
  335. bl_ui/properties_data_empty/py.typed +0 -0
  336. bl_ui/properties_data_gpencil/py.typed +0 -0
  337. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  338. bl_ui/properties_data_lattice/py.typed +0 -0
  339. bl_ui/properties_data_light/py.typed +0 -0
  340. bl_ui/properties_data_lightprobe/py.typed +0 -0
  341. bl_ui/properties_data_mesh/py.typed +0 -0
  342. bl_ui/properties_data_metaball/py.typed +0 -0
  343. bl_ui/properties_data_modifier/py.typed +0 -0
  344. bl_ui/properties_data_pointcloud/py.typed +0 -0
  345. bl_ui/properties_data_shaderfx/py.typed +0 -0
  346. bl_ui/properties_data_speaker/py.typed +0 -0
  347. bl_ui/properties_data_volume/py.typed +0 -0
  348. bl_ui/properties_freestyle/py.typed +0 -0
  349. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  350. bl_ui/properties_mask_common/py.typed +0 -0
  351. bl_ui/properties_material/py.typed +0 -0
  352. bl_ui/properties_material_gpencil/py.typed +0 -0
  353. bl_ui/properties_object/py.typed +0 -0
  354. bl_ui/properties_output/py.typed +0 -0
  355. bl_ui/properties_paint_common/py.typed +0 -0
  356. bl_ui/properties_particle/py.typed +0 -0
  357. bl_ui/properties_physics_cloth/py.typed +0 -0
  358. bl_ui/properties_physics_common/py.typed +0 -0
  359. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  360. bl_ui/properties_physics_field/py.typed +0 -0
  361. bl_ui/properties_physics_fluid/py.typed +0 -0
  362. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  363. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  364. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  365. bl_ui/properties_physics_softbody/py.typed +0 -0
  366. bl_ui/properties_render/py.typed +0 -0
  367. bl_ui/properties_scene/py.typed +0 -0
  368. bl_ui/properties_texture/py.typed +0 -0
  369. bl_ui/properties_view_layer/py.typed +0 -0
  370. bl_ui/properties_workspace/py.typed +0 -0
  371. bl_ui/properties_world/py.typed +0 -0
  372. bl_ui/space_clip/py.typed +0 -0
  373. bl_ui/space_console/py.typed +0 -0
  374. bl_ui/space_dopesheet/py.typed +0 -0
  375. bl_ui/space_filebrowser/py.typed +0 -0
  376. bl_ui/space_graph/py.typed +0 -0
  377. bl_ui/space_image/py.typed +0 -0
  378. bl_ui/space_info/py.typed +0 -0
  379. bl_ui/space_nla/py.typed +0 -0
  380. bl_ui/space_node/py.typed +0 -0
  381. bl_ui/space_outliner/py.typed +0 -0
  382. bl_ui/space_properties/py.typed +0 -0
  383. bl_ui/space_sequencer/py.typed +0 -0
  384. bl_ui/space_spreadsheet/py.typed +0 -0
  385. bl_ui/space_statusbar/py.typed +0 -0
  386. bl_ui/space_text/py.typed +0 -0
  387. bl_ui/space_time/py.typed +0 -0
  388. bl_ui/space_toolsystem_common/py.typed +0 -0
  389. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  390. bl_ui/space_topbar/py.typed +0 -0
  391. bl_ui/space_userpref/py.typed +0 -0
  392. bl_ui/space_view3d/py.typed +0 -0
  393. bl_ui/space_view3d_toolbar/py.typed +0 -0
  394. bl_ui/temp_anim_layers/py.typed +0 -0
  395. bl_ui/utils/py.typed +0 -0
  396. bl_ui_utils/bug_report_url/py.typed +0 -0
  397. bl_ui_utils/layout/py.typed +0 -0
  398. bmesh/geometry/py.typed +0 -0
  399. bmesh/ops/py.typed +0 -0
  400. bmesh/types/py.typed +0 -0
  401. bmesh/utils/py.typed +0 -0
  402. bpy/app/handlers/py.typed +0 -0
  403. bpy/app/icons/py.typed +0 -0
  404. bpy/app/py.typed +0 -0
  405. bpy/app/timers/py.typed +0 -0
  406. bpy/app/translations/py.typed +0 -0
  407. bpy/msgbus/py.typed +0 -0
  408. bpy/ops/action/py.typed +0 -0
  409. bpy/ops/anim/py.typed +0 -0
  410. bpy/ops/armature/py.typed +0 -0
  411. bpy/ops/asset/py.typed +0 -0
  412. bpy/ops/bl_pkg/py.typed +0 -0
  413. bpy/ops/boid/py.typed +0 -0
  414. bpy/ops/brush/py.typed +0 -0
  415. bpy/ops/buttons/py.typed +0 -0
  416. bpy/ops/cachefile/py.typed +0 -0
  417. bpy/ops/camera/py.typed +0 -0
  418. bpy/ops/clip/py.typed +0 -0
  419. bpy/ops/cloth/py.typed +0 -0
  420. bpy/ops/collection/py.typed +0 -0
  421. bpy/ops/console/py.typed +0 -0
  422. bpy/ops/constraint/py.typed +0 -0
  423. bpy/ops/curve/py.typed +0 -0
  424. bpy/ops/curves/py.typed +0 -0
  425. bpy/ops/cycles/py.typed +0 -0
  426. bpy/ops/dpaint/py.typed +0 -0
  427. bpy/ops/ed/py.typed +0 -0
  428. bpy/ops/export_anim/py.typed +0 -0
  429. bpy/ops/export_scene/py.typed +0 -0
  430. bpy/ops/file/py.typed +0 -0
  431. bpy/ops/fluid/py.typed +0 -0
  432. bpy/ops/font/py.typed +0 -0
  433. bpy/ops/geometry/py.typed +0 -0
  434. bpy/ops/gizmogroup/py.typed +0 -0
  435. bpy/ops/gpencil/py.typed +0 -0
  436. bpy/ops/graph/py.typed +0 -0
  437. bpy/ops/grease_pencil/py.typed +0 -0
  438. bpy/ops/image/py.typed +0 -0
  439. bpy/ops/import_anim/py.typed +0 -0
  440. bpy/ops/import_curve/py.typed +0 -0
  441. bpy/ops/import_scene/py.typed +0 -0
  442. bpy/ops/info/py.typed +0 -0
  443. bpy/ops/lattice/py.typed +0 -0
  444. bpy/ops/marker/py.typed +0 -0
  445. bpy/ops/mask/py.typed +0 -0
  446. bpy/ops/material/py.typed +0 -0
  447. bpy/ops/mball/py.typed +0 -0
  448. bpy/ops/mesh/py.typed +0 -0
  449. bpy/ops/nla/py.typed +0 -0
  450. bpy/ops/node/py.typed +0 -0
  451. bpy/ops/object/py.typed +0 -0
  452. bpy/ops/outliner/py.typed +0 -0
  453. bpy/ops/paint/py.typed +0 -0
  454. bpy/ops/paintcurve/py.typed +0 -0
  455. bpy/ops/palette/py.typed +0 -0
  456. bpy/ops/particle/py.typed +0 -0
  457. bpy/ops/pose/py.typed +0 -0
  458. bpy/ops/poselib/py.typed +0 -0
  459. bpy/ops/preferences/py.typed +0 -0
  460. bpy/ops/ptcache/py.typed +0 -0
  461. bpy/ops/py.typed +0 -0
  462. bpy/ops/render/py.typed +0 -0
  463. bpy/ops/rigidbody/py.typed +0 -0
  464. bpy/ops/scene/py.typed +0 -0
  465. bpy/ops/screen/py.typed +0 -0
  466. bpy/ops/script/py.typed +0 -0
  467. bpy/ops/sculpt/py.typed +0 -0
  468. bpy/ops/sculpt_curves/py.typed +0 -0
  469. bpy/ops/sequencer/py.typed +0 -0
  470. bpy/ops/sound/py.typed +0 -0
  471. bpy/ops/spreadsheet/py.typed +0 -0
  472. bpy/ops/surface/py.typed +0 -0
  473. bpy/ops/text/py.typed +0 -0
  474. bpy/ops/text_editor/py.typed +0 -0
  475. bpy/ops/texture/py.typed +0 -0
  476. bpy/ops/transform/py.typed +0 -0
  477. bpy/ops/ui/py.typed +0 -0
  478. bpy/ops/uilist/py.typed +0 -0
  479. bpy/ops/uv/py.typed +0 -0
  480. bpy/ops/view2d/py.typed +0 -0
  481. bpy/ops/view3d/py.typed +0 -0
  482. bpy/ops/wm/py.typed +0 -0
  483. bpy/ops/workspace/py.typed +0 -0
  484. bpy/ops/world/py.typed +0 -0
  485. bpy/path/py.typed +0 -0
  486. bpy/props/py.typed +0 -0
  487. bpy/types/py.typed +0 -0
  488. bpy/utils/previews/py.typed +0 -0
  489. bpy/utils/py.typed +0 -0
  490. bpy/utils/units/py.typed +0 -0
  491. bpy_extras/anim_utils/py.typed +0 -0
  492. bpy_extras/asset_utils/py.typed +0 -0
  493. bpy_extras/bmesh_utils/py.typed +0 -0
  494. bpy_extras/extensions/junction_module/py.typed +0 -0
  495. bpy_extras/extensions/py.typed +0 -0
  496. bpy_extras/id_map_utils/py.typed +0 -0
  497. bpy_extras/image_utils/py.typed +0 -0
  498. bpy_extras/io_utils/py.typed +0 -0
  499. bpy_extras/keyconfig_utils/py.typed +0 -0
  500. bpy_extras/mesh_utils/py.typed +0 -0
  501. bpy_extras/node_shader_utils/py.typed +0 -0
  502. bpy_extras/node_utils/py.typed +0 -0
  503. bpy_extras/object_utils/py.typed +0 -0
  504. bpy_extras/view3d_utils/py.typed +0 -0
  505. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  506. bpy_extras/wm_utils/py.typed +0 -0
  507. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  508. freestyle/chainingiterators/py.typed +0 -0
  509. freestyle/functions/py.typed +0 -0
  510. freestyle/predicates/py.typed +0 -0
  511. freestyle/shaders/py.typed +0 -0
  512. freestyle/types/py.typed +0 -0
  513. freestyle/utils/ContextFunctions/py.typed +0 -0
  514. freestyle/utils/py.typed +0 -0
  515. gpu/capabilities/py.typed +0 -0
  516. gpu/matrix/py.typed +0 -0
  517. gpu/platform/py.typed +0 -0
  518. gpu/select/py.typed +0 -0
  519. gpu/shader/py.typed +0 -0
  520. gpu/state/py.typed +0 -0
  521. gpu/texture/py.typed +0 -0
  522. gpu/types/py.typed +0 -0
  523. gpu_extras/batch/py.typed +0 -0
  524. gpu_extras/presets/py.typed +0 -0
  525. idprop/types/py.typed +0 -0
  526. imbuf/types/py.typed +0 -0
  527. mathutils/bvhtree/py.typed +0 -0
  528. mathutils/geometry/py.typed +0 -0
  529. mathutils/interpolate/py.typed +0 -0
  530. mathutils/kdtree/py.typed +0 -0
  531. mathutils/noise/py.typed +0 -0
  532. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/WHEEL +0 -0
  533. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240517.dist-info}/top_level.txt +0 -0
@@ -1,4 +1,5 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
  import rna_prop_ui
4
5
 
@@ -48,22 +49,35 @@ class BONE_PT_collections(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericU
48
49
  """ """
49
50
 
50
51
  def append(self, draw_func):
51
- """
52
+ """Append a draw function to this menu,
53
+ takes the same arguments as the menus draw function
52
54
 
53
- :param draw_func:
55
+ :param draw_func:
54
56
  """
55
57
  ...
56
58
 
57
- def as_pointer(self):
58
- """ """
59
+ def as_pointer(self) -> int:
60
+ """Returns the memory address which holds a pointer to Blender's internal data
61
+
62
+ :return: int (memory address).
63
+ :rtype: int
64
+ """
59
65
  ...
60
66
 
61
- def bl_rna_get_subclass(self):
62
- """ """
67
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
68
+ """
69
+
70
+ :return: The RNA type or default when not found.
71
+ :rtype: bpy.types.Struct
72
+ """
63
73
  ...
64
74
 
65
- def bl_rna_get_subclass_py(self):
66
- """ """
75
+ def bl_rna_get_subclass_py(self) -> typing.Any:
76
+ """
77
+
78
+ :return: The class or default when not found.
79
+ :rtype: typing.Any
80
+ """
67
81
  ...
68
82
 
69
83
  def draw(self, context):
@@ -73,72 +87,129 @@ class BONE_PT_collections(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericU
73
87
  """
74
88
  ...
75
89
 
76
- def driver_add(self):
77
- """ """
90
+ def driver_add(self) -> bpy.types.FCurve:
91
+ """Adds driver(s) to the given property
92
+
93
+ :return: The driver(s) added.
94
+ :rtype: bpy.types.FCurve
95
+ """
78
96
  ...
79
97
 
80
- def driver_remove(self):
81
- """ """
98
+ def driver_remove(self) -> bool:
99
+ """Remove driver(s) from the given property
100
+
101
+ :return: Success of driver removal.
102
+ :rtype: bool
103
+ """
82
104
  ...
83
105
 
84
106
  def get(self):
85
- """ """
107
+ """Returns the value of the custom property assigned to key or default
108
+ when not found (matches Python's dictionary function of the same name).
109
+
110
+ """
86
111
  ...
87
112
 
88
113
  def id_properties_clear(self):
89
- """ """
114
+ """
115
+
116
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
117
+ """
90
118
  ...
91
119
 
92
120
  def id_properties_ensure(self):
93
- """ """
121
+ """
122
+
123
+ :return: the parent group for an RNA struct's custom IDProperties.
124
+ """
94
125
  ...
95
126
 
96
127
  def id_properties_ui(self):
97
- """ """
128
+ """
129
+
130
+ :return: Return an object used to manage an IDProperty's UI data.
131
+ """
98
132
  ...
99
133
 
100
134
  def is_extended(self):
101
135
  """ """
102
136
  ...
103
137
 
104
- def is_property_hidden(self):
105
- """ """
138
+ def is_property_hidden(self) -> bool:
139
+ """Check if a property is hidden.
140
+
141
+ :return: True when the property is hidden.
142
+ :rtype: bool
143
+ """
106
144
  ...
107
145
 
108
- def is_property_overridable_library(self):
109
- """ """
146
+ def is_property_overridable_library(self) -> bool:
147
+ """Check if a property is overridable.
148
+
149
+ :return: True when the property is overridable.
150
+ :rtype: bool
151
+ """
110
152
  ...
111
153
 
112
- def is_property_readonly(self):
113
- """ """
154
+ def is_property_readonly(self) -> bool:
155
+ """Check if a property is readonly.
156
+
157
+ :return: True when the property is readonly (not writable).
158
+ :rtype: bool
159
+ """
114
160
  ...
115
161
 
116
- def is_property_set(self):
117
- """ """
162
+ def is_property_set(self) -> bool:
163
+ """Check if a property is set, use for testing operator properties.
164
+
165
+ :return: True when the property has been set.
166
+ :rtype: bool
167
+ """
118
168
  ...
119
169
 
120
170
  def items(self):
121
- """ """
171
+ """Returns the items of this objects custom properties (matches Python's
172
+ dictionary function of the same name).
173
+
174
+ :return: custom property key, value pairs.
175
+ """
122
176
  ...
123
177
 
124
- def keyframe_delete(self):
125
- """ """
178
+ def keyframe_delete(self) -> bool:
179
+ """Remove a keyframe from this properties fcurve.
180
+
181
+ :return: Success of keyframe deletion.
182
+ :rtype: bool
183
+ """
126
184
  ...
127
185
 
128
- def keyframe_insert(self):
129
- """ """
186
+ def keyframe_insert(self) -> bool:
187
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
188
+
189
+ :return: Success of keyframe insertion.
190
+ :rtype: bool
191
+ """
130
192
  ...
131
193
 
132
194
  def keys(self):
133
- """ """
195
+ """Returns the keys of this objects custom properties (matches Python's
196
+ dictionary function of the same name).
197
+
198
+ :return: custom property keys.
199
+ """
134
200
  ...
135
201
 
136
- def path_from_id(self):
137
- """ """
202
+ def path_from_id(self) -> str:
203
+ """Returns the data path from the ID to this object (string).
204
+
205
+ :return: The path from `bpy.types.bpy_struct.id_data`
206
+ to this struct and property (when given).
207
+ :rtype: str
208
+ """
138
209
  ...
139
210
 
140
211
  def path_resolve(self):
141
- """ """
212
+ """Returns the property from the path, raise an exception when not found."""
142
213
  ...
143
214
 
144
215
  def poll(self, context):
@@ -149,37 +220,53 @@ class BONE_PT_collections(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericU
149
220
  ...
150
221
 
151
222
  def pop(self):
152
- """ """
223
+ """Remove and return the value of the custom property assigned to key or default
224
+ when not found (matches Python's dictionary function of the same name).
225
+
226
+ """
153
227
  ...
154
228
 
155
229
  def prepend(self, draw_func):
156
- """
230
+ """Prepend a draw function to this menu, takes the same arguments as
231
+ the menus draw function
157
232
 
158
- :param draw_func:
233
+ :param draw_func:
159
234
  """
160
235
  ...
161
236
 
162
- def property_overridable_library_set(self):
163
- """ """
237
+ def property_overridable_library_set(self) -> bool:
238
+ """Define a property as overridable or not (only for custom properties!).
239
+
240
+ :return: True when the overridable status of the property was successfully set.
241
+ :rtype: bool
242
+ """
164
243
  ...
165
244
 
166
245
  def property_unset(self):
167
- """ """
246
+ """Unset a property, will use default value afterward."""
168
247
  ...
169
248
 
170
249
  def remove(self, draw_func):
171
- """
250
+ """Remove a draw function that has been added to this menu
172
251
 
173
252
  :param draw_func:
174
253
  """
175
254
  ...
176
255
 
177
256
  def type_recast(self):
178
- """ """
257
+ """Return a new instance, this is needed because types
258
+ such as textures can be changed at runtime.
259
+
260
+ :return: a new instance of this object with the type initialized again.
261
+ """
179
262
  ...
180
263
 
181
264
  def values(self):
182
- """ """
265
+ """Returns the values of this objects custom properties (matches Python's
266
+ dictionary function of the same name).
267
+
268
+ :return: custom property values.
269
+ """
183
270
  ...
184
271
 
185
272
  class BONE_PT_context_bone(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
@@ -207,22 +294,35 @@ class BONE_PT_context_bone(bpy_types.Panel, BoneButtonsPanel, bpy_types._Generic
207
294
  """ """
208
295
 
209
296
  def append(self, draw_func):
210
- """
297
+ """Append a draw function to this menu,
298
+ takes the same arguments as the menus draw function
211
299
 
212
- :param draw_func:
300
+ :param draw_func:
213
301
  """
214
302
  ...
215
303
 
216
- def as_pointer(self):
217
- """ """
304
+ def as_pointer(self) -> int:
305
+ """Returns the memory address which holds a pointer to Blender's internal data
306
+
307
+ :return: int (memory address).
308
+ :rtype: int
309
+ """
218
310
  ...
219
311
 
220
- def bl_rna_get_subclass(self):
221
- """ """
312
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
313
+ """
314
+
315
+ :return: The RNA type or default when not found.
316
+ :rtype: bpy.types.Struct
317
+ """
222
318
  ...
223
319
 
224
- def bl_rna_get_subclass_py(self):
225
- """ """
320
+ def bl_rna_get_subclass_py(self) -> typing.Any:
321
+ """
322
+
323
+ :return: The class or default when not found.
324
+ :rtype: typing.Any
325
+ """
226
326
  ...
227
327
 
228
328
  def draw(self, context):
@@ -232,72 +332,129 @@ class BONE_PT_context_bone(bpy_types.Panel, BoneButtonsPanel, bpy_types._Generic
232
332
  """
233
333
  ...
234
334
 
235
- def driver_add(self):
236
- """ """
335
+ def driver_add(self) -> bpy.types.FCurve:
336
+ """Adds driver(s) to the given property
337
+
338
+ :return: The driver(s) added.
339
+ :rtype: bpy.types.FCurve
340
+ """
237
341
  ...
238
342
 
239
- def driver_remove(self):
240
- """ """
343
+ def driver_remove(self) -> bool:
344
+ """Remove driver(s) from the given property
345
+
346
+ :return: Success of driver removal.
347
+ :rtype: bool
348
+ """
241
349
  ...
242
350
 
243
351
  def get(self):
244
- """ """
352
+ """Returns the value of the custom property assigned to key or default
353
+ when not found (matches Python's dictionary function of the same name).
354
+
355
+ """
245
356
  ...
246
357
 
247
358
  def id_properties_clear(self):
248
- """ """
359
+ """
360
+
361
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
362
+ """
249
363
  ...
250
364
 
251
365
  def id_properties_ensure(self):
252
- """ """
366
+ """
367
+
368
+ :return: the parent group for an RNA struct's custom IDProperties.
369
+ """
253
370
  ...
254
371
 
255
372
  def id_properties_ui(self):
256
- """ """
373
+ """
374
+
375
+ :return: Return an object used to manage an IDProperty's UI data.
376
+ """
257
377
  ...
258
378
 
259
379
  def is_extended(self):
260
380
  """ """
261
381
  ...
262
382
 
263
- def is_property_hidden(self):
264
- """ """
383
+ def is_property_hidden(self) -> bool:
384
+ """Check if a property is hidden.
385
+
386
+ :return: True when the property is hidden.
387
+ :rtype: bool
388
+ """
265
389
  ...
266
390
 
267
- def is_property_overridable_library(self):
268
- """ """
391
+ def is_property_overridable_library(self) -> bool:
392
+ """Check if a property is overridable.
393
+
394
+ :return: True when the property is overridable.
395
+ :rtype: bool
396
+ """
269
397
  ...
270
398
 
271
- def is_property_readonly(self):
272
- """ """
399
+ def is_property_readonly(self) -> bool:
400
+ """Check if a property is readonly.
401
+
402
+ :return: True when the property is readonly (not writable).
403
+ :rtype: bool
404
+ """
273
405
  ...
274
406
 
275
- def is_property_set(self):
276
- """ """
407
+ def is_property_set(self) -> bool:
408
+ """Check if a property is set, use for testing operator properties.
409
+
410
+ :return: True when the property has been set.
411
+ :rtype: bool
412
+ """
277
413
  ...
278
414
 
279
415
  def items(self):
280
- """ """
416
+ """Returns the items of this objects custom properties (matches Python's
417
+ dictionary function of the same name).
418
+
419
+ :return: custom property key, value pairs.
420
+ """
281
421
  ...
282
422
 
283
- def keyframe_delete(self):
284
- """ """
423
+ def keyframe_delete(self) -> bool:
424
+ """Remove a keyframe from this properties fcurve.
425
+
426
+ :return: Success of keyframe deletion.
427
+ :rtype: bool
428
+ """
285
429
  ...
286
430
 
287
- def keyframe_insert(self):
288
- """ """
431
+ def keyframe_insert(self) -> bool:
432
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
433
+
434
+ :return: Success of keyframe insertion.
435
+ :rtype: bool
436
+ """
289
437
  ...
290
438
 
291
439
  def keys(self):
292
- """ """
440
+ """Returns the keys of this objects custom properties (matches Python's
441
+ dictionary function of the same name).
442
+
443
+ :return: custom property keys.
444
+ """
293
445
  ...
294
446
 
295
- def path_from_id(self):
296
- """ """
447
+ def path_from_id(self) -> str:
448
+ """Returns the data path from the ID to this object (string).
449
+
450
+ :return: The path from `bpy.types.bpy_struct.id_data`
451
+ to this struct and property (when given).
452
+ :rtype: str
453
+ """
297
454
  ...
298
455
 
299
456
  def path_resolve(self):
300
- """ """
457
+ """Returns the property from the path, raise an exception when not found."""
301
458
  ...
302
459
 
303
460
  def poll(self, context):
@@ -308,37 +465,53 @@ class BONE_PT_context_bone(bpy_types.Panel, BoneButtonsPanel, bpy_types._Generic
308
465
  ...
309
466
 
310
467
  def pop(self):
311
- """ """
468
+ """Remove and return the value of the custom property assigned to key or default
469
+ when not found (matches Python's dictionary function of the same name).
470
+
471
+ """
312
472
  ...
313
473
 
314
474
  def prepend(self, draw_func):
315
- """
475
+ """Prepend a draw function to this menu, takes the same arguments as
476
+ the menus draw function
316
477
 
317
- :param draw_func:
478
+ :param draw_func:
318
479
  """
319
480
  ...
320
481
 
321
- def property_overridable_library_set(self):
322
- """ """
482
+ def property_overridable_library_set(self) -> bool:
483
+ """Define a property as overridable or not (only for custom properties!).
484
+
485
+ :return: True when the overridable status of the property was successfully set.
486
+ :rtype: bool
487
+ """
323
488
  ...
324
489
 
325
490
  def property_unset(self):
326
- """ """
491
+ """Unset a property, will use default value afterward."""
327
492
  ...
328
493
 
329
494
  def remove(self, draw_func):
330
- """
495
+ """Remove a draw function that has been added to this menu
331
496
 
332
497
  :param draw_func:
333
498
  """
334
499
  ...
335
500
 
336
501
  def type_recast(self):
337
- """ """
502
+ """Return a new instance, this is needed because types
503
+ such as textures can be changed at runtime.
504
+
505
+ :return: a new instance of this object with the type initialized again.
506
+ """
338
507
  ...
339
508
 
340
509
  def values(self):
341
- """ """
510
+ """Returns the values of this objects custom properties (matches Python's
511
+ dictionary function of the same name).
512
+
513
+ :return: custom property values.
514
+ """
342
515
  ...
343
516
 
344
517
  class BONE_PT_curved(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
@@ -366,22 +539,35 @@ class BONE_PT_curved(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
366
539
  """ """
367
540
 
368
541
  def append(self, draw_func):
369
- """
542
+ """Append a draw function to this menu,
543
+ takes the same arguments as the menus draw function
370
544
 
371
- :param draw_func:
545
+ :param draw_func:
372
546
  """
373
547
  ...
374
548
 
375
- def as_pointer(self):
376
- """ """
549
+ def as_pointer(self) -> int:
550
+ """Returns the memory address which holds a pointer to Blender's internal data
551
+
552
+ :return: int (memory address).
553
+ :rtype: int
554
+ """
377
555
  ...
378
556
 
379
- def bl_rna_get_subclass(self):
380
- """ """
557
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
558
+ """
559
+
560
+ :return: The RNA type or default when not found.
561
+ :rtype: bpy.types.Struct
562
+ """
381
563
  ...
382
564
 
383
- def bl_rna_get_subclass_py(self):
384
- """ """
565
+ def bl_rna_get_subclass_py(self) -> typing.Any:
566
+ """
567
+
568
+ :return: The class or default when not found.
569
+ :rtype: typing.Any
570
+ """
385
571
  ...
386
572
 
387
573
  def draw(self, context):
@@ -391,72 +577,129 @@ class BONE_PT_curved(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
391
577
  """
392
578
  ...
393
579
 
394
- def driver_add(self):
395
- """ """
580
+ def driver_add(self) -> bpy.types.FCurve:
581
+ """Adds driver(s) to the given property
582
+
583
+ :return: The driver(s) added.
584
+ :rtype: bpy.types.FCurve
585
+ """
396
586
  ...
397
587
 
398
- def driver_remove(self):
399
- """ """
588
+ def driver_remove(self) -> bool:
589
+ """Remove driver(s) from the given property
590
+
591
+ :return: Success of driver removal.
592
+ :rtype: bool
593
+ """
400
594
  ...
401
595
 
402
596
  def get(self):
403
- """ """
597
+ """Returns the value of the custom property assigned to key or default
598
+ when not found (matches Python's dictionary function of the same name).
599
+
600
+ """
404
601
  ...
405
602
 
406
603
  def id_properties_clear(self):
407
- """ """
604
+ """
605
+
606
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
607
+ """
408
608
  ...
409
609
 
410
610
  def id_properties_ensure(self):
411
- """ """
611
+ """
612
+
613
+ :return: the parent group for an RNA struct's custom IDProperties.
614
+ """
412
615
  ...
413
616
 
414
617
  def id_properties_ui(self):
415
- """ """
618
+ """
619
+
620
+ :return: Return an object used to manage an IDProperty's UI data.
621
+ """
416
622
  ...
417
623
 
418
624
  def is_extended(self):
419
625
  """ """
420
626
  ...
421
627
 
422
- def is_property_hidden(self):
423
- """ """
628
+ def is_property_hidden(self) -> bool:
629
+ """Check if a property is hidden.
630
+
631
+ :return: True when the property is hidden.
632
+ :rtype: bool
633
+ """
424
634
  ...
425
635
 
426
- def is_property_overridable_library(self):
427
- """ """
636
+ def is_property_overridable_library(self) -> bool:
637
+ """Check if a property is overridable.
638
+
639
+ :return: True when the property is overridable.
640
+ :rtype: bool
641
+ """
428
642
  ...
429
643
 
430
- def is_property_readonly(self):
431
- """ """
644
+ def is_property_readonly(self) -> bool:
645
+ """Check if a property is readonly.
646
+
647
+ :return: True when the property is readonly (not writable).
648
+ :rtype: bool
649
+ """
432
650
  ...
433
651
 
434
- def is_property_set(self):
435
- """ """
652
+ def is_property_set(self) -> bool:
653
+ """Check if a property is set, use for testing operator properties.
654
+
655
+ :return: True when the property has been set.
656
+ :rtype: bool
657
+ """
436
658
  ...
437
659
 
438
660
  def items(self):
439
- """ """
661
+ """Returns the items of this objects custom properties (matches Python's
662
+ dictionary function of the same name).
663
+
664
+ :return: custom property key, value pairs.
665
+ """
440
666
  ...
441
667
 
442
- def keyframe_delete(self):
443
- """ """
668
+ def keyframe_delete(self) -> bool:
669
+ """Remove a keyframe from this properties fcurve.
670
+
671
+ :return: Success of keyframe deletion.
672
+ :rtype: bool
673
+ """
444
674
  ...
445
675
 
446
- def keyframe_insert(self):
447
- """ """
676
+ def keyframe_insert(self) -> bool:
677
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
678
+
679
+ :return: Success of keyframe insertion.
680
+ :rtype: bool
681
+ """
448
682
  ...
449
683
 
450
684
  def keys(self):
451
- """ """
685
+ """Returns the keys of this objects custom properties (matches Python's
686
+ dictionary function of the same name).
687
+
688
+ :return: custom property keys.
689
+ """
452
690
  ...
453
691
 
454
- def path_from_id(self):
455
- """ """
692
+ def path_from_id(self) -> str:
693
+ """Returns the data path from the ID to this object (string).
694
+
695
+ :return: The path from `bpy.types.bpy_struct.id_data`
696
+ to this struct and property (when given).
697
+ :rtype: str
698
+ """
456
699
  ...
457
700
 
458
701
  def path_resolve(self):
459
- """ """
702
+ """Returns the property from the path, raise an exception when not found."""
460
703
  ...
461
704
 
462
705
  def poll(self, context):
@@ -467,43 +710,61 @@ class BONE_PT_curved(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
467
710
  ...
468
711
 
469
712
  def pop(self):
470
- """ """
713
+ """Remove and return the value of the custom property assigned to key or default
714
+ when not found (matches Python's dictionary function of the same name).
715
+
716
+ """
471
717
  ...
472
718
 
473
719
  def prepend(self, draw_func):
474
- """
720
+ """Prepend a draw function to this menu, takes the same arguments as
721
+ the menus draw function
475
722
 
476
- :param draw_func:
723
+ :param draw_func:
477
724
  """
478
725
  ...
479
726
 
480
- def property_overridable_library_set(self):
481
- """ """
727
+ def property_overridable_library_set(self) -> bool:
728
+ """Define a property as overridable or not (only for custom properties!).
729
+
730
+ :return: True when the overridable status of the property was successfully set.
731
+ :rtype: bool
732
+ """
482
733
  ...
483
734
 
484
735
  def property_unset(self):
485
- """ """
736
+ """Unset a property, will use default value afterward."""
486
737
  ...
487
738
 
488
739
  def remove(self, draw_func):
489
- """
740
+ """Remove a draw function that has been added to this menu
490
741
 
491
742
  :param draw_func:
492
743
  """
493
744
  ...
494
745
 
495
746
  def type_recast(self):
496
- """ """
747
+ """Return a new instance, this is needed because types
748
+ such as textures can be changed at runtime.
749
+
750
+ :return: a new instance of this object with the type initialized again.
751
+ """
497
752
  ...
498
753
 
499
754
  def values(self):
500
- """ """
755
+ """Returns the values of this objects custom properties (matches Python's
756
+ dictionary function of the same name).
757
+
758
+ :return: custom property values.
759
+ """
501
760
  ...
502
761
 
503
762
  class BONE_PT_custom_props(
504
763
  bpy_types.Panel, BoneButtonsPanel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
505
764
  ):
506
- """ """
765
+ """The subclass should have its own poll function
766
+ and the variable '_context_path' MUST be set.
767
+ """
507
768
 
508
769
  COMPAT_ENGINES: typing.Any
509
770
  """ """
@@ -533,22 +794,35 @@ class BONE_PT_custom_props(
533
794
  """ """
534
795
 
535
796
  def append(self, draw_func):
536
- """
797
+ """Append a draw function to this menu,
798
+ takes the same arguments as the menus draw function
537
799
 
538
- :param draw_func:
800
+ :param draw_func:
539
801
  """
540
802
  ...
541
803
 
542
- def as_pointer(self):
543
- """ """
804
+ def as_pointer(self) -> int:
805
+ """Returns the memory address which holds a pointer to Blender's internal data
806
+
807
+ :return: int (memory address).
808
+ :rtype: int
809
+ """
544
810
  ...
545
811
 
546
- def bl_rna_get_subclass(self):
547
- """ """
812
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
813
+ """
814
+
815
+ :return: The RNA type or default when not found.
816
+ :rtype: bpy.types.Struct
817
+ """
548
818
  ...
549
819
 
550
- def bl_rna_get_subclass_py(self):
551
- """ """
820
+ def bl_rna_get_subclass_py(self) -> typing.Any:
821
+ """
822
+
823
+ :return: The class or default when not found.
824
+ :rtype: typing.Any
825
+ """
552
826
  ...
553
827
 
554
828
  def draw(self, context):
@@ -558,72 +832,129 @@ class BONE_PT_custom_props(
558
832
  """
559
833
  ...
560
834
 
561
- def driver_add(self):
562
- """ """
835
+ def driver_add(self) -> bpy.types.FCurve:
836
+ """Adds driver(s) to the given property
837
+
838
+ :return: The driver(s) added.
839
+ :rtype: bpy.types.FCurve
840
+ """
563
841
  ...
564
842
 
565
- def driver_remove(self):
566
- """ """
843
+ def driver_remove(self) -> bool:
844
+ """Remove driver(s) from the given property
845
+
846
+ :return: Success of driver removal.
847
+ :rtype: bool
848
+ """
567
849
  ...
568
850
 
569
851
  def get(self):
570
- """ """
852
+ """Returns the value of the custom property assigned to key or default
853
+ when not found (matches Python's dictionary function of the same name).
854
+
855
+ """
571
856
  ...
572
857
 
573
858
  def id_properties_clear(self):
574
- """ """
859
+ """
860
+
861
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
862
+ """
575
863
  ...
576
864
 
577
865
  def id_properties_ensure(self):
578
- """ """
866
+ """
867
+
868
+ :return: the parent group for an RNA struct's custom IDProperties.
869
+ """
579
870
  ...
580
871
 
581
872
  def id_properties_ui(self):
582
- """ """
873
+ """
874
+
875
+ :return: Return an object used to manage an IDProperty's UI data.
876
+ """
583
877
  ...
584
878
 
585
879
  def is_extended(self):
586
880
  """ """
587
881
  ...
588
882
 
589
- def is_property_hidden(self):
590
- """ """
591
- ...
883
+ def is_property_hidden(self) -> bool:
884
+ """Check if a property is hidden.
885
+
886
+ :return: True when the property is hidden.
887
+ :rtype: bool
888
+ """
889
+ ...
890
+
891
+ def is_property_overridable_library(self) -> bool:
892
+ """Check if a property is overridable.
893
+
894
+ :return: True when the property is overridable.
895
+ :rtype: bool
896
+ """
897
+ ...
898
+
899
+ def is_property_readonly(self) -> bool:
900
+ """Check if a property is readonly.
592
901
 
593
- def is_property_overridable_library(self):
594
- """ """
902
+ :return: True when the property is readonly (not writable).
903
+ :rtype: bool
904
+ """
595
905
  ...
596
906
 
597
- def is_property_readonly(self):
598
- """ """
599
- ...
907
+ def is_property_set(self) -> bool:
908
+ """Check if a property is set, use for testing operator properties.
600
909
 
601
- def is_property_set(self):
602
- """ """
910
+ :return: True when the property has been set.
911
+ :rtype: bool
912
+ """
603
913
  ...
604
914
 
605
915
  def items(self):
606
- """ """
916
+ """Returns the items of this objects custom properties (matches Python's
917
+ dictionary function of the same name).
918
+
919
+ :return: custom property key, value pairs.
920
+ """
607
921
  ...
608
922
 
609
- def keyframe_delete(self):
610
- """ """
923
+ def keyframe_delete(self) -> bool:
924
+ """Remove a keyframe from this properties fcurve.
925
+
926
+ :return: Success of keyframe deletion.
927
+ :rtype: bool
928
+ """
611
929
  ...
612
930
 
613
- def keyframe_insert(self):
614
- """ """
931
+ def keyframe_insert(self) -> bool:
932
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
933
+
934
+ :return: Success of keyframe insertion.
935
+ :rtype: bool
936
+ """
615
937
  ...
616
938
 
617
939
  def keys(self):
618
- """ """
940
+ """Returns the keys of this objects custom properties (matches Python's
941
+ dictionary function of the same name).
942
+
943
+ :return: custom property keys.
944
+ """
619
945
  ...
620
946
 
621
- def path_from_id(self):
622
- """ """
947
+ def path_from_id(self) -> str:
948
+ """Returns the data path from the ID to this object (string).
949
+
950
+ :return: The path from `bpy.types.bpy_struct.id_data`
951
+ to this struct and property (when given).
952
+ :rtype: str
953
+ """
623
954
  ...
624
955
 
625
956
  def path_resolve(self):
626
- """ """
957
+ """Returns the property from the path, raise an exception when not found."""
627
958
  ...
628
959
 
629
960
  def poll(self, context):
@@ -634,37 +965,53 @@ class BONE_PT_custom_props(
634
965
  ...
635
966
 
636
967
  def pop(self):
637
- """ """
968
+ """Remove and return the value of the custom property assigned to key or default
969
+ when not found (matches Python's dictionary function of the same name).
970
+
971
+ """
638
972
  ...
639
973
 
640
974
  def prepend(self, draw_func):
641
- """
975
+ """Prepend a draw function to this menu, takes the same arguments as
976
+ the menus draw function
642
977
 
643
- :param draw_func:
978
+ :param draw_func:
644
979
  """
645
980
  ...
646
981
 
647
- def property_overridable_library_set(self):
648
- """ """
982
+ def property_overridable_library_set(self) -> bool:
983
+ """Define a property as overridable or not (only for custom properties!).
984
+
985
+ :return: True when the overridable status of the property was successfully set.
986
+ :rtype: bool
987
+ """
649
988
  ...
650
989
 
651
990
  def property_unset(self):
652
- """ """
991
+ """Unset a property, will use default value afterward."""
653
992
  ...
654
993
 
655
994
  def remove(self, draw_func):
656
- """
995
+ """Remove a draw function that has been added to this menu
657
996
 
658
997
  :param draw_func:
659
998
  """
660
999
  ...
661
1000
 
662
1001
  def type_recast(self):
663
- """ """
1002
+ """Return a new instance, this is needed because types
1003
+ such as textures can be changed at runtime.
1004
+
1005
+ :return: a new instance of this object with the type initialized again.
1006
+ """
664
1007
  ...
665
1008
 
666
1009
  def values(self):
667
- """ """
1010
+ """Returns the values of this objects custom properties (matches Python's
1011
+ dictionary function of the same name).
1012
+
1013
+ :return: custom property values.
1014
+ """
668
1015
  ...
669
1016
 
670
1017
  class BONE_PT_deform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
@@ -692,22 +1039,35 @@ class BONE_PT_deform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
692
1039
  """ """
693
1040
 
694
1041
  def append(self, draw_func):
695
- """
1042
+ """Append a draw function to this menu,
1043
+ takes the same arguments as the menus draw function
696
1044
 
697
- :param draw_func:
1045
+ :param draw_func:
698
1046
  """
699
1047
  ...
700
1048
 
701
- def as_pointer(self):
702
- """ """
1049
+ def as_pointer(self) -> int:
1050
+ """Returns the memory address which holds a pointer to Blender's internal data
1051
+
1052
+ :return: int (memory address).
1053
+ :rtype: int
1054
+ """
703
1055
  ...
704
1056
 
705
- def bl_rna_get_subclass(self):
706
- """ """
1057
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1058
+ """
1059
+
1060
+ :return: The RNA type or default when not found.
1061
+ :rtype: bpy.types.Struct
1062
+ """
707
1063
  ...
708
1064
 
709
- def bl_rna_get_subclass_py(self):
710
- """ """
1065
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1066
+ """
1067
+
1068
+ :return: The class or default when not found.
1069
+ :rtype: typing.Any
1070
+ """
711
1071
  ...
712
1072
 
713
1073
  def draw(self, context):
@@ -724,72 +1084,129 @@ class BONE_PT_deform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
724
1084
  """
725
1085
  ...
726
1086
 
727
- def driver_add(self):
728
- """ """
1087
+ def driver_add(self) -> bpy.types.FCurve:
1088
+ """Adds driver(s) to the given property
1089
+
1090
+ :return: The driver(s) added.
1091
+ :rtype: bpy.types.FCurve
1092
+ """
729
1093
  ...
730
1094
 
731
- def driver_remove(self):
732
- """ """
1095
+ def driver_remove(self) -> bool:
1096
+ """Remove driver(s) from the given property
1097
+
1098
+ :return: Success of driver removal.
1099
+ :rtype: bool
1100
+ """
733
1101
  ...
734
1102
 
735
1103
  def get(self):
736
- """ """
1104
+ """Returns the value of the custom property assigned to key or default
1105
+ when not found (matches Python's dictionary function of the same name).
1106
+
1107
+ """
737
1108
  ...
738
1109
 
739
1110
  def id_properties_clear(self):
740
- """ """
1111
+ """
1112
+
1113
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1114
+ """
741
1115
  ...
742
1116
 
743
1117
  def id_properties_ensure(self):
744
- """ """
1118
+ """
1119
+
1120
+ :return: the parent group for an RNA struct's custom IDProperties.
1121
+ """
745
1122
  ...
746
1123
 
747
1124
  def id_properties_ui(self):
748
- """ """
1125
+ """
1126
+
1127
+ :return: Return an object used to manage an IDProperty's UI data.
1128
+ """
749
1129
  ...
750
1130
 
751
1131
  def is_extended(self):
752
1132
  """ """
753
1133
  ...
754
1134
 
755
- def is_property_hidden(self):
756
- """ """
1135
+ def is_property_hidden(self) -> bool:
1136
+ """Check if a property is hidden.
1137
+
1138
+ :return: True when the property is hidden.
1139
+ :rtype: bool
1140
+ """
757
1141
  ...
758
1142
 
759
- def is_property_overridable_library(self):
760
- """ """
1143
+ def is_property_overridable_library(self) -> bool:
1144
+ """Check if a property is overridable.
1145
+
1146
+ :return: True when the property is overridable.
1147
+ :rtype: bool
1148
+ """
761
1149
  ...
762
1150
 
763
- def is_property_readonly(self):
764
- """ """
1151
+ def is_property_readonly(self) -> bool:
1152
+ """Check if a property is readonly.
1153
+
1154
+ :return: True when the property is readonly (not writable).
1155
+ :rtype: bool
1156
+ """
765
1157
  ...
766
1158
 
767
- def is_property_set(self):
768
- """ """
1159
+ def is_property_set(self) -> bool:
1160
+ """Check if a property is set, use for testing operator properties.
1161
+
1162
+ :return: True when the property has been set.
1163
+ :rtype: bool
1164
+ """
769
1165
  ...
770
1166
 
771
1167
  def items(self):
772
- """ """
1168
+ """Returns the items of this objects custom properties (matches Python's
1169
+ dictionary function of the same name).
1170
+
1171
+ :return: custom property key, value pairs.
1172
+ """
773
1173
  ...
774
1174
 
775
- def keyframe_delete(self):
776
- """ """
1175
+ def keyframe_delete(self) -> bool:
1176
+ """Remove a keyframe from this properties fcurve.
1177
+
1178
+ :return: Success of keyframe deletion.
1179
+ :rtype: bool
1180
+ """
777
1181
  ...
778
1182
 
779
- def keyframe_insert(self):
780
- """ """
1183
+ def keyframe_insert(self) -> bool:
1184
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1185
+
1186
+ :return: Success of keyframe insertion.
1187
+ :rtype: bool
1188
+ """
781
1189
  ...
782
1190
 
783
1191
  def keys(self):
784
- """ """
1192
+ """Returns the keys of this objects custom properties (matches Python's
1193
+ dictionary function of the same name).
1194
+
1195
+ :return: custom property keys.
1196
+ """
785
1197
  ...
786
1198
 
787
- def path_from_id(self):
788
- """ """
1199
+ def path_from_id(self) -> str:
1200
+ """Returns the data path from the ID to this object (string).
1201
+
1202
+ :return: The path from `bpy.types.bpy_struct.id_data`
1203
+ to this struct and property (when given).
1204
+ :rtype: str
1205
+ """
789
1206
  ...
790
1207
 
791
1208
  def path_resolve(self):
792
- """ """
1209
+ """Returns the property from the path, raise an exception when not found."""
793
1210
  ...
794
1211
 
795
1212
  def poll(self, context):
@@ -800,37 +1217,53 @@ class BONE_PT_deform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
800
1217
  ...
801
1218
 
802
1219
  def pop(self):
803
- """ """
1220
+ """Remove and return the value of the custom property assigned to key or default
1221
+ when not found (matches Python's dictionary function of the same name).
1222
+
1223
+ """
804
1224
  ...
805
1225
 
806
1226
  def prepend(self, draw_func):
807
- """
1227
+ """Prepend a draw function to this menu, takes the same arguments as
1228
+ the menus draw function
808
1229
 
809
- :param draw_func:
1230
+ :param draw_func:
810
1231
  """
811
1232
  ...
812
1233
 
813
- def property_overridable_library_set(self):
814
- """ """
1234
+ def property_overridable_library_set(self) -> bool:
1235
+ """Define a property as overridable or not (only for custom properties!).
1236
+
1237
+ :return: True when the overridable status of the property was successfully set.
1238
+ :rtype: bool
1239
+ """
815
1240
  ...
816
1241
 
817
1242
  def property_unset(self):
818
- """ """
1243
+ """Unset a property, will use default value afterward."""
819
1244
  ...
820
1245
 
821
1246
  def remove(self, draw_func):
822
- """
1247
+ """Remove a draw function that has been added to this menu
823
1248
 
824
1249
  :param draw_func:
825
1250
  """
826
1251
  ...
827
1252
 
828
1253
  def type_recast(self):
829
- """ """
1254
+ """Return a new instance, this is needed because types
1255
+ such as textures can be changed at runtime.
1256
+
1257
+ :return: a new instance of this object with the type initialized again.
1258
+ """
830
1259
  ...
831
1260
 
832
1261
  def values(self):
833
- """ """
1262
+ """Returns the values of this objects custom properties (matches Python's
1263
+ dictionary function of the same name).
1264
+
1265
+ :return: custom property values.
1266
+ """
834
1267
  ...
835
1268
 
836
1269
  class BONE_PT_display(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
@@ -858,22 +1291,35 @@ class BONE_PT_display(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
858
1291
  """ """
859
1292
 
860
1293
  def append(self, draw_func):
861
- """
1294
+ """Append a draw function to this menu,
1295
+ takes the same arguments as the menus draw function
862
1296
 
863
- :param draw_func:
1297
+ :param draw_func:
864
1298
  """
865
1299
  ...
866
1300
 
867
- def as_pointer(self):
868
- """ """
1301
+ def as_pointer(self) -> int:
1302
+ """Returns the memory address which holds a pointer to Blender's internal data
1303
+
1304
+ :return: int (memory address).
1305
+ :rtype: int
1306
+ """
869
1307
  ...
870
1308
 
871
- def bl_rna_get_subclass(self):
872
- """ """
1309
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1310
+ """
1311
+
1312
+ :return: The RNA type or default when not found.
1313
+ :rtype: bpy.types.Struct
1314
+ """
873
1315
  ...
874
1316
 
875
- def bl_rna_get_subclass_py(self):
876
- """ """
1317
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1318
+ """
1319
+
1320
+ :return: The class or default when not found.
1321
+ :rtype: typing.Any
1322
+ """
877
1323
  ...
878
1324
 
879
1325
  def draw(self, context):
@@ -907,72 +1353,129 @@ class BONE_PT_display(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
907
1353
  """
908
1354
  ...
909
1355
 
910
- def driver_add(self):
911
- """ """
1356
+ def driver_add(self) -> bpy.types.FCurve:
1357
+ """Adds driver(s) to the given property
1358
+
1359
+ :return: The driver(s) added.
1360
+ :rtype: bpy.types.FCurve
1361
+ """
912
1362
  ...
913
1363
 
914
- def driver_remove(self):
915
- """ """
1364
+ def driver_remove(self) -> bool:
1365
+ """Remove driver(s) from the given property
1366
+
1367
+ :return: Success of driver removal.
1368
+ :rtype: bool
1369
+ """
916
1370
  ...
917
1371
 
918
1372
  def get(self):
919
- """ """
1373
+ """Returns the value of the custom property assigned to key or default
1374
+ when not found (matches Python's dictionary function of the same name).
1375
+
1376
+ """
920
1377
  ...
921
1378
 
922
1379
  def id_properties_clear(self):
923
- """ """
1380
+ """
1381
+
1382
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1383
+ """
924
1384
  ...
925
1385
 
926
1386
  def id_properties_ensure(self):
927
- """ """
1387
+ """
1388
+
1389
+ :return: the parent group for an RNA struct's custom IDProperties.
1390
+ """
928
1391
  ...
929
1392
 
930
1393
  def id_properties_ui(self):
931
- """ """
1394
+ """
1395
+
1396
+ :return: Return an object used to manage an IDProperty's UI data.
1397
+ """
932
1398
  ...
933
1399
 
934
1400
  def is_extended(self):
935
1401
  """ """
936
1402
  ...
937
1403
 
938
- def is_property_hidden(self):
939
- """ """
1404
+ def is_property_hidden(self) -> bool:
1405
+ """Check if a property is hidden.
1406
+
1407
+ :return: True when the property is hidden.
1408
+ :rtype: bool
1409
+ """
940
1410
  ...
941
1411
 
942
- def is_property_overridable_library(self):
943
- """ """
1412
+ def is_property_overridable_library(self) -> bool:
1413
+ """Check if a property is overridable.
1414
+
1415
+ :return: True when the property is overridable.
1416
+ :rtype: bool
1417
+ """
944
1418
  ...
945
1419
 
946
- def is_property_readonly(self):
947
- """ """
1420
+ def is_property_readonly(self) -> bool:
1421
+ """Check if a property is readonly.
1422
+
1423
+ :return: True when the property is readonly (not writable).
1424
+ :rtype: bool
1425
+ """
948
1426
  ...
949
1427
 
950
- def is_property_set(self):
951
- """ """
1428
+ def is_property_set(self) -> bool:
1429
+ """Check if a property is set, use for testing operator properties.
1430
+
1431
+ :return: True when the property has been set.
1432
+ :rtype: bool
1433
+ """
952
1434
  ...
953
1435
 
954
1436
  def items(self):
955
- """ """
1437
+ """Returns the items of this objects custom properties (matches Python's
1438
+ dictionary function of the same name).
1439
+
1440
+ :return: custom property key, value pairs.
1441
+ """
956
1442
  ...
957
1443
 
958
- def keyframe_delete(self):
959
- """ """
1444
+ def keyframe_delete(self) -> bool:
1445
+ """Remove a keyframe from this properties fcurve.
1446
+
1447
+ :return: Success of keyframe deletion.
1448
+ :rtype: bool
1449
+ """
960
1450
  ...
961
1451
 
962
- def keyframe_insert(self):
963
- """ """
1452
+ def keyframe_insert(self) -> bool:
1453
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1454
+
1455
+ :return: Success of keyframe insertion.
1456
+ :rtype: bool
1457
+ """
964
1458
  ...
965
1459
 
966
1460
  def keys(self):
967
- """ """
1461
+ """Returns the keys of this objects custom properties (matches Python's
1462
+ dictionary function of the same name).
1463
+
1464
+ :return: custom property keys.
1465
+ """
968
1466
  ...
969
1467
 
970
- def path_from_id(self):
971
- """ """
1468
+ def path_from_id(self) -> str:
1469
+ """Returns the data path from the ID to this object (string).
1470
+
1471
+ :return: The path from `bpy.types.bpy_struct.id_data`
1472
+ to this struct and property (when given).
1473
+ :rtype: str
1474
+ """
972
1475
  ...
973
1476
 
974
1477
  def path_resolve(self):
975
- """ """
1478
+ """Returns the property from the path, raise an exception when not found."""
976
1479
  ...
977
1480
 
978
1481
  def poll(self, context):
@@ -983,37 +1486,53 @@ class BONE_PT_display(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
983
1486
  ...
984
1487
 
985
1488
  def pop(self):
986
- """ """
1489
+ """Remove and return the value of the custom property assigned to key or default
1490
+ when not found (matches Python's dictionary function of the same name).
1491
+
1492
+ """
987
1493
  ...
988
1494
 
989
1495
  def prepend(self, draw_func):
990
- """
1496
+ """Prepend a draw function to this menu, takes the same arguments as
1497
+ the menus draw function
991
1498
 
992
- :param draw_func:
1499
+ :param draw_func:
993
1500
  """
994
1501
  ...
995
1502
 
996
- def property_overridable_library_set(self):
997
- """ """
1503
+ def property_overridable_library_set(self) -> bool:
1504
+ """Define a property as overridable or not (only for custom properties!).
1505
+
1506
+ :return: True when the overridable status of the property was successfully set.
1507
+ :rtype: bool
1508
+ """
998
1509
  ...
999
1510
 
1000
1511
  def property_unset(self):
1001
- """ """
1512
+ """Unset a property, will use default value afterward."""
1002
1513
  ...
1003
1514
 
1004
1515
  def remove(self, draw_func):
1005
- """
1516
+ """Remove a draw function that has been added to this menu
1006
1517
 
1007
1518
  :param draw_func:
1008
1519
  """
1009
1520
  ...
1010
1521
 
1011
1522
  def type_recast(self):
1012
- """ """
1523
+ """Return a new instance, this is needed because types
1524
+ such as textures can be changed at runtime.
1525
+
1526
+ :return: a new instance of this object with the type initialized again.
1527
+ """
1013
1528
  ...
1014
1529
 
1015
1530
  def values(self):
1016
- """ """
1531
+ """Returns the values of this objects custom properties (matches Python's
1532
+ dictionary function of the same name).
1533
+
1534
+ :return: custom property values.
1535
+ """
1017
1536
  ...
1018
1537
 
1019
1538
  class BONE_PT_display_custom_shape(
@@ -1043,22 +1562,35 @@ class BONE_PT_display_custom_shape(
1043
1562
  """ """
1044
1563
 
1045
1564
  def append(self, draw_func):
1046
- """
1565
+ """Append a draw function to this menu,
1566
+ takes the same arguments as the menus draw function
1047
1567
 
1048
- :param draw_func:
1568
+ :param draw_func:
1049
1569
  """
1050
1570
  ...
1051
1571
 
1052
- def as_pointer(self):
1053
- """ """
1572
+ def as_pointer(self) -> int:
1573
+ """Returns the memory address which holds a pointer to Blender's internal data
1574
+
1575
+ :return: int (memory address).
1576
+ :rtype: int
1577
+ """
1054
1578
  ...
1055
1579
 
1056
- def bl_rna_get_subclass(self):
1057
- """ """
1580
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1581
+ """
1582
+
1583
+ :return: The RNA type or default when not found.
1584
+ :rtype: bpy.types.Struct
1585
+ """
1058
1586
  ...
1059
1587
 
1060
- def bl_rna_get_subclass_py(self):
1061
- """ """
1588
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1589
+ """
1590
+
1591
+ :return: The class or default when not found.
1592
+ :rtype: typing.Any
1593
+ """
1062
1594
  ...
1063
1595
 
1064
1596
  def draw(self, context):
@@ -1068,72 +1600,129 @@ class BONE_PT_display_custom_shape(
1068
1600
  """
1069
1601
  ...
1070
1602
 
1071
- def driver_add(self):
1072
- """ """
1603
+ def driver_add(self) -> bpy.types.FCurve:
1604
+ """Adds driver(s) to the given property
1605
+
1606
+ :return: The driver(s) added.
1607
+ :rtype: bpy.types.FCurve
1608
+ """
1073
1609
  ...
1074
1610
 
1075
- def driver_remove(self):
1076
- """ """
1611
+ def driver_remove(self) -> bool:
1612
+ """Remove driver(s) from the given property
1613
+
1614
+ :return: Success of driver removal.
1615
+ :rtype: bool
1616
+ """
1077
1617
  ...
1078
1618
 
1079
1619
  def get(self):
1080
- """ """
1620
+ """Returns the value of the custom property assigned to key or default
1621
+ when not found (matches Python's dictionary function of the same name).
1622
+
1623
+ """
1081
1624
  ...
1082
1625
 
1083
1626
  def id_properties_clear(self):
1084
- """ """
1627
+ """
1628
+
1629
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1630
+ """
1085
1631
  ...
1086
1632
 
1087
1633
  def id_properties_ensure(self):
1088
- """ """
1634
+ """
1635
+
1636
+ :return: the parent group for an RNA struct's custom IDProperties.
1637
+ """
1089
1638
  ...
1090
1639
 
1091
1640
  def id_properties_ui(self):
1092
- """ """
1641
+ """
1642
+
1643
+ :return: Return an object used to manage an IDProperty's UI data.
1644
+ """
1093
1645
  ...
1094
1646
 
1095
1647
  def is_extended(self):
1096
1648
  """ """
1097
1649
  ...
1098
1650
 
1099
- def is_property_hidden(self):
1100
- """ """
1651
+ def is_property_hidden(self) -> bool:
1652
+ """Check if a property is hidden.
1653
+
1654
+ :return: True when the property is hidden.
1655
+ :rtype: bool
1656
+ """
1101
1657
  ...
1102
1658
 
1103
- def is_property_overridable_library(self):
1104
- """ """
1659
+ def is_property_overridable_library(self) -> bool:
1660
+ """Check if a property is overridable.
1661
+
1662
+ :return: True when the property is overridable.
1663
+ :rtype: bool
1664
+ """
1105
1665
  ...
1106
1666
 
1107
- def is_property_readonly(self):
1108
- """ """
1667
+ def is_property_readonly(self) -> bool:
1668
+ """Check if a property is readonly.
1669
+
1670
+ :return: True when the property is readonly (not writable).
1671
+ :rtype: bool
1672
+ """
1109
1673
  ...
1110
1674
 
1111
- def is_property_set(self):
1112
- """ """
1675
+ def is_property_set(self) -> bool:
1676
+ """Check if a property is set, use for testing operator properties.
1677
+
1678
+ :return: True when the property has been set.
1679
+ :rtype: bool
1680
+ """
1113
1681
  ...
1114
1682
 
1115
1683
  def items(self):
1116
- """ """
1684
+ """Returns the items of this objects custom properties (matches Python's
1685
+ dictionary function of the same name).
1686
+
1687
+ :return: custom property key, value pairs.
1688
+ """
1117
1689
  ...
1118
1690
 
1119
- def keyframe_delete(self):
1120
- """ """
1691
+ def keyframe_delete(self) -> bool:
1692
+ """Remove a keyframe from this properties fcurve.
1693
+
1694
+ :return: Success of keyframe deletion.
1695
+ :rtype: bool
1696
+ """
1121
1697
  ...
1122
1698
 
1123
- def keyframe_insert(self):
1124
- """ """
1699
+ def keyframe_insert(self) -> bool:
1700
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1701
+
1702
+ :return: Success of keyframe insertion.
1703
+ :rtype: bool
1704
+ """
1705
+ ...
1706
+
1707
+ def keys(self):
1708
+ """Returns the keys of this objects custom properties (matches Python's
1709
+ dictionary function of the same name).
1710
+
1711
+ :return: custom property keys.
1712
+ """
1125
1713
  ...
1126
1714
 
1127
- def keys(self):
1128
- """ """
1129
- ...
1715
+ def path_from_id(self) -> str:
1716
+ """Returns the data path from the ID to this object (string).
1130
1717
 
1131
- def path_from_id(self):
1132
- """ """
1718
+ :return: The path from `bpy.types.bpy_struct.id_data`
1719
+ to this struct and property (when given).
1720
+ :rtype: str
1721
+ """
1133
1722
  ...
1134
1723
 
1135
1724
  def path_resolve(self):
1136
- """ """
1725
+ """Returns the property from the path, raise an exception when not found."""
1137
1726
  ...
1138
1727
 
1139
1728
  def poll(self, context):
@@ -1144,37 +1733,53 @@ class BONE_PT_display_custom_shape(
1144
1733
  ...
1145
1734
 
1146
1735
  def pop(self):
1147
- """ """
1736
+ """Remove and return the value of the custom property assigned to key or default
1737
+ when not found (matches Python's dictionary function of the same name).
1738
+
1739
+ """
1148
1740
  ...
1149
1741
 
1150
1742
  def prepend(self, draw_func):
1151
- """
1743
+ """Prepend a draw function to this menu, takes the same arguments as
1744
+ the menus draw function
1152
1745
 
1153
- :param draw_func:
1746
+ :param draw_func:
1154
1747
  """
1155
1748
  ...
1156
1749
 
1157
- def property_overridable_library_set(self):
1158
- """ """
1750
+ def property_overridable_library_set(self) -> bool:
1751
+ """Define a property as overridable or not (only for custom properties!).
1752
+
1753
+ :return: True when the overridable status of the property was successfully set.
1754
+ :rtype: bool
1755
+ """
1159
1756
  ...
1160
1757
 
1161
1758
  def property_unset(self):
1162
- """ """
1759
+ """Unset a property, will use default value afterward."""
1163
1760
  ...
1164
1761
 
1165
1762
  def remove(self, draw_func):
1166
- """
1763
+ """Remove a draw function that has been added to this menu
1167
1764
 
1168
1765
  :param draw_func:
1169
1766
  """
1170
1767
  ...
1171
1768
 
1172
1769
  def type_recast(self):
1173
- """ """
1770
+ """Return a new instance, this is needed because types
1771
+ such as textures can be changed at runtime.
1772
+
1773
+ :return: a new instance of this object with the type initialized again.
1774
+ """
1174
1775
  ...
1175
1776
 
1176
1777
  def values(self):
1177
- """ """
1778
+ """Returns the values of this objects custom properties (matches Python's
1779
+ dictionary function of the same name).
1780
+
1781
+ :return: custom property values.
1782
+ """
1178
1783
  ...
1179
1784
 
1180
1785
  class BONE_PT_inverse_kinematics(
@@ -1204,22 +1809,35 @@ class BONE_PT_inverse_kinematics(
1204
1809
  """ """
1205
1810
 
1206
1811
  def append(self, draw_func):
1207
- """
1812
+ """Append a draw function to this menu,
1813
+ takes the same arguments as the menus draw function
1208
1814
 
1209
- :param draw_func:
1815
+ :param draw_func:
1210
1816
  """
1211
1817
  ...
1212
1818
 
1213
- def as_pointer(self):
1214
- """ """
1819
+ def as_pointer(self) -> int:
1820
+ """Returns the memory address which holds a pointer to Blender's internal data
1821
+
1822
+ :return: int (memory address).
1823
+ :rtype: int
1824
+ """
1215
1825
  ...
1216
1826
 
1217
- def bl_rna_get_subclass(self):
1218
- """ """
1827
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1828
+ """
1829
+
1830
+ :return: The RNA type or default when not found.
1831
+ :rtype: bpy.types.Struct
1832
+ """
1219
1833
  ...
1220
1834
 
1221
- def bl_rna_get_subclass_py(self):
1222
- """ """
1835
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1836
+ """
1837
+
1838
+ :return: The class or default when not found.
1839
+ :rtype: typing.Any
1840
+ """
1223
1841
  ...
1224
1842
 
1225
1843
  def draw(self, context):
@@ -1229,72 +1847,129 @@ class BONE_PT_inverse_kinematics(
1229
1847
  """
1230
1848
  ...
1231
1849
 
1232
- def driver_add(self):
1233
- """ """
1850
+ def driver_add(self) -> bpy.types.FCurve:
1851
+ """Adds driver(s) to the given property
1852
+
1853
+ :return: The driver(s) added.
1854
+ :rtype: bpy.types.FCurve
1855
+ """
1234
1856
  ...
1235
1857
 
1236
- def driver_remove(self):
1237
- """ """
1858
+ def driver_remove(self) -> bool:
1859
+ """Remove driver(s) from the given property
1860
+
1861
+ :return: Success of driver removal.
1862
+ :rtype: bool
1863
+ """
1238
1864
  ...
1239
1865
 
1240
1866
  def get(self):
1241
- """ """
1867
+ """Returns the value of the custom property assigned to key or default
1868
+ when not found (matches Python's dictionary function of the same name).
1869
+
1870
+ """
1242
1871
  ...
1243
1872
 
1244
1873
  def id_properties_clear(self):
1245
- """ """
1874
+ """
1875
+
1876
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1877
+ """
1246
1878
  ...
1247
1879
 
1248
1880
  def id_properties_ensure(self):
1249
- """ """
1881
+ """
1882
+
1883
+ :return: the parent group for an RNA struct's custom IDProperties.
1884
+ """
1250
1885
  ...
1251
1886
 
1252
1887
  def id_properties_ui(self):
1253
- """ """
1888
+ """
1889
+
1890
+ :return: Return an object used to manage an IDProperty's UI data.
1891
+ """
1254
1892
  ...
1255
1893
 
1256
1894
  def is_extended(self):
1257
1895
  """ """
1258
1896
  ...
1259
1897
 
1260
- def is_property_hidden(self):
1261
- """ """
1898
+ def is_property_hidden(self) -> bool:
1899
+ """Check if a property is hidden.
1900
+
1901
+ :return: True when the property is hidden.
1902
+ :rtype: bool
1903
+ """
1262
1904
  ...
1263
1905
 
1264
- def is_property_overridable_library(self):
1265
- """ """
1906
+ def is_property_overridable_library(self) -> bool:
1907
+ """Check if a property is overridable.
1908
+
1909
+ :return: True when the property is overridable.
1910
+ :rtype: bool
1911
+ """
1266
1912
  ...
1267
1913
 
1268
- def is_property_readonly(self):
1269
- """ """
1914
+ def is_property_readonly(self) -> bool:
1915
+ """Check if a property is readonly.
1916
+
1917
+ :return: True when the property is readonly (not writable).
1918
+ :rtype: bool
1919
+ """
1270
1920
  ...
1271
1921
 
1272
- def is_property_set(self):
1273
- """ """
1922
+ def is_property_set(self) -> bool:
1923
+ """Check if a property is set, use for testing operator properties.
1924
+
1925
+ :return: True when the property has been set.
1926
+ :rtype: bool
1927
+ """
1274
1928
  ...
1275
1929
 
1276
1930
  def items(self):
1277
- """ """
1931
+ """Returns the items of this objects custom properties (matches Python's
1932
+ dictionary function of the same name).
1933
+
1934
+ :return: custom property key, value pairs.
1935
+ """
1278
1936
  ...
1279
1937
 
1280
- def keyframe_delete(self):
1281
- """ """
1938
+ def keyframe_delete(self) -> bool:
1939
+ """Remove a keyframe from this properties fcurve.
1940
+
1941
+ :return: Success of keyframe deletion.
1942
+ :rtype: bool
1943
+ """
1282
1944
  ...
1283
1945
 
1284
- def keyframe_insert(self):
1285
- """ """
1946
+ def keyframe_insert(self) -> bool:
1947
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1948
+
1949
+ :return: Success of keyframe insertion.
1950
+ :rtype: bool
1951
+ """
1286
1952
  ...
1287
1953
 
1288
1954
  def keys(self):
1289
- """ """
1955
+ """Returns the keys of this objects custom properties (matches Python's
1956
+ dictionary function of the same name).
1957
+
1958
+ :return: custom property keys.
1959
+ """
1290
1960
  ...
1291
1961
 
1292
- def path_from_id(self):
1293
- """ """
1962
+ def path_from_id(self) -> str:
1963
+ """Returns the data path from the ID to this object (string).
1964
+
1965
+ :return: The path from `bpy.types.bpy_struct.id_data`
1966
+ to this struct and property (when given).
1967
+ :rtype: str
1968
+ """
1294
1969
  ...
1295
1970
 
1296
1971
  def path_resolve(self):
1297
- """ """
1972
+ """Returns the property from the path, raise an exception when not found."""
1298
1973
  ...
1299
1974
 
1300
1975
  def poll(self, context):
@@ -1305,37 +1980,53 @@ class BONE_PT_inverse_kinematics(
1305
1980
  ...
1306
1981
 
1307
1982
  def pop(self):
1308
- """ """
1983
+ """Remove and return the value of the custom property assigned to key or default
1984
+ when not found (matches Python's dictionary function of the same name).
1985
+
1986
+ """
1309
1987
  ...
1310
1988
 
1311
1989
  def prepend(self, draw_func):
1312
- """
1990
+ """Prepend a draw function to this menu, takes the same arguments as
1991
+ the menus draw function
1313
1992
 
1314
- :param draw_func:
1993
+ :param draw_func:
1315
1994
  """
1316
1995
  ...
1317
1996
 
1318
- def property_overridable_library_set(self):
1319
- """ """
1997
+ def property_overridable_library_set(self) -> bool:
1998
+ """Define a property as overridable or not (only for custom properties!).
1999
+
2000
+ :return: True when the overridable status of the property was successfully set.
2001
+ :rtype: bool
2002
+ """
1320
2003
  ...
1321
2004
 
1322
2005
  def property_unset(self):
1323
- """ """
2006
+ """Unset a property, will use default value afterward."""
1324
2007
  ...
1325
2008
 
1326
2009
  def remove(self, draw_func):
1327
- """
2010
+ """Remove a draw function that has been added to this menu
1328
2011
 
1329
2012
  :param draw_func:
1330
2013
  """
1331
2014
  ...
1332
2015
 
1333
2016
  def type_recast(self):
1334
- """ """
2017
+ """Return a new instance, this is needed because types
2018
+ such as textures can be changed at runtime.
2019
+
2020
+ :return: a new instance of this object with the type initialized again.
2021
+ """
1335
2022
  ...
1336
2023
 
1337
2024
  def values(self):
1338
- """ """
2025
+ """Returns the values of this objects custom properties (matches Python's
2026
+ dictionary function of the same name).
2027
+
2028
+ :return: custom property values.
2029
+ """
1339
2030
  ...
1340
2031
 
1341
2032
  class BONE_PT_relations(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
@@ -1363,22 +2054,35 @@ class BONE_PT_relations(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI)
1363
2054
  """ """
1364
2055
 
1365
2056
  def append(self, draw_func):
1366
- """
2057
+ """Append a draw function to this menu,
2058
+ takes the same arguments as the menus draw function
1367
2059
 
1368
- :param draw_func:
2060
+ :param draw_func:
1369
2061
  """
1370
2062
  ...
1371
2063
 
1372
- def as_pointer(self):
1373
- """ """
2064
+ def as_pointer(self) -> int:
2065
+ """Returns the memory address which holds a pointer to Blender's internal data
2066
+
2067
+ :return: int (memory address).
2068
+ :rtype: int
2069
+ """
1374
2070
  ...
1375
2071
 
1376
- def bl_rna_get_subclass(self):
1377
- """ """
2072
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2073
+ """
2074
+
2075
+ :return: The RNA type or default when not found.
2076
+ :rtype: bpy.types.Struct
2077
+ """
1378
2078
  ...
1379
2079
 
1380
- def bl_rna_get_subclass_py(self):
1381
- """ """
2080
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2081
+ """
2082
+
2083
+ :return: The class or default when not found.
2084
+ :rtype: typing.Any
2085
+ """
1382
2086
  ...
1383
2087
 
1384
2088
  def draw(self, context):
@@ -1388,72 +2092,129 @@ class BONE_PT_relations(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI)
1388
2092
  """
1389
2093
  ...
1390
2094
 
1391
- def driver_add(self):
1392
- """ """
2095
+ def driver_add(self) -> bpy.types.FCurve:
2096
+ """Adds driver(s) to the given property
2097
+
2098
+ :return: The driver(s) added.
2099
+ :rtype: bpy.types.FCurve
2100
+ """
1393
2101
  ...
1394
2102
 
1395
- def driver_remove(self):
1396
- """ """
2103
+ def driver_remove(self) -> bool:
2104
+ """Remove driver(s) from the given property
2105
+
2106
+ :return: Success of driver removal.
2107
+ :rtype: bool
2108
+ """
1397
2109
  ...
1398
2110
 
1399
2111
  def get(self):
1400
- """ """
2112
+ """Returns the value of the custom property assigned to key or default
2113
+ when not found (matches Python's dictionary function of the same name).
2114
+
2115
+ """
1401
2116
  ...
1402
2117
 
1403
2118
  def id_properties_clear(self):
1404
- """ """
2119
+ """
2120
+
2121
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2122
+ """
1405
2123
  ...
1406
2124
 
1407
2125
  def id_properties_ensure(self):
1408
- """ """
2126
+ """
2127
+
2128
+ :return: the parent group for an RNA struct's custom IDProperties.
2129
+ """
1409
2130
  ...
1410
2131
 
1411
2132
  def id_properties_ui(self):
1412
- """ """
2133
+ """
2134
+
2135
+ :return: Return an object used to manage an IDProperty's UI data.
2136
+ """
1413
2137
  ...
1414
2138
 
1415
2139
  def is_extended(self):
1416
2140
  """ """
1417
2141
  ...
1418
2142
 
1419
- def is_property_hidden(self):
1420
- """ """
2143
+ def is_property_hidden(self) -> bool:
2144
+ """Check if a property is hidden.
2145
+
2146
+ :return: True when the property is hidden.
2147
+ :rtype: bool
2148
+ """
1421
2149
  ...
1422
2150
 
1423
- def is_property_overridable_library(self):
1424
- """ """
2151
+ def is_property_overridable_library(self) -> bool:
2152
+ """Check if a property is overridable.
2153
+
2154
+ :return: True when the property is overridable.
2155
+ :rtype: bool
2156
+ """
1425
2157
  ...
1426
2158
 
1427
- def is_property_readonly(self):
1428
- """ """
2159
+ def is_property_readonly(self) -> bool:
2160
+ """Check if a property is readonly.
2161
+
2162
+ :return: True when the property is readonly (not writable).
2163
+ :rtype: bool
2164
+ """
1429
2165
  ...
1430
2166
 
1431
- def is_property_set(self):
1432
- """ """
2167
+ def is_property_set(self) -> bool:
2168
+ """Check if a property is set, use for testing operator properties.
2169
+
2170
+ :return: True when the property has been set.
2171
+ :rtype: bool
2172
+ """
1433
2173
  ...
1434
2174
 
1435
2175
  def items(self):
1436
- """ """
2176
+ """Returns the items of this objects custom properties (matches Python's
2177
+ dictionary function of the same name).
2178
+
2179
+ :return: custom property key, value pairs.
2180
+ """
1437
2181
  ...
1438
2182
 
1439
- def keyframe_delete(self):
1440
- """ """
2183
+ def keyframe_delete(self) -> bool:
2184
+ """Remove a keyframe from this properties fcurve.
2185
+
2186
+ :return: Success of keyframe deletion.
2187
+ :rtype: bool
2188
+ """
1441
2189
  ...
1442
2190
 
1443
- def keyframe_insert(self):
1444
- """ """
2191
+ def keyframe_insert(self) -> bool:
2192
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2193
+
2194
+ :return: Success of keyframe insertion.
2195
+ :rtype: bool
2196
+ """
1445
2197
  ...
1446
2198
 
1447
2199
  def keys(self):
1448
- """ """
2200
+ """Returns the keys of this objects custom properties (matches Python's
2201
+ dictionary function of the same name).
2202
+
2203
+ :return: custom property keys.
2204
+ """
1449
2205
  ...
1450
2206
 
1451
- def path_from_id(self):
1452
- """ """
2207
+ def path_from_id(self) -> str:
2208
+ """Returns the data path from the ID to this object (string).
2209
+
2210
+ :return: The path from `bpy.types.bpy_struct.id_data`
2211
+ to this struct and property (when given).
2212
+ :rtype: str
2213
+ """
1453
2214
  ...
1454
2215
 
1455
2216
  def path_resolve(self):
1456
- """ """
2217
+ """Returns the property from the path, raise an exception when not found."""
1457
2218
  ...
1458
2219
 
1459
2220
  def poll(self, context):
@@ -1464,37 +2225,53 @@ class BONE_PT_relations(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI)
1464
2225
  ...
1465
2226
 
1466
2227
  def pop(self):
1467
- """ """
2228
+ """Remove and return the value of the custom property assigned to key or default
2229
+ when not found (matches Python's dictionary function of the same name).
2230
+
2231
+ """
1468
2232
  ...
1469
2233
 
1470
2234
  def prepend(self, draw_func):
1471
- """
2235
+ """Prepend a draw function to this menu, takes the same arguments as
2236
+ the menus draw function
1472
2237
 
1473
- :param draw_func:
2238
+ :param draw_func:
1474
2239
  """
1475
2240
  ...
1476
2241
 
1477
- def property_overridable_library_set(self):
1478
- """ """
2242
+ def property_overridable_library_set(self) -> bool:
2243
+ """Define a property as overridable or not (only for custom properties!).
2244
+
2245
+ :return: True when the overridable status of the property was successfully set.
2246
+ :rtype: bool
2247
+ """
1479
2248
  ...
1480
2249
 
1481
2250
  def property_unset(self):
1482
- """ """
2251
+ """Unset a property, will use default value afterward."""
1483
2252
  ...
1484
2253
 
1485
2254
  def remove(self, draw_func):
1486
- """
2255
+ """Remove a draw function that has been added to this menu
1487
2256
 
1488
2257
  :param draw_func:
1489
2258
  """
1490
2259
  ...
1491
2260
 
1492
2261
  def type_recast(self):
1493
- """ """
2262
+ """Return a new instance, this is needed because types
2263
+ such as textures can be changed at runtime.
2264
+
2265
+ :return: a new instance of this object with the type initialized again.
2266
+ """
1494
2267
  ...
1495
2268
 
1496
2269
  def values(self):
1497
- """ """
2270
+ """Returns the values of this objects custom properties (matches Python's
2271
+ dictionary function of the same name).
2272
+
2273
+ :return: custom property values.
2274
+ """
1498
2275
  ...
1499
2276
 
1500
2277
  class BONE_PT_transform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI):
@@ -1519,22 +2296,35 @@ class BONE_PT_transform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI)
1519
2296
  """ """
1520
2297
 
1521
2298
  def append(self, draw_func):
1522
- """
2299
+ """Append a draw function to this menu,
2300
+ takes the same arguments as the menus draw function
1523
2301
 
1524
- :param draw_func:
2302
+ :param draw_func:
1525
2303
  """
1526
2304
  ...
1527
2305
 
1528
- def as_pointer(self):
1529
- """ """
2306
+ def as_pointer(self) -> int:
2307
+ """Returns the memory address which holds a pointer to Blender's internal data
2308
+
2309
+ :return: int (memory address).
2310
+ :rtype: int
2311
+ """
1530
2312
  ...
1531
2313
 
1532
- def bl_rna_get_subclass(self):
1533
- """ """
2314
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2315
+ """
2316
+
2317
+ :return: The RNA type or default when not found.
2318
+ :rtype: bpy.types.Struct
2319
+ """
1534
2320
  ...
1535
2321
 
1536
- def bl_rna_get_subclass_py(self):
1537
- """ """
2322
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2323
+ """
2324
+
2325
+ :return: The class or default when not found.
2326
+ :rtype: typing.Any
2327
+ """
1538
2328
  ...
1539
2329
 
1540
2330
  def draw(self, context):
@@ -1544,72 +2334,129 @@ class BONE_PT_transform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI)
1544
2334
  """
1545
2335
  ...
1546
2336
 
1547
- def driver_add(self):
1548
- """ """
2337
+ def driver_add(self) -> bpy.types.FCurve:
2338
+ """Adds driver(s) to the given property
2339
+
2340
+ :return: The driver(s) added.
2341
+ :rtype: bpy.types.FCurve
2342
+ """
1549
2343
  ...
1550
2344
 
1551
- def driver_remove(self):
1552
- """ """
2345
+ def driver_remove(self) -> bool:
2346
+ """Remove driver(s) from the given property
2347
+
2348
+ :return: Success of driver removal.
2349
+ :rtype: bool
2350
+ """
1553
2351
  ...
1554
2352
 
1555
2353
  def get(self):
1556
- """ """
2354
+ """Returns the value of the custom property assigned to key or default
2355
+ when not found (matches Python's dictionary function of the same name).
2356
+
2357
+ """
1557
2358
  ...
1558
2359
 
1559
2360
  def id_properties_clear(self):
1560
- """ """
2361
+ """
2362
+
2363
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2364
+ """
1561
2365
  ...
1562
2366
 
1563
2367
  def id_properties_ensure(self):
1564
- """ """
2368
+ """
2369
+
2370
+ :return: the parent group for an RNA struct's custom IDProperties.
2371
+ """
1565
2372
  ...
1566
2373
 
1567
2374
  def id_properties_ui(self):
1568
- """ """
2375
+ """
2376
+
2377
+ :return: Return an object used to manage an IDProperty's UI data.
2378
+ """
1569
2379
  ...
1570
2380
 
1571
2381
  def is_extended(self):
1572
2382
  """ """
1573
2383
  ...
1574
2384
 
1575
- def is_property_hidden(self):
1576
- """ """
2385
+ def is_property_hidden(self) -> bool:
2386
+ """Check if a property is hidden.
2387
+
2388
+ :return: True when the property is hidden.
2389
+ :rtype: bool
2390
+ """
1577
2391
  ...
1578
2392
 
1579
- def is_property_overridable_library(self):
1580
- """ """
2393
+ def is_property_overridable_library(self) -> bool:
2394
+ """Check if a property is overridable.
2395
+
2396
+ :return: True when the property is overridable.
2397
+ :rtype: bool
2398
+ """
1581
2399
  ...
1582
2400
 
1583
- def is_property_readonly(self):
1584
- """ """
2401
+ def is_property_readonly(self) -> bool:
2402
+ """Check if a property is readonly.
2403
+
2404
+ :return: True when the property is readonly (not writable).
2405
+ :rtype: bool
2406
+ """
1585
2407
  ...
1586
2408
 
1587
- def is_property_set(self):
1588
- """ """
2409
+ def is_property_set(self) -> bool:
2410
+ """Check if a property is set, use for testing operator properties.
2411
+
2412
+ :return: True when the property has been set.
2413
+ :rtype: bool
2414
+ """
1589
2415
  ...
1590
2416
 
1591
2417
  def items(self):
1592
- """ """
2418
+ """Returns the items of this objects custom properties (matches Python's
2419
+ dictionary function of the same name).
2420
+
2421
+ :return: custom property key, value pairs.
2422
+ """
1593
2423
  ...
1594
2424
 
1595
- def keyframe_delete(self):
1596
- """ """
2425
+ def keyframe_delete(self) -> bool:
2426
+ """Remove a keyframe from this properties fcurve.
2427
+
2428
+ :return: Success of keyframe deletion.
2429
+ :rtype: bool
2430
+ """
1597
2431
  ...
1598
2432
 
1599
- def keyframe_insert(self):
1600
- """ """
2433
+ def keyframe_insert(self) -> bool:
2434
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2435
+
2436
+ :return: Success of keyframe insertion.
2437
+ :rtype: bool
2438
+ """
1601
2439
  ...
1602
2440
 
1603
2441
  def keys(self):
1604
- """ """
2442
+ """Returns the keys of this objects custom properties (matches Python's
2443
+ dictionary function of the same name).
2444
+
2445
+ :return: custom property keys.
2446
+ """
1605
2447
  ...
1606
2448
 
1607
- def path_from_id(self):
1608
- """ """
2449
+ def path_from_id(self) -> str:
2450
+ """Returns the data path from the ID to this object (string).
2451
+
2452
+ :return: The path from `bpy.types.bpy_struct.id_data`
2453
+ to this struct and property (when given).
2454
+ :rtype: str
2455
+ """
1609
2456
  ...
1610
2457
 
1611
2458
  def path_resolve(self):
1612
- """ """
2459
+ """Returns the property from the path, raise an exception when not found."""
1613
2460
  ...
1614
2461
 
1615
2462
  def poll(self, context):
@@ -1620,35 +2467,51 @@ class BONE_PT_transform(bpy_types.Panel, BoneButtonsPanel, bpy_types._GenericUI)
1620
2467
  ...
1621
2468
 
1622
2469
  def pop(self):
1623
- """ """
2470
+ """Remove and return the value of the custom property assigned to key or default
2471
+ when not found (matches Python's dictionary function of the same name).
2472
+
2473
+ """
1624
2474
  ...
1625
2475
 
1626
2476
  def prepend(self, draw_func):
1627
- """
2477
+ """Prepend a draw function to this menu, takes the same arguments as
2478
+ the menus draw function
1628
2479
 
1629
- :param draw_func:
2480
+ :param draw_func:
1630
2481
  """
1631
2482
  ...
1632
2483
 
1633
- def property_overridable_library_set(self):
1634
- """ """
2484
+ def property_overridable_library_set(self) -> bool:
2485
+ """Define a property as overridable or not (only for custom properties!).
2486
+
2487
+ :return: True when the overridable status of the property was successfully set.
2488
+ :rtype: bool
2489
+ """
1635
2490
  ...
1636
2491
 
1637
2492
  def property_unset(self):
1638
- """ """
2493
+ """Unset a property, will use default value afterward."""
1639
2494
  ...
1640
2495
 
1641
2496
  def remove(self, draw_func):
1642
- """
2497
+ """Remove a draw function that has been added to this menu
1643
2498
 
1644
2499
  :param draw_func:
1645
2500
  """
1646
2501
  ...
1647
2502
 
1648
2503
  def type_recast(self):
1649
- """ """
2504
+ """Return a new instance, this is needed because types
2505
+ such as textures can be changed at runtime.
2506
+
2507
+ :return: a new instance of this object with the type initialized again.
2508
+ """
1650
2509
  ...
1651
2510
 
1652
2511
  def values(self):
1653
- """ """
2512
+ """Returns the values of this objects custom properties (matches Python's
2513
+ dictionary function of the same name).
2514
+
2515
+ :return: custom property values.
2516
+ """
1654
2517
  ...