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

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

Potentially problematic release.


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

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