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