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