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

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

Potentially problematic release.


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

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