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

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

Potentially problematic release.


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

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