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

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

Potentially problematic release.


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

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