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

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

Potentially problematic release.


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

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