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

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

Potentially problematic release.


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

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