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

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

Potentially problematic release.


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

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