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