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

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

Potentially problematic release.


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

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