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

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

Potentially problematic release.


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

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