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,5 +1,6 @@
1
1
  import typing
2
2
  import bl_ui.properties_grease_pencil_common
3
+ import bpy.types
3
4
  import bpy_types
4
5
  import rna_prop_ui
5
6
 
@@ -75,22 +76,35 @@ class GPENCIL_MT_gpencil_vertex_group(bpy_types.Menu, bpy_types._GenericUI):
75
76
  """ """
76
77
 
77
78
  def append(self, draw_func):
78
- """
79
+ """Append a draw function to this menu,
80
+ takes the same arguments as the menus draw function
79
81
 
80
- :param draw_func:
82
+ :param draw_func:
81
83
  """
82
84
  ...
83
85
 
84
- def as_pointer(self):
85
- """ """
86
+ def as_pointer(self) -> int:
87
+ """Returns the memory address which holds a pointer to Blender's internal data
88
+
89
+ :return: int (memory address).
90
+ :rtype: int
91
+ """
86
92
  ...
87
93
 
88
- def bl_rna_get_subclass(self):
89
- """ """
94
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
95
+ """
96
+
97
+ :return: The RNA type or default when not found.
98
+ :rtype: bpy.types.Struct
99
+ """
90
100
  ...
91
101
 
92
- def bl_rna_get_subclass_py(self):
93
- """ """
102
+ def bl_rna_get_subclass_py(self) -> typing.Any:
103
+ """
104
+
105
+ :return: The class or default when not found.
106
+ :rtype: typing.Any
107
+ """
94
108
  ...
95
109
 
96
110
  def draw(self, context):
@@ -109,138 +123,224 @@ class GPENCIL_MT_gpencil_vertex_group(bpy_types.Menu, bpy_types._GenericUI):
109
123
  ...
110
124
 
111
125
  def draw_preset(self, _context):
112
- """
126
+ """Define these on the subclass:
127
+ - preset_operator (string)
128
+ - preset_subdir (string)Optionally:
129
+ - preset_add_operator (string)
130
+ - preset_extensions (set of strings)
131
+ - preset_operator_defaults (dict of keyword args)
113
132
 
114
- :param _context:
133
+ :param _context:
115
134
  """
116
135
  ...
117
136
 
118
- def driver_add(self):
119
- """ """
137
+ def driver_add(self) -> bpy.types.FCurve:
138
+ """Adds driver(s) to the given property
139
+
140
+ :return: The driver(s) added.
141
+ :rtype: bpy.types.FCurve
142
+ """
120
143
  ...
121
144
 
122
- def driver_remove(self):
123
- """ """
145
+ def driver_remove(self) -> bool:
146
+ """Remove driver(s) from the given property
147
+
148
+ :return: Success of driver removal.
149
+ :rtype: bool
150
+ """
124
151
  ...
125
152
 
126
153
  def get(self):
127
- """ """
154
+ """Returns the value of the custom property assigned to key or default
155
+ when not found (matches Python's dictionary function of the same name).
156
+
157
+ """
128
158
  ...
129
159
 
130
160
  def id_properties_clear(self):
131
- """ """
161
+ """
162
+
163
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
164
+ """
132
165
  ...
133
166
 
134
167
  def id_properties_ensure(self):
135
- """ """
168
+ """
169
+
170
+ :return: the parent group for an RNA struct's custom IDProperties.
171
+ """
136
172
  ...
137
173
 
138
174
  def id_properties_ui(self):
139
- """ """
175
+ """
176
+
177
+ :return: Return an object used to manage an IDProperty's UI data.
178
+ """
140
179
  ...
141
180
 
142
181
  def is_extended(self):
143
182
  """ """
144
183
  ...
145
184
 
146
- def is_property_hidden(self):
147
- """ """
185
+ def is_property_hidden(self) -> bool:
186
+ """Check if a property is hidden.
187
+
188
+ :return: True when the property is hidden.
189
+ :rtype: bool
190
+ """
148
191
  ...
149
192
 
150
- def is_property_overridable_library(self):
151
- """ """
193
+ def is_property_overridable_library(self) -> bool:
194
+ """Check if a property is overridable.
195
+
196
+ :return: True when the property is overridable.
197
+ :rtype: bool
198
+ """
152
199
  ...
153
200
 
154
- def is_property_readonly(self):
155
- """ """
201
+ def is_property_readonly(self) -> bool:
202
+ """Check if a property is readonly.
203
+
204
+ :return: True when the property is readonly (not writable).
205
+ :rtype: bool
206
+ """
156
207
  ...
157
208
 
158
- def is_property_set(self):
159
- """ """
209
+ def is_property_set(self) -> bool:
210
+ """Check if a property is set, use for testing operator properties.
211
+
212
+ :return: True when the property has been set.
213
+ :rtype: bool
214
+ """
160
215
  ...
161
216
 
162
217
  def items(self):
163
- """ """
218
+ """Returns the items of this objects custom properties (matches Python's
219
+ dictionary function of the same name).
220
+
221
+ :return: custom property key, value pairs.
222
+ """
164
223
  ...
165
224
 
166
- def keyframe_delete(self):
167
- """ """
225
+ def keyframe_delete(self) -> bool:
226
+ """Remove a keyframe from this properties fcurve.
227
+
228
+ :return: Success of keyframe deletion.
229
+ :rtype: bool
230
+ """
168
231
  ...
169
232
 
170
- def keyframe_insert(self):
171
- """ """
233
+ def keyframe_insert(self) -> bool:
234
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
235
+
236
+ :return: Success of keyframe insertion.
237
+ :rtype: bool
238
+ """
172
239
  ...
173
240
 
174
241
  def keys(self):
175
- """ """
242
+ """Returns the keys of this objects custom properties (matches Python's
243
+ dictionary function of the same name).
244
+
245
+ :return: custom property keys.
246
+ """
176
247
  ...
177
248
 
178
- def path_from_id(self):
179
- """ """
249
+ def path_from_id(self) -> str:
250
+ """Returns the data path from the ID to this object (string).
251
+
252
+ :return: The path from `bpy.types.bpy_struct.id_data`
253
+ to this struct and property (when given).
254
+ :rtype: str
255
+ """
180
256
  ...
181
257
 
182
258
  def path_menu(
183
259
  self,
184
- searchpaths,
185
- operator,
186
- props_default,
187
- prop_filepath,
188
- filter_ext,
189
- filter_path,
190
- display_name,
191
- add_operator,
192
- add_operator_props,
260
+ searchpaths: list[str],
261
+ operator: str,
262
+ props_default: dict = None,
263
+ prop_filepath: str = "filepath",
264
+ filter_ext: typing.Callable = None,
265
+ filter_path=None,
266
+ display_name: typing.Callable = None,
267
+ add_operator=None,
268
+ add_operator_props=None,
193
269
  ):
194
- """
270
+ """Populate a menu from a list of paths.
271
+
272
+ :param searchpaths: Paths to scan.
273
+ :type searchpaths: list[str]
274
+ :param operator: The operator id to use with each file.
275
+ :type operator: str
276
+ :param props_default: Properties to assign to each operator.
277
+ :type props_default: dict
278
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
279
+ :type prop_filepath: str
280
+ :param filter_ext: Optional callback that takes the file extensions.
195
281
 
196
- :param searchpaths:
197
- :param operator:
198
- :param props_default:
199
- :param prop_filepath:
200
- :param filter_ext:
201
- :param filter_path:
202
- :param display_name:
203
- :param add_operator:
204
- :param add_operator_props:
282
+ Returning false excludes the file from the list.
283
+ :type filter_ext: typing.Callable
284
+ :param filter_path:
285
+ :param display_name: Optional callback that takes the full path, returns the name to display.
286
+ :type display_name: typing.Callable
287
+ :param add_operator:
288
+ :param add_operator_props:
205
289
  """
206
290
  ...
207
291
 
208
292
  def path_resolve(self):
209
- """ """
293
+ """Returns the property from the path, raise an exception when not found."""
210
294
  ...
211
295
 
212
296
  def pop(self):
213
- """ """
297
+ """Remove and return the value of the custom property assigned to key or default
298
+ when not found (matches Python's dictionary function of the same name).
299
+
300
+ """
214
301
  ...
215
302
 
216
303
  def prepend(self, draw_func):
217
- """
304
+ """Prepend a draw function to this menu, takes the same arguments as
305
+ the menus draw function
218
306
 
219
- :param draw_func:
307
+ :param draw_func:
220
308
  """
221
309
  ...
222
310
 
223
- def property_overridable_library_set(self):
224
- """ """
311
+ def property_overridable_library_set(self) -> bool:
312
+ """Define a property as overridable or not (only for custom properties!).
313
+
314
+ :return: True when the overridable status of the property was successfully set.
315
+ :rtype: bool
316
+ """
225
317
  ...
226
318
 
227
319
  def property_unset(self):
228
- """ """
320
+ """Unset a property, will use default value afterward."""
229
321
  ...
230
322
 
231
323
  def remove(self, draw_func):
232
- """
324
+ """Remove a draw function that has been added to this menu
233
325
 
234
326
  :param draw_func:
235
327
  """
236
328
  ...
237
329
 
238
330
  def type_recast(self):
239
- """ """
331
+ """Return a new instance, this is needed because types
332
+ such as textures can be changed at runtime.
333
+
334
+ :return: a new instance of this object with the type initialized again.
335
+ """
240
336
  ...
241
337
 
242
338
  def values(self):
243
- """ """
339
+ """Returns the values of this objects custom properties (matches Python's
340
+ dictionary function of the same name).
341
+
342
+ :return: custom property values.
343
+ """
244
344
  ...
245
345
 
246
346
  class GPENCIL_MT_layer_context_menu(bpy_types.Menu, bpy_types._GenericUI):
@@ -256,22 +356,35 @@ class GPENCIL_MT_layer_context_menu(bpy_types.Menu, bpy_types._GenericUI):
256
356
  """ """
257
357
 
258
358
  def append(self, draw_func):
259
- """
359
+ """Append a draw function to this menu,
360
+ takes the same arguments as the menus draw function
260
361
 
261
- :param draw_func:
362
+ :param draw_func:
262
363
  """
263
364
  ...
264
365
 
265
- def as_pointer(self):
266
- """ """
366
+ def as_pointer(self) -> int:
367
+ """Returns the memory address which holds a pointer to Blender's internal data
368
+
369
+ :return: int (memory address).
370
+ :rtype: int
371
+ """
267
372
  ...
268
373
 
269
- def bl_rna_get_subclass(self):
270
- """ """
374
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
375
+ """
376
+
377
+ :return: The RNA type or default when not found.
378
+ :rtype: bpy.types.Struct
379
+ """
271
380
  ...
272
381
 
273
- def bl_rna_get_subclass_py(self):
274
- """ """
382
+ def bl_rna_get_subclass_py(self) -> typing.Any:
383
+ """
384
+
385
+ :return: The class or default when not found.
386
+ :rtype: typing.Any
387
+ """
275
388
  ...
276
389
 
277
390
  def draw(self, context):
@@ -290,138 +403,224 @@ class GPENCIL_MT_layer_context_menu(bpy_types.Menu, bpy_types._GenericUI):
290
403
  ...
291
404
 
292
405
  def draw_preset(self, _context):
293
- """
406
+ """Define these on the subclass:
407
+ - preset_operator (string)
408
+ - preset_subdir (string)Optionally:
409
+ - preset_add_operator (string)
410
+ - preset_extensions (set of strings)
411
+ - preset_operator_defaults (dict of keyword args)
294
412
 
295
- :param _context:
413
+ :param _context:
296
414
  """
297
415
  ...
298
416
 
299
- def driver_add(self):
300
- """ """
417
+ def driver_add(self) -> bpy.types.FCurve:
418
+ """Adds driver(s) to the given property
419
+
420
+ :return: The driver(s) added.
421
+ :rtype: bpy.types.FCurve
422
+ """
301
423
  ...
302
424
 
303
- def driver_remove(self):
304
- """ """
425
+ def driver_remove(self) -> bool:
426
+ """Remove driver(s) from the given property
427
+
428
+ :return: Success of driver removal.
429
+ :rtype: bool
430
+ """
305
431
  ...
306
432
 
307
433
  def get(self):
308
- """ """
434
+ """Returns the value of the custom property assigned to key or default
435
+ when not found (matches Python's dictionary function of the same name).
436
+
437
+ """
309
438
  ...
310
439
 
311
440
  def id_properties_clear(self):
312
- """ """
441
+ """
442
+
443
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
444
+ """
313
445
  ...
314
446
 
315
447
  def id_properties_ensure(self):
316
- """ """
448
+ """
449
+
450
+ :return: the parent group for an RNA struct's custom IDProperties.
451
+ """
317
452
  ...
318
453
 
319
454
  def id_properties_ui(self):
320
- """ """
455
+ """
456
+
457
+ :return: Return an object used to manage an IDProperty's UI data.
458
+ """
321
459
  ...
322
460
 
323
461
  def is_extended(self):
324
462
  """ """
325
463
  ...
326
464
 
327
- def is_property_hidden(self):
328
- """ """
465
+ def is_property_hidden(self) -> bool:
466
+ """Check if a property is hidden.
467
+
468
+ :return: True when the property is hidden.
469
+ :rtype: bool
470
+ """
329
471
  ...
330
472
 
331
- def is_property_overridable_library(self):
332
- """ """
473
+ def is_property_overridable_library(self) -> bool:
474
+ """Check if a property is overridable.
475
+
476
+ :return: True when the property is overridable.
477
+ :rtype: bool
478
+ """
333
479
  ...
334
480
 
335
- def is_property_readonly(self):
336
- """ """
481
+ def is_property_readonly(self) -> bool:
482
+ """Check if a property is readonly.
483
+
484
+ :return: True when the property is readonly (not writable).
485
+ :rtype: bool
486
+ """
337
487
  ...
338
488
 
339
- def is_property_set(self):
340
- """ """
489
+ def is_property_set(self) -> bool:
490
+ """Check if a property is set, use for testing operator properties.
491
+
492
+ :return: True when the property has been set.
493
+ :rtype: bool
494
+ """
341
495
  ...
342
496
 
343
497
  def items(self):
344
- """ """
498
+ """Returns the items of this objects custom properties (matches Python's
499
+ dictionary function of the same name).
500
+
501
+ :return: custom property key, value pairs.
502
+ """
345
503
  ...
346
504
 
347
- def keyframe_delete(self):
348
- """ """
505
+ def keyframe_delete(self) -> bool:
506
+ """Remove a keyframe from this properties fcurve.
507
+
508
+ :return: Success of keyframe deletion.
509
+ :rtype: bool
510
+ """
349
511
  ...
350
512
 
351
- def keyframe_insert(self):
352
- """ """
513
+ def keyframe_insert(self) -> bool:
514
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
515
+
516
+ :return: Success of keyframe insertion.
517
+ :rtype: bool
518
+ """
353
519
  ...
354
520
 
355
521
  def keys(self):
356
- """ """
522
+ """Returns the keys of this objects custom properties (matches Python's
523
+ dictionary function of the same name).
524
+
525
+ :return: custom property keys.
526
+ """
357
527
  ...
358
528
 
359
- def path_from_id(self):
360
- """ """
529
+ def path_from_id(self) -> str:
530
+ """Returns the data path from the ID to this object (string).
531
+
532
+ :return: The path from `bpy.types.bpy_struct.id_data`
533
+ to this struct and property (when given).
534
+ :rtype: str
535
+ """
361
536
  ...
362
537
 
363
538
  def path_menu(
364
539
  self,
365
- searchpaths,
366
- operator,
367
- props_default,
368
- prop_filepath,
369
- filter_ext,
370
- filter_path,
371
- display_name,
372
- add_operator,
373
- add_operator_props,
540
+ searchpaths: list[str],
541
+ operator: str,
542
+ props_default: dict = None,
543
+ prop_filepath: str = "filepath",
544
+ filter_ext: typing.Callable = None,
545
+ filter_path=None,
546
+ display_name: typing.Callable = None,
547
+ add_operator=None,
548
+ add_operator_props=None,
374
549
  ):
375
- """
550
+ """Populate a menu from a list of paths.
551
+
552
+ :param searchpaths: Paths to scan.
553
+ :type searchpaths: list[str]
554
+ :param operator: The operator id to use with each file.
555
+ :type operator: str
556
+ :param props_default: Properties to assign to each operator.
557
+ :type props_default: dict
558
+ :param prop_filepath: Optional operator filepath property (defaults to "filepath").
559
+ :type prop_filepath: str
560
+ :param filter_ext: Optional callback that takes the file extensions.
376
561
 
377
- :param searchpaths:
378
- :param operator:
379
- :param props_default:
380
- :param prop_filepath:
381
- :param filter_ext:
382
- :param filter_path:
383
- :param display_name:
384
- :param add_operator:
385
- :param add_operator_props:
562
+ Returning false excludes the file from the list.
563
+ :type filter_ext: typing.Callable
564
+ :param filter_path:
565
+ :param display_name: Optional callback that takes the full path, returns the name to display.
566
+ :type display_name: typing.Callable
567
+ :param add_operator:
568
+ :param add_operator_props:
386
569
  """
387
570
  ...
388
571
 
389
572
  def path_resolve(self):
390
- """ """
573
+ """Returns the property from the path, raise an exception when not found."""
391
574
  ...
392
575
 
393
576
  def pop(self):
394
- """ """
577
+ """Remove and return the value of the custom property assigned to key or default
578
+ when not found (matches Python's dictionary function of the same name).
579
+
580
+ """
395
581
  ...
396
582
 
397
583
  def prepend(self, draw_func):
398
- """
584
+ """Prepend a draw function to this menu, takes the same arguments as
585
+ the menus draw function
399
586
 
400
- :param draw_func:
587
+ :param draw_func:
401
588
  """
402
589
  ...
403
590
 
404
- def property_overridable_library_set(self):
405
- """ """
591
+ def property_overridable_library_set(self) -> bool:
592
+ """Define a property as overridable or not (only for custom properties!).
593
+
594
+ :return: True when the overridable status of the property was successfully set.
595
+ :rtype: bool
596
+ """
406
597
  ...
407
598
 
408
599
  def property_unset(self):
409
- """ """
600
+ """Unset a property, will use default value afterward."""
410
601
  ...
411
602
 
412
603
  def remove(self, draw_func):
413
- """
604
+ """Remove a draw function that has been added to this menu
414
605
 
415
606
  :param draw_func:
416
607
  """
417
608
  ...
418
609
 
419
610
  def type_recast(self):
420
- """ """
611
+ """Return a new instance, this is needed because types
612
+ such as textures can be changed at runtime.
613
+
614
+ :return: a new instance of this object with the type initialized again.
615
+ """
421
616
  ...
422
617
 
423
618
  def values(self):
424
- """ """
619
+ """Returns the values of this objects custom properties (matches Python's
620
+ dictionary function of the same name).
621
+
622
+ :return: custom property values.
623
+ """
425
624
  ...
426
625
 
427
626
  class GPENCIL_UL_vgroups(bpy_types.UIList, bpy_types._GenericUI):
@@ -434,22 +633,35 @@ class GPENCIL_UL_vgroups(bpy_types.UIList, bpy_types._GenericUI):
434
633
  """ """
435
634
 
436
635
  def append(self, draw_func):
437
- """
636
+ """Append a draw function to this menu,
637
+ takes the same arguments as the menus draw function
438
638
 
439
- :param draw_func:
639
+ :param draw_func:
440
640
  """
441
641
  ...
442
642
 
443
- def as_pointer(self):
444
- """ """
643
+ def as_pointer(self) -> int:
644
+ """Returns the memory address which holds a pointer to Blender's internal data
645
+
646
+ :return: int (memory address).
647
+ :rtype: int
648
+ """
445
649
  ...
446
650
 
447
- def bl_rna_get_subclass(self):
448
- """ """
651
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
652
+ """
653
+
654
+ :return: The RNA type or default when not found.
655
+ :rtype: bpy.types.Struct
656
+ """
449
657
  ...
450
658
 
451
- def bl_rna_get_subclass_py(self):
452
- """ """
659
+ def bl_rna_get_subclass_py(self) -> typing.Any:
660
+ """
661
+
662
+ :return: The class or default when not found.
663
+ :rtype: typing.Any
664
+ """
453
665
  ...
454
666
 
455
667
  def draw_item(
@@ -476,106 +688,179 @@ class GPENCIL_UL_vgroups(bpy_types.UIList, bpy_types._GenericUI):
476
688
  """
477
689
  ...
478
690
 
479
- def driver_add(self):
480
- """ """
691
+ def driver_add(self) -> bpy.types.FCurve:
692
+ """Adds driver(s) to the given property
693
+
694
+ :return: The driver(s) added.
695
+ :rtype: bpy.types.FCurve
696
+ """
481
697
  ...
482
698
 
483
- def driver_remove(self):
484
- """ """
699
+ def driver_remove(self) -> bool:
700
+ """Remove driver(s) from the given property
701
+
702
+ :return: Success of driver removal.
703
+ :rtype: bool
704
+ """
485
705
  ...
486
706
 
487
707
  def get(self):
488
- """ """
708
+ """Returns the value of the custom property assigned to key or default
709
+ when not found (matches Python's dictionary function of the same name).
710
+
711
+ """
489
712
  ...
490
713
 
491
714
  def id_properties_clear(self):
492
- """ """
715
+ """
716
+
717
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
718
+ """
493
719
  ...
494
720
 
495
721
  def id_properties_ensure(self):
496
- """ """
722
+ """
723
+
724
+ :return: the parent group for an RNA struct's custom IDProperties.
725
+ """
497
726
  ...
498
727
 
499
728
  def id_properties_ui(self):
500
- """ """
729
+ """
730
+
731
+ :return: Return an object used to manage an IDProperty's UI data.
732
+ """
501
733
  ...
502
734
 
503
735
  def is_extended(self):
504
736
  """ """
505
737
  ...
506
738
 
507
- def is_property_hidden(self):
508
- """ """
739
+ def is_property_hidden(self) -> bool:
740
+ """Check if a property is hidden.
741
+
742
+ :return: True when the property is hidden.
743
+ :rtype: bool
744
+ """
509
745
  ...
510
746
 
511
- def is_property_overridable_library(self):
512
- """ """
747
+ def is_property_overridable_library(self) -> bool:
748
+ """Check if a property is overridable.
749
+
750
+ :return: True when the property is overridable.
751
+ :rtype: bool
752
+ """
513
753
  ...
514
754
 
515
- def is_property_readonly(self):
516
- """ """
755
+ def is_property_readonly(self) -> bool:
756
+ """Check if a property is readonly.
757
+
758
+ :return: True when the property is readonly (not writable).
759
+ :rtype: bool
760
+ """
517
761
  ...
518
762
 
519
- def is_property_set(self):
520
- """ """
763
+ def is_property_set(self) -> bool:
764
+ """Check if a property is set, use for testing operator properties.
765
+
766
+ :return: True when the property has been set.
767
+ :rtype: bool
768
+ """
521
769
  ...
522
770
 
523
771
  def items(self):
524
- """ """
772
+ """Returns the items of this objects custom properties (matches Python's
773
+ dictionary function of the same name).
774
+
775
+ :return: custom property key, value pairs.
776
+ """
525
777
  ...
526
778
 
527
- def keyframe_delete(self):
528
- """ """
779
+ def keyframe_delete(self) -> bool:
780
+ """Remove a keyframe from this properties fcurve.
781
+
782
+ :return: Success of keyframe deletion.
783
+ :rtype: bool
784
+ """
529
785
  ...
530
786
 
531
- def keyframe_insert(self):
532
- """ """
787
+ def keyframe_insert(self) -> bool:
788
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
789
+
790
+ :return: Success of keyframe insertion.
791
+ :rtype: bool
792
+ """
533
793
  ...
534
794
 
535
795
  def keys(self):
536
- """ """
796
+ """Returns the keys of this objects custom properties (matches Python's
797
+ dictionary function of the same name).
798
+
799
+ :return: custom property keys.
800
+ """
537
801
  ...
538
802
 
539
- def path_from_id(self):
540
- """ """
803
+ def path_from_id(self) -> str:
804
+ """Returns the data path from the ID to this object (string).
805
+
806
+ :return: The path from `bpy.types.bpy_struct.id_data`
807
+ to this struct and property (when given).
808
+ :rtype: str
809
+ """
541
810
  ...
542
811
 
543
812
  def path_resolve(self):
544
- """ """
813
+ """Returns the property from the path, raise an exception when not found."""
545
814
  ...
546
815
 
547
816
  def pop(self):
548
- """ """
817
+ """Remove and return the value of the custom property assigned to key or default
818
+ when not found (matches Python's dictionary function of the same name).
819
+
820
+ """
549
821
  ...
550
822
 
551
823
  def prepend(self, draw_func):
552
- """
824
+ """Prepend a draw function to this menu, takes the same arguments as
825
+ the menus draw function
553
826
 
554
- :param draw_func:
827
+ :param draw_func:
555
828
  """
556
829
  ...
557
830
 
558
- def property_overridable_library_set(self):
559
- """ """
831
+ def property_overridable_library_set(self) -> bool:
832
+ """Define a property as overridable or not (only for custom properties!).
833
+
834
+ :return: True when the overridable status of the property was successfully set.
835
+ :rtype: bool
836
+ """
560
837
  ...
561
838
 
562
839
  def property_unset(self):
563
- """ """
840
+ """Unset a property, will use default value afterward."""
564
841
  ...
565
842
 
566
843
  def remove(self, draw_func):
567
- """
844
+ """Remove a draw function that has been added to this menu
568
845
 
569
846
  :param draw_func:
570
847
  """
571
848
  ...
572
849
 
573
850
  def type_recast(self):
574
- """ """
851
+ """Return a new instance, this is needed because types
852
+ such as textures can be changed at runtime.
853
+
854
+ :return: a new instance of this object with the type initialized again.
855
+ """
575
856
  ...
576
857
 
577
858
  def values(self):
578
- """ """
859
+ """Returns the values of this objects custom properties (matches Python's
860
+ dictionary function of the same name).
861
+
862
+ :return: custom property values.
863
+ """
579
864
  ...
580
865
 
581
866
  class DATA_PT_context_gpencil(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -603,22 +888,35 @@ class DATA_PT_context_gpencil(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
603
888
  """ """
604
889
 
605
890
  def append(self, draw_func):
606
- """
891
+ """Append a draw function to this menu,
892
+ takes the same arguments as the menus draw function
607
893
 
608
- :param draw_func:
894
+ :param draw_func:
609
895
  """
610
896
  ...
611
897
 
612
- def as_pointer(self):
613
- """ """
898
+ def as_pointer(self) -> int:
899
+ """Returns the memory address which holds a pointer to Blender's internal data
900
+
901
+ :return: int (memory address).
902
+ :rtype: int
903
+ """
614
904
  ...
615
905
 
616
- def bl_rna_get_subclass(self):
617
- """ """
906
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
907
+ """
908
+
909
+ :return: The RNA type or default when not found.
910
+ :rtype: bpy.types.Struct
911
+ """
618
912
  ...
619
913
 
620
- def bl_rna_get_subclass_py(self):
621
- """ """
914
+ def bl_rna_get_subclass_py(self) -> typing.Any:
915
+ """
916
+
917
+ :return: The class or default when not found.
918
+ :rtype: typing.Any
919
+ """
622
920
  ...
623
921
 
624
922
  def draw(self, context):
@@ -628,72 +926,129 @@ class DATA_PT_context_gpencil(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
628
926
  """
629
927
  ...
630
928
 
631
- def driver_add(self):
632
- """ """
929
+ def driver_add(self) -> bpy.types.FCurve:
930
+ """Adds driver(s) to the given property
931
+
932
+ :return: The driver(s) added.
933
+ :rtype: bpy.types.FCurve
934
+ """
633
935
  ...
634
936
 
635
- def driver_remove(self):
636
- """ """
937
+ def driver_remove(self) -> bool:
938
+ """Remove driver(s) from the given property
939
+
940
+ :return: Success of driver removal.
941
+ :rtype: bool
942
+ """
637
943
  ...
638
944
 
639
945
  def get(self):
640
- """ """
946
+ """Returns the value of the custom property assigned to key or default
947
+ when not found (matches Python's dictionary function of the same name).
948
+
949
+ """
641
950
  ...
642
951
 
643
952
  def id_properties_clear(self):
644
- """ """
953
+ """
954
+
955
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
956
+ """
645
957
  ...
646
958
 
647
959
  def id_properties_ensure(self):
648
- """ """
960
+ """
961
+
962
+ :return: the parent group for an RNA struct's custom IDProperties.
963
+ """
649
964
  ...
650
965
 
651
966
  def id_properties_ui(self):
652
- """ """
967
+ """
968
+
969
+ :return: Return an object used to manage an IDProperty's UI data.
970
+ """
653
971
  ...
654
972
 
655
973
  def is_extended(self):
656
974
  """ """
657
975
  ...
658
976
 
659
- def is_property_hidden(self):
660
- """ """
977
+ def is_property_hidden(self) -> bool:
978
+ """Check if a property is hidden.
979
+
980
+ :return: True when the property is hidden.
981
+ :rtype: bool
982
+ """
661
983
  ...
662
984
 
663
- def is_property_overridable_library(self):
664
- """ """
985
+ def is_property_overridable_library(self) -> bool:
986
+ """Check if a property is overridable.
987
+
988
+ :return: True when the property is overridable.
989
+ :rtype: bool
990
+ """
665
991
  ...
666
992
 
667
- def is_property_readonly(self):
668
- """ """
993
+ def is_property_readonly(self) -> bool:
994
+ """Check if a property is readonly.
995
+
996
+ :return: True when the property is readonly (not writable).
997
+ :rtype: bool
998
+ """
669
999
  ...
670
1000
 
671
- def is_property_set(self):
672
- """ """
1001
+ def is_property_set(self) -> bool:
1002
+ """Check if a property is set, use for testing operator properties.
1003
+
1004
+ :return: True when the property has been set.
1005
+ :rtype: bool
1006
+ """
673
1007
  ...
674
1008
 
675
1009
  def items(self):
676
- """ """
1010
+ """Returns the items of this objects custom properties (matches Python's
1011
+ dictionary function of the same name).
1012
+
1013
+ :return: custom property key, value pairs.
1014
+ """
677
1015
  ...
678
1016
 
679
- def keyframe_delete(self):
680
- """ """
1017
+ def keyframe_delete(self) -> bool:
1018
+ """Remove a keyframe from this properties fcurve.
1019
+
1020
+ :return: Success of keyframe deletion.
1021
+ :rtype: bool
1022
+ """
681
1023
  ...
682
1024
 
683
- def keyframe_insert(self):
684
- """ """
1025
+ def keyframe_insert(self) -> bool:
1026
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1027
+
1028
+ :return: Success of keyframe insertion.
1029
+ :rtype: bool
1030
+ """
685
1031
  ...
686
1032
 
687
1033
  def keys(self):
688
- """ """
1034
+ """Returns the keys of this objects custom properties (matches Python's
1035
+ dictionary function of the same name).
1036
+
1037
+ :return: custom property keys.
1038
+ """
689
1039
  ...
690
1040
 
691
- def path_from_id(self):
692
- """ """
1041
+ def path_from_id(self) -> str:
1042
+ """Returns the data path from the ID to this object (string).
1043
+
1044
+ :return: The path from `bpy.types.bpy_struct.id_data`
1045
+ to this struct and property (when given).
1046
+ :rtype: str
1047
+ """
693
1048
  ...
694
1049
 
695
1050
  def path_resolve(self):
696
- """ """
1051
+ """Returns the property from the path, raise an exception when not found."""
697
1052
  ...
698
1053
 
699
1054
  def poll(self, context):
@@ -704,43 +1059,61 @@ class DATA_PT_context_gpencil(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
704
1059
  ...
705
1060
 
706
1061
  def pop(self):
707
- """ """
1062
+ """Remove and return the value of the custom property assigned to key or default
1063
+ when not found (matches Python's dictionary function of the same name).
1064
+
1065
+ """
708
1066
  ...
709
1067
 
710
1068
  def prepend(self, draw_func):
711
- """
1069
+ """Prepend a draw function to this menu, takes the same arguments as
1070
+ the menus draw function
712
1071
 
713
- :param draw_func:
1072
+ :param draw_func:
714
1073
  """
715
1074
  ...
716
1075
 
717
- def property_overridable_library_set(self):
718
- """ """
1076
+ def property_overridable_library_set(self) -> bool:
1077
+ """Define a property as overridable or not (only for custom properties!).
1078
+
1079
+ :return: True when the overridable status of the property was successfully set.
1080
+ :rtype: bool
1081
+ """
719
1082
  ...
720
1083
 
721
1084
  def property_unset(self):
722
- """ """
1085
+ """Unset a property, will use default value afterward."""
723
1086
  ...
724
1087
 
725
1088
  def remove(self, draw_func):
726
- """
1089
+ """Remove a draw function that has been added to this menu
727
1090
 
728
1091
  :param draw_func:
729
1092
  """
730
1093
  ...
731
1094
 
732
1095
  def type_recast(self):
733
- """ """
1096
+ """Return a new instance, this is needed because types
1097
+ such as textures can be changed at runtime.
1098
+
1099
+ :return: a new instance of this object with the type initialized again.
1100
+ """
734
1101
  ...
735
1102
 
736
1103
  def values(self):
737
- """ """
1104
+ """Returns the values of this objects custom properties (matches Python's
1105
+ dictionary function of the same name).
1106
+
1107
+ :return: custom property values.
1108
+ """
738
1109
  ...
739
1110
 
740
1111
  class DATA_PT_custom_props_gpencil(
741
1112
  bpy_types.Panel, DataButtonsPanel, rna_prop_ui.PropertyPanel, bpy_types._GenericUI
742
1113
  ):
743
- """ """
1114
+ """The subclass should have its own poll function
1115
+ and the variable '_context_path' MUST be set.
1116
+ """
744
1117
 
745
1118
  bl_context: typing.Any
746
1119
  """ """
@@ -767,22 +1140,35 @@ class DATA_PT_custom_props_gpencil(
767
1140
  """ """
768
1141
 
769
1142
  def append(self, draw_func):
770
- """
1143
+ """Append a draw function to this menu,
1144
+ takes the same arguments as the menus draw function
771
1145
 
772
- :param draw_func:
1146
+ :param draw_func:
773
1147
  """
774
1148
  ...
775
1149
 
776
- def as_pointer(self):
777
- """ """
1150
+ def as_pointer(self) -> int:
1151
+ """Returns the memory address which holds a pointer to Blender's internal data
1152
+
1153
+ :return: int (memory address).
1154
+ :rtype: int
1155
+ """
778
1156
  ...
779
1157
 
780
- def bl_rna_get_subclass(self):
781
- """ """
1158
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1159
+ """
1160
+
1161
+ :return: The RNA type or default when not found.
1162
+ :rtype: bpy.types.Struct
1163
+ """
782
1164
  ...
783
1165
 
784
- def bl_rna_get_subclass_py(self):
785
- """ """
1166
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1167
+ """
1168
+
1169
+ :return: The class or default when not found.
1170
+ :rtype: typing.Any
1171
+ """
786
1172
  ...
787
1173
 
788
1174
  def draw(self, context):
@@ -792,72 +1178,129 @@ class DATA_PT_custom_props_gpencil(
792
1178
  """
793
1179
  ...
794
1180
 
795
- def driver_add(self):
796
- """ """
1181
+ def driver_add(self) -> bpy.types.FCurve:
1182
+ """Adds driver(s) to the given property
1183
+
1184
+ :return: The driver(s) added.
1185
+ :rtype: bpy.types.FCurve
1186
+ """
797
1187
  ...
798
1188
 
799
- def driver_remove(self):
800
- """ """
1189
+ def driver_remove(self) -> bool:
1190
+ """Remove driver(s) from the given property
1191
+
1192
+ :return: Success of driver removal.
1193
+ :rtype: bool
1194
+ """
801
1195
  ...
802
1196
 
803
1197
  def get(self):
804
- """ """
1198
+ """Returns the value of the custom property assigned to key or default
1199
+ when not found (matches Python's dictionary function of the same name).
1200
+
1201
+ """
805
1202
  ...
806
1203
 
807
1204
  def id_properties_clear(self):
808
- """ """
1205
+ """
1206
+
1207
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1208
+ """
809
1209
  ...
810
1210
 
811
1211
  def id_properties_ensure(self):
812
- """ """
1212
+ """
1213
+
1214
+ :return: the parent group for an RNA struct's custom IDProperties.
1215
+ """
813
1216
  ...
814
1217
 
815
1218
  def id_properties_ui(self):
816
- """ """
1219
+ """
1220
+
1221
+ :return: Return an object used to manage an IDProperty's UI data.
1222
+ """
817
1223
  ...
818
1224
 
819
1225
  def is_extended(self):
820
1226
  """ """
821
1227
  ...
822
1228
 
823
- def is_property_hidden(self):
824
- """ """
1229
+ def is_property_hidden(self) -> bool:
1230
+ """Check if a property is hidden.
1231
+
1232
+ :return: True when the property is hidden.
1233
+ :rtype: bool
1234
+ """
825
1235
  ...
826
1236
 
827
- def is_property_overridable_library(self):
828
- """ """
1237
+ def is_property_overridable_library(self) -> bool:
1238
+ """Check if a property is overridable.
1239
+
1240
+ :return: True when the property is overridable.
1241
+ :rtype: bool
1242
+ """
829
1243
  ...
830
1244
 
831
- def is_property_readonly(self):
832
- """ """
1245
+ def is_property_readonly(self) -> bool:
1246
+ """Check if a property is readonly.
1247
+
1248
+ :return: True when the property is readonly (not writable).
1249
+ :rtype: bool
1250
+ """
833
1251
  ...
834
1252
 
835
- def is_property_set(self):
836
- """ """
1253
+ def is_property_set(self) -> bool:
1254
+ """Check if a property is set, use for testing operator properties.
1255
+
1256
+ :return: True when the property has been set.
1257
+ :rtype: bool
1258
+ """
837
1259
  ...
838
1260
 
839
1261
  def items(self):
840
- """ """
1262
+ """Returns the items of this objects custom properties (matches Python's
1263
+ dictionary function of the same name).
1264
+
1265
+ :return: custom property key, value pairs.
1266
+ """
841
1267
  ...
842
1268
 
843
- def keyframe_delete(self):
844
- """ """
1269
+ def keyframe_delete(self) -> bool:
1270
+ """Remove a keyframe from this properties fcurve.
1271
+
1272
+ :return: Success of keyframe deletion.
1273
+ :rtype: bool
1274
+ """
845
1275
  ...
846
1276
 
847
- def keyframe_insert(self):
848
- """ """
1277
+ def keyframe_insert(self) -> bool:
1278
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1279
+
1280
+ :return: Success of keyframe insertion.
1281
+ :rtype: bool
1282
+ """
849
1283
  ...
850
1284
 
851
1285
  def keys(self):
852
- """ """
1286
+ """Returns the keys of this objects custom properties (matches Python's
1287
+ dictionary function of the same name).
1288
+
1289
+ :return: custom property keys.
1290
+ """
853
1291
  ...
854
1292
 
855
- def path_from_id(self):
856
- """ """
1293
+ def path_from_id(self) -> str:
1294
+ """Returns the data path from the ID to this object (string).
1295
+
1296
+ :return: The path from `bpy.types.bpy_struct.id_data`
1297
+ to this struct and property (when given).
1298
+ :rtype: str
1299
+ """
857
1300
  ...
858
1301
 
859
1302
  def path_resolve(self):
860
- """ """
1303
+ """Returns the property from the path, raise an exception when not found."""
861
1304
  ...
862
1305
 
863
1306
  def poll(self, context):
@@ -868,37 +1311,53 @@ class DATA_PT_custom_props_gpencil(
868
1311
  ...
869
1312
 
870
1313
  def pop(self):
871
- """ """
1314
+ """Remove and return the value of the custom property assigned to key or default
1315
+ when not found (matches Python's dictionary function of the same name).
1316
+
1317
+ """
872
1318
  ...
873
1319
 
874
1320
  def prepend(self, draw_func):
875
- """
1321
+ """Prepend a draw function to this menu, takes the same arguments as
1322
+ the menus draw function
876
1323
 
877
- :param draw_func:
1324
+ :param draw_func:
878
1325
  """
879
1326
  ...
880
1327
 
881
- def property_overridable_library_set(self):
882
- """ """
1328
+ def property_overridable_library_set(self) -> bool:
1329
+ """Define a property as overridable or not (only for custom properties!).
1330
+
1331
+ :return: True when the overridable status of the property was successfully set.
1332
+ :rtype: bool
1333
+ """
883
1334
  ...
884
1335
 
885
1336
  def property_unset(self):
886
- """ """
1337
+ """Unset a property, will use default value afterward."""
887
1338
  ...
888
1339
 
889
1340
  def remove(self, draw_func):
890
- """
1341
+ """Remove a draw function that has been added to this menu
891
1342
 
892
1343
  :param draw_func:
893
1344
  """
894
1345
  ...
895
1346
 
896
1347
  def type_recast(self):
897
- """ """
1348
+ """Return a new instance, this is needed because types
1349
+ such as textures can be changed at runtime.
1350
+
1351
+ :return: a new instance of this object with the type initialized again.
1352
+ """
898
1353
  ...
899
1354
 
900
1355
  def values(self):
901
- """ """
1356
+ """Returns the values of this objects custom properties (matches Python's
1357
+ dictionary function of the same name).
1358
+
1359
+ :return: custom property values.
1360
+ """
902
1361
  ...
903
1362
 
904
1363
  class DATA_PT_gpencil_canvas(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -929,22 +1388,35 @@ class DATA_PT_gpencil_canvas(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
929
1388
  """ """
930
1389
 
931
1390
  def append(self, draw_func):
932
- """
1391
+ """Append a draw function to this menu,
1392
+ takes the same arguments as the menus draw function
933
1393
 
934
- :param draw_func:
1394
+ :param draw_func:
935
1395
  """
936
1396
  ...
937
1397
 
938
- def as_pointer(self):
939
- """ """
1398
+ def as_pointer(self) -> int:
1399
+ """Returns the memory address which holds a pointer to Blender's internal data
1400
+
1401
+ :return: int (memory address).
1402
+ :rtype: int
1403
+ """
940
1404
  ...
941
1405
 
942
- def bl_rna_get_subclass(self):
943
- """ """
1406
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1407
+ """
1408
+
1409
+ :return: The RNA type or default when not found.
1410
+ :rtype: bpy.types.Struct
1411
+ """
944
1412
  ...
945
1413
 
946
- def bl_rna_get_subclass_py(self):
947
- """ """
1414
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1415
+ """
1416
+
1417
+ :return: The class or default when not found.
1418
+ :rtype: typing.Any
1419
+ """
948
1420
  ...
949
1421
 
950
1422
  def draw(self, context):
@@ -954,72 +1426,129 @@ class DATA_PT_gpencil_canvas(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
954
1426
  """
955
1427
  ...
956
1428
 
957
- def driver_add(self):
958
- """ """
1429
+ def driver_add(self) -> bpy.types.FCurve:
1430
+ """Adds driver(s) to the given property
1431
+
1432
+ :return: The driver(s) added.
1433
+ :rtype: bpy.types.FCurve
1434
+ """
959
1435
  ...
960
1436
 
961
- def driver_remove(self):
962
- """ """
1437
+ def driver_remove(self) -> bool:
1438
+ """Remove driver(s) from the given property
1439
+
1440
+ :return: Success of driver removal.
1441
+ :rtype: bool
1442
+ """
963
1443
  ...
964
1444
 
965
1445
  def get(self):
966
- """ """
1446
+ """Returns the value of the custom property assigned to key or default
1447
+ when not found (matches Python's dictionary function of the same name).
1448
+
1449
+ """
967
1450
  ...
968
1451
 
969
1452
  def id_properties_clear(self):
970
- """ """
1453
+ """
1454
+
1455
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1456
+ """
971
1457
  ...
972
1458
 
973
1459
  def id_properties_ensure(self):
974
- """ """
1460
+ """
1461
+
1462
+ :return: the parent group for an RNA struct's custom IDProperties.
1463
+ """
975
1464
  ...
976
1465
 
977
1466
  def id_properties_ui(self):
978
- """ """
1467
+ """
1468
+
1469
+ :return: Return an object used to manage an IDProperty's UI data.
1470
+ """
979
1471
  ...
980
1472
 
981
1473
  def is_extended(self):
982
1474
  """ """
983
1475
  ...
984
1476
 
985
- def is_property_hidden(self):
986
- """ """
1477
+ def is_property_hidden(self) -> bool:
1478
+ """Check if a property is hidden.
1479
+
1480
+ :return: True when the property is hidden.
1481
+ :rtype: bool
1482
+ """
987
1483
  ...
988
1484
 
989
- def is_property_overridable_library(self):
990
- """ """
1485
+ def is_property_overridable_library(self) -> bool:
1486
+ """Check if a property is overridable.
1487
+
1488
+ :return: True when the property is overridable.
1489
+ :rtype: bool
1490
+ """
991
1491
  ...
992
1492
 
993
- def is_property_readonly(self):
994
- """ """
1493
+ def is_property_readonly(self) -> bool:
1494
+ """Check if a property is readonly.
1495
+
1496
+ :return: True when the property is readonly (not writable).
1497
+ :rtype: bool
1498
+ """
995
1499
  ...
996
1500
 
997
- def is_property_set(self):
998
- """ """
1501
+ def is_property_set(self) -> bool:
1502
+ """Check if a property is set, use for testing operator properties.
1503
+
1504
+ :return: True when the property has been set.
1505
+ :rtype: bool
1506
+ """
999
1507
  ...
1000
1508
 
1001
1509
  def items(self):
1002
- """ """
1510
+ """Returns the items of this objects custom properties (matches Python's
1511
+ dictionary function of the same name).
1512
+
1513
+ :return: custom property key, value pairs.
1514
+ """
1003
1515
  ...
1004
1516
 
1005
- def keyframe_delete(self):
1006
- """ """
1517
+ def keyframe_delete(self) -> bool:
1518
+ """Remove a keyframe from this properties fcurve.
1519
+
1520
+ :return: Success of keyframe deletion.
1521
+ :rtype: bool
1522
+ """
1007
1523
  ...
1008
1524
 
1009
- def keyframe_insert(self):
1010
- """ """
1525
+ def keyframe_insert(self) -> bool:
1526
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1527
+
1528
+ :return: Success of keyframe insertion.
1529
+ :rtype: bool
1530
+ """
1011
1531
  ...
1012
1532
 
1013
1533
  def keys(self):
1014
- """ """
1534
+ """Returns the keys of this objects custom properties (matches Python's
1535
+ dictionary function of the same name).
1536
+
1537
+ :return: custom property keys.
1538
+ """
1015
1539
  ...
1016
1540
 
1017
- def path_from_id(self):
1018
- """ """
1541
+ def path_from_id(self) -> str:
1542
+ """Returns the data path from the ID to this object (string).
1543
+
1544
+ :return: The path from `bpy.types.bpy_struct.id_data`
1545
+ to this struct and property (when given).
1546
+ :rtype: str
1547
+ """
1019
1548
  ...
1020
1549
 
1021
1550
  def path_resolve(self):
1022
- """ """
1551
+ """Returns the property from the path, raise an exception when not found."""
1023
1552
  ...
1024
1553
 
1025
1554
  def poll(self, context):
@@ -1030,37 +1559,53 @@ class DATA_PT_gpencil_canvas(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
1030
1559
  ...
1031
1560
 
1032
1561
  def pop(self):
1033
- """ """
1562
+ """Remove and return the value of the custom property assigned to key or default
1563
+ when not found (matches Python's dictionary function of the same name).
1564
+
1565
+ """
1034
1566
  ...
1035
1567
 
1036
1568
  def prepend(self, draw_func):
1037
- """
1569
+ """Prepend a draw function to this menu, takes the same arguments as
1570
+ the menus draw function
1038
1571
 
1039
- :param draw_func:
1572
+ :param draw_func:
1040
1573
  """
1041
1574
  ...
1042
1575
 
1043
- def property_overridable_library_set(self):
1044
- """ """
1576
+ def property_overridable_library_set(self) -> bool:
1577
+ """Define a property as overridable or not (only for custom properties!).
1578
+
1579
+ :return: True when the overridable status of the property was successfully set.
1580
+ :rtype: bool
1581
+ """
1045
1582
  ...
1046
1583
 
1047
1584
  def property_unset(self):
1048
- """ """
1585
+ """Unset a property, will use default value afterward."""
1049
1586
  ...
1050
1587
 
1051
1588
  def remove(self, draw_func):
1052
- """
1589
+ """Remove a draw function that has been added to this menu
1053
1590
 
1054
1591
  :param draw_func:
1055
1592
  """
1056
1593
  ...
1057
1594
 
1058
1595
  def type_recast(self):
1059
- """ """
1596
+ """Return a new instance, this is needed because types
1597
+ such as textures can be changed at runtime.
1598
+
1599
+ :return: a new instance of this object with the type initialized again.
1600
+ """
1060
1601
  ...
1061
1602
 
1062
1603
  def values(self):
1063
- """ """
1604
+ """Returns the values of this objects custom properties (matches Python's
1605
+ dictionary function of the same name).
1606
+
1607
+ :return: custom property values.
1608
+ """
1064
1609
  ...
1065
1610
 
1066
1611
  class DATA_PT_gpencil_display(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -1088,22 +1633,35 @@ class DATA_PT_gpencil_display(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
1088
1633
  """ """
1089
1634
 
1090
1635
  def append(self, draw_func):
1091
- """
1636
+ """Append a draw function to this menu,
1637
+ takes the same arguments as the menus draw function
1092
1638
 
1093
- :param draw_func:
1639
+ :param draw_func:
1094
1640
  """
1095
1641
  ...
1096
1642
 
1097
- def as_pointer(self):
1098
- """ """
1643
+ def as_pointer(self) -> int:
1644
+ """Returns the memory address which holds a pointer to Blender's internal data
1645
+
1646
+ :return: int (memory address).
1647
+ :rtype: int
1648
+ """
1099
1649
  ...
1100
1650
 
1101
- def bl_rna_get_subclass(self):
1102
- """ """
1651
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1652
+ """
1653
+
1654
+ :return: The RNA type or default when not found.
1655
+ :rtype: bpy.types.Struct
1656
+ """
1103
1657
  ...
1104
1658
 
1105
- def bl_rna_get_subclass_py(self):
1106
- """ """
1659
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1660
+ """
1661
+
1662
+ :return: The class or default when not found.
1663
+ :rtype: typing.Any
1664
+ """
1107
1665
  ...
1108
1666
 
1109
1667
  def draw(self, context):
@@ -1113,72 +1671,129 @@ class DATA_PT_gpencil_display(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
1113
1671
  """
1114
1672
  ...
1115
1673
 
1116
- def driver_add(self):
1117
- """ """
1674
+ def driver_add(self) -> bpy.types.FCurve:
1675
+ """Adds driver(s) to the given property
1676
+
1677
+ :return: The driver(s) added.
1678
+ :rtype: bpy.types.FCurve
1679
+ """
1118
1680
  ...
1119
1681
 
1120
- def driver_remove(self):
1121
- """ """
1682
+ def driver_remove(self) -> bool:
1683
+ """Remove driver(s) from the given property
1684
+
1685
+ :return: Success of driver removal.
1686
+ :rtype: bool
1687
+ """
1122
1688
  ...
1123
1689
 
1124
1690
  def get(self):
1125
- """ """
1691
+ """Returns the value of the custom property assigned to key or default
1692
+ when not found (matches Python's dictionary function of the same name).
1693
+
1694
+ """
1126
1695
  ...
1127
1696
 
1128
1697
  def id_properties_clear(self):
1129
- """ """
1698
+ """
1699
+
1700
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1701
+ """
1130
1702
  ...
1131
1703
 
1132
1704
  def id_properties_ensure(self):
1133
- """ """
1705
+ """
1706
+
1707
+ :return: the parent group for an RNA struct's custom IDProperties.
1708
+ """
1134
1709
  ...
1135
1710
 
1136
1711
  def id_properties_ui(self):
1137
- """ """
1712
+ """
1713
+
1714
+ :return: Return an object used to manage an IDProperty's UI data.
1715
+ """
1138
1716
  ...
1139
1717
 
1140
1718
  def is_extended(self):
1141
1719
  """ """
1142
1720
  ...
1143
1721
 
1144
- def is_property_hidden(self):
1145
- """ """
1722
+ def is_property_hidden(self) -> bool:
1723
+ """Check if a property is hidden.
1724
+
1725
+ :return: True when the property is hidden.
1726
+ :rtype: bool
1727
+ """
1146
1728
  ...
1147
1729
 
1148
- def is_property_overridable_library(self):
1149
- """ """
1730
+ def is_property_overridable_library(self) -> bool:
1731
+ """Check if a property is overridable.
1732
+
1733
+ :return: True when the property is overridable.
1734
+ :rtype: bool
1735
+ """
1150
1736
  ...
1151
1737
 
1152
- def is_property_readonly(self):
1153
- """ """
1738
+ def is_property_readonly(self) -> bool:
1739
+ """Check if a property is readonly.
1740
+
1741
+ :return: True when the property is readonly (not writable).
1742
+ :rtype: bool
1743
+ """
1154
1744
  ...
1155
1745
 
1156
- def is_property_set(self):
1157
- """ """
1746
+ def is_property_set(self) -> bool:
1747
+ """Check if a property is set, use for testing operator properties.
1748
+
1749
+ :return: True when the property has been set.
1750
+ :rtype: bool
1751
+ """
1158
1752
  ...
1159
1753
 
1160
1754
  def items(self):
1161
- """ """
1755
+ """Returns the items of this objects custom properties (matches Python's
1756
+ dictionary function of the same name).
1757
+
1758
+ :return: custom property key, value pairs.
1759
+ """
1162
1760
  ...
1163
1761
 
1164
- def keyframe_delete(self):
1165
- """ """
1762
+ def keyframe_delete(self) -> bool:
1763
+ """Remove a keyframe from this properties fcurve.
1764
+
1765
+ :return: Success of keyframe deletion.
1766
+ :rtype: bool
1767
+ """
1166
1768
  ...
1167
1769
 
1168
- def keyframe_insert(self):
1169
- """ """
1770
+ def keyframe_insert(self) -> bool:
1771
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1772
+
1773
+ :return: Success of keyframe insertion.
1774
+ :rtype: bool
1775
+ """
1170
1776
  ...
1171
1777
 
1172
1778
  def keys(self):
1173
- """ """
1779
+ """Returns the keys of this objects custom properties (matches Python's
1780
+ dictionary function of the same name).
1781
+
1782
+ :return: custom property keys.
1783
+ """
1174
1784
  ...
1175
1785
 
1176
- def path_from_id(self):
1177
- """ """
1786
+ def path_from_id(self) -> str:
1787
+ """Returns the data path from the ID to this object (string).
1788
+
1789
+ :return: The path from `bpy.types.bpy_struct.id_data`
1790
+ to this struct and property (when given).
1791
+ :rtype: str
1792
+ """
1178
1793
  ...
1179
1794
 
1180
1795
  def path_resolve(self):
1181
- """ """
1796
+ """Returns the property from the path, raise an exception when not found."""
1182
1797
  ...
1183
1798
 
1184
1799
  def poll(self, context):
@@ -1189,37 +1804,53 @@ class DATA_PT_gpencil_display(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
1189
1804
  ...
1190
1805
 
1191
1806
  def pop(self):
1192
- """ """
1807
+ """Remove and return the value of the custom property assigned to key or default
1808
+ when not found (matches Python's dictionary function of the same name).
1809
+
1810
+ """
1193
1811
  ...
1194
1812
 
1195
1813
  def prepend(self, draw_func):
1196
- """
1814
+ """Prepend a draw function to this menu, takes the same arguments as
1815
+ the menus draw function
1197
1816
 
1198
- :param draw_func:
1817
+ :param draw_func:
1199
1818
  """
1200
1819
  ...
1201
1820
 
1202
- def property_overridable_library_set(self):
1203
- """ """
1821
+ def property_overridable_library_set(self) -> bool:
1822
+ """Define a property as overridable or not (only for custom properties!).
1823
+
1824
+ :return: True when the overridable status of the property was successfully set.
1825
+ :rtype: bool
1826
+ """
1204
1827
  ...
1205
1828
 
1206
1829
  def property_unset(self):
1207
- """ """
1830
+ """Unset a property, will use default value afterward."""
1208
1831
  ...
1209
1832
 
1210
1833
  def remove(self, draw_func):
1211
- """
1834
+ """Remove a draw function that has been added to this menu
1212
1835
 
1213
1836
  :param draw_func:
1214
1837
  """
1215
1838
  ...
1216
1839
 
1217
1840
  def type_recast(self):
1218
- """ """
1841
+ """Return a new instance, this is needed because types
1842
+ such as textures can be changed at runtime.
1843
+
1844
+ :return: a new instance of this object with the type initialized again.
1845
+ """
1219
1846
  ...
1220
1847
 
1221
1848
  def values(self):
1222
- """ """
1849
+ """Returns the values of this objects custom properties (matches Python's
1850
+ dictionary function of the same name).
1851
+
1852
+ :return: custom property values.
1853
+ """
1223
1854
  ...
1224
1855
 
1225
1856
  class DATA_PT_gpencil_layers(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -1244,22 +1875,35 @@ class DATA_PT_gpencil_layers(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
1244
1875
  """ """
1245
1876
 
1246
1877
  def append(self, draw_func):
1247
- """
1878
+ """Append a draw function to this menu,
1879
+ takes the same arguments as the menus draw function
1248
1880
 
1249
- :param draw_func:
1881
+ :param draw_func:
1250
1882
  """
1251
1883
  ...
1252
1884
 
1253
- def as_pointer(self):
1254
- """ """
1885
+ def as_pointer(self) -> int:
1886
+ """Returns the memory address which holds a pointer to Blender's internal data
1887
+
1888
+ :return: int (memory address).
1889
+ :rtype: int
1890
+ """
1255
1891
  ...
1256
1892
 
1257
- def bl_rna_get_subclass(self):
1258
- """ """
1893
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1894
+ """
1895
+
1896
+ :return: The RNA type or default when not found.
1897
+ :rtype: bpy.types.Struct
1898
+ """
1259
1899
  ...
1260
1900
 
1261
- def bl_rna_get_subclass_py(self):
1262
- """ """
1901
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1902
+ """
1903
+
1904
+ :return: The class or default when not found.
1905
+ :rtype: typing.Any
1906
+ """
1263
1907
  ...
1264
1908
 
1265
1909
  def draw(self, context):
@@ -1278,72 +1922,129 @@ class DATA_PT_gpencil_layers(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
1278
1922
  """
1279
1923
  ...
1280
1924
 
1281
- def driver_add(self):
1282
- """ """
1925
+ def driver_add(self) -> bpy.types.FCurve:
1926
+ """Adds driver(s) to the given property
1927
+
1928
+ :return: The driver(s) added.
1929
+ :rtype: bpy.types.FCurve
1930
+ """
1283
1931
  ...
1284
1932
 
1285
- def driver_remove(self):
1286
- """ """
1933
+ def driver_remove(self) -> bool:
1934
+ """Remove driver(s) from the given property
1935
+
1936
+ :return: Success of driver removal.
1937
+ :rtype: bool
1938
+ """
1287
1939
  ...
1288
1940
 
1289
1941
  def get(self):
1290
- """ """
1942
+ """Returns the value of the custom property assigned to key or default
1943
+ when not found (matches Python's dictionary function of the same name).
1944
+
1945
+ """
1291
1946
  ...
1292
1947
 
1293
1948
  def id_properties_clear(self):
1294
- """ """
1949
+ """
1950
+
1951
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1952
+ """
1295
1953
  ...
1296
1954
 
1297
1955
  def id_properties_ensure(self):
1298
- """ """
1956
+ """
1957
+
1958
+ :return: the parent group for an RNA struct's custom IDProperties.
1959
+ """
1299
1960
  ...
1300
1961
 
1301
1962
  def id_properties_ui(self):
1302
- """ """
1963
+ """
1964
+
1965
+ :return: Return an object used to manage an IDProperty's UI data.
1966
+ """
1303
1967
  ...
1304
1968
 
1305
1969
  def is_extended(self):
1306
1970
  """ """
1307
1971
  ...
1308
1972
 
1309
- def is_property_hidden(self):
1310
- """ """
1973
+ def is_property_hidden(self) -> bool:
1974
+ """Check if a property is hidden.
1975
+
1976
+ :return: True when the property is hidden.
1977
+ :rtype: bool
1978
+ """
1311
1979
  ...
1312
1980
 
1313
- def is_property_overridable_library(self):
1314
- """ """
1981
+ def is_property_overridable_library(self) -> bool:
1982
+ """Check if a property is overridable.
1983
+
1984
+ :return: True when the property is overridable.
1985
+ :rtype: bool
1986
+ """
1315
1987
  ...
1316
1988
 
1317
- def is_property_readonly(self):
1318
- """ """
1989
+ def is_property_readonly(self) -> bool:
1990
+ """Check if a property is readonly.
1991
+
1992
+ :return: True when the property is readonly (not writable).
1993
+ :rtype: bool
1994
+ """
1319
1995
  ...
1320
1996
 
1321
- def is_property_set(self):
1322
- """ """
1997
+ def is_property_set(self) -> bool:
1998
+ """Check if a property is set, use for testing operator properties.
1999
+
2000
+ :return: True when the property has been set.
2001
+ :rtype: bool
2002
+ """
1323
2003
  ...
1324
2004
 
1325
2005
  def items(self):
1326
- """ """
2006
+ """Returns the items of this objects custom properties (matches Python's
2007
+ dictionary function of the same name).
2008
+
2009
+ :return: custom property key, value pairs.
2010
+ """
1327
2011
  ...
1328
2012
 
1329
- def keyframe_delete(self):
1330
- """ """
2013
+ def keyframe_delete(self) -> bool:
2014
+ """Remove a keyframe from this properties fcurve.
2015
+
2016
+ :return: Success of keyframe deletion.
2017
+ :rtype: bool
2018
+ """
1331
2019
  ...
1332
2020
 
1333
- def keyframe_insert(self):
1334
- """ """
2021
+ def keyframe_insert(self) -> bool:
2022
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2023
+
2024
+ :return: Success of keyframe insertion.
2025
+ :rtype: bool
2026
+ """
1335
2027
  ...
1336
2028
 
1337
2029
  def keys(self):
1338
- """ """
2030
+ """Returns the keys of this objects custom properties (matches Python's
2031
+ dictionary function of the same name).
2032
+
2033
+ :return: custom property keys.
2034
+ """
1339
2035
  ...
1340
2036
 
1341
- def path_from_id(self):
1342
- """ """
2037
+ def path_from_id(self) -> str:
2038
+ """Returns the data path from the ID to this object (string).
2039
+
2040
+ :return: The path from `bpy.types.bpy_struct.id_data`
2041
+ to this struct and property (when given).
2042
+ :rtype: str
2043
+ """
1343
2044
  ...
1344
2045
 
1345
2046
  def path_resolve(self):
1346
- """ """
2047
+ """Returns the property from the path, raise an exception when not found."""
1347
2048
  ...
1348
2049
 
1349
2050
  def poll(self, context):
@@ -1354,37 +2055,53 @@ class DATA_PT_gpencil_layers(bpy_types.Panel, DataButtonsPanel, bpy_types._Gener
1354
2055
  ...
1355
2056
 
1356
2057
  def pop(self):
1357
- """ """
2058
+ """Remove and return the value of the custom property assigned to key or default
2059
+ when not found (matches Python's dictionary function of the same name).
2060
+
2061
+ """
1358
2062
  ...
1359
2063
 
1360
2064
  def prepend(self, draw_func):
1361
- """
2065
+ """Prepend a draw function to this menu, takes the same arguments as
2066
+ the menus draw function
1362
2067
 
1363
- :param draw_func:
2068
+ :param draw_func:
1364
2069
  """
1365
2070
  ...
1366
2071
 
1367
- def property_overridable_library_set(self):
1368
- """ """
2072
+ def property_overridable_library_set(self) -> bool:
2073
+ """Define a property as overridable or not (only for custom properties!).
2074
+
2075
+ :return: True when the overridable status of the property was successfully set.
2076
+ :rtype: bool
2077
+ """
1369
2078
  ...
1370
2079
 
1371
2080
  def property_unset(self):
1372
- """ """
2081
+ """Unset a property, will use default value afterward."""
1373
2082
  ...
1374
2083
 
1375
2084
  def remove(self, draw_func):
1376
- """
2085
+ """Remove a draw function that has been added to this menu
1377
2086
 
1378
2087
  :param draw_func:
1379
2088
  """
1380
2089
  ...
1381
2090
 
1382
2091
  def type_recast(self):
1383
- """ """
2092
+ """Return a new instance, this is needed because types
2093
+ such as textures can be changed at runtime.
2094
+
2095
+ :return: a new instance of this object with the type initialized again.
2096
+ """
1384
2097
  ...
1385
2098
 
1386
2099
  def values(self):
1387
- """ """
2100
+ """Returns the values of this objects custom properties (matches Python's
2101
+ dictionary function of the same name).
2102
+
2103
+ :return: custom property values.
2104
+ """
1388
2105
  ...
1389
2106
 
1390
2107
  class DATA_PT_gpencil_onion_skinning(
@@ -1411,22 +2128,35 @@ class DATA_PT_gpencil_onion_skinning(
1411
2128
  """ """
1412
2129
 
1413
2130
  def append(self, draw_func):
1414
- """
2131
+ """Append a draw function to this menu,
2132
+ takes the same arguments as the menus draw function
1415
2133
 
1416
- :param draw_func:
2134
+ :param draw_func:
1417
2135
  """
1418
2136
  ...
1419
2137
 
1420
- def as_pointer(self):
1421
- """ """
2138
+ def as_pointer(self) -> int:
2139
+ """Returns the memory address which holds a pointer to Blender's internal data
2140
+
2141
+ :return: int (memory address).
2142
+ :rtype: int
2143
+ """
1422
2144
  ...
1423
2145
 
1424
- def bl_rna_get_subclass(self):
1425
- """ """
2146
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2147
+ """
2148
+
2149
+ :return: The RNA type or default when not found.
2150
+ :rtype: bpy.types.Struct
2151
+ """
1426
2152
  ...
1427
2153
 
1428
- def bl_rna_get_subclass_py(self):
1429
- """ """
2154
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2155
+ """
2156
+
2157
+ :return: The class or default when not found.
2158
+ :rtype: typing.Any
2159
+ """
1430
2160
  ...
1431
2161
 
1432
2162
  def draw(self, context):
@@ -1436,72 +2166,129 @@ class DATA_PT_gpencil_onion_skinning(
1436
2166
  """
1437
2167
  ...
1438
2168
 
1439
- def driver_add(self):
1440
- """ """
2169
+ def driver_add(self) -> bpy.types.FCurve:
2170
+ """Adds driver(s) to the given property
2171
+
2172
+ :return: The driver(s) added.
2173
+ :rtype: bpy.types.FCurve
2174
+ """
1441
2175
  ...
1442
2176
 
1443
- def driver_remove(self):
1444
- """ """
2177
+ def driver_remove(self) -> bool:
2178
+ """Remove driver(s) from the given property
2179
+
2180
+ :return: Success of driver removal.
2181
+ :rtype: bool
2182
+ """
1445
2183
  ...
1446
2184
 
1447
2185
  def get(self):
1448
- """ """
2186
+ """Returns the value of the custom property assigned to key or default
2187
+ when not found (matches Python's dictionary function of the same name).
2188
+
2189
+ """
1449
2190
  ...
1450
2191
 
1451
2192
  def id_properties_clear(self):
1452
- """ """
2193
+ """
2194
+
2195
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2196
+ """
1453
2197
  ...
1454
2198
 
1455
2199
  def id_properties_ensure(self):
1456
- """ """
2200
+ """
2201
+
2202
+ :return: the parent group for an RNA struct's custom IDProperties.
2203
+ """
1457
2204
  ...
1458
2205
 
1459
2206
  def id_properties_ui(self):
1460
- """ """
2207
+ """
2208
+
2209
+ :return: Return an object used to manage an IDProperty's UI data.
2210
+ """
1461
2211
  ...
1462
2212
 
1463
2213
  def is_extended(self):
1464
2214
  """ """
1465
2215
  ...
1466
2216
 
1467
- def is_property_hidden(self):
1468
- """ """
2217
+ def is_property_hidden(self) -> bool:
2218
+ """Check if a property is hidden.
2219
+
2220
+ :return: True when the property is hidden.
2221
+ :rtype: bool
2222
+ """
1469
2223
  ...
1470
2224
 
1471
- def is_property_overridable_library(self):
1472
- """ """
2225
+ def is_property_overridable_library(self) -> bool:
2226
+ """Check if a property is overridable.
2227
+
2228
+ :return: True when the property is overridable.
2229
+ :rtype: bool
2230
+ """
1473
2231
  ...
1474
2232
 
1475
- def is_property_readonly(self):
1476
- """ """
2233
+ def is_property_readonly(self) -> bool:
2234
+ """Check if a property is readonly.
2235
+
2236
+ :return: True when the property is readonly (not writable).
2237
+ :rtype: bool
2238
+ """
1477
2239
  ...
1478
2240
 
1479
- def is_property_set(self):
1480
- """ """
2241
+ def is_property_set(self) -> bool:
2242
+ """Check if a property is set, use for testing operator properties.
2243
+
2244
+ :return: True when the property has been set.
2245
+ :rtype: bool
2246
+ """
1481
2247
  ...
1482
2248
 
1483
2249
  def items(self):
1484
- """ """
2250
+ """Returns the items of this objects custom properties (matches Python's
2251
+ dictionary function of the same name).
2252
+
2253
+ :return: custom property key, value pairs.
2254
+ """
1485
2255
  ...
1486
2256
 
1487
- def keyframe_delete(self):
1488
- """ """
2257
+ def keyframe_delete(self) -> bool:
2258
+ """Remove a keyframe from this properties fcurve.
2259
+
2260
+ :return: Success of keyframe deletion.
2261
+ :rtype: bool
2262
+ """
1489
2263
  ...
1490
2264
 
1491
- def keyframe_insert(self):
1492
- """ """
2265
+ def keyframe_insert(self) -> bool:
2266
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2267
+
2268
+ :return: Success of keyframe insertion.
2269
+ :rtype: bool
2270
+ """
1493
2271
  ...
1494
2272
 
1495
2273
  def keys(self):
1496
- """ """
2274
+ """Returns the keys of this objects custom properties (matches Python's
2275
+ dictionary function of the same name).
2276
+
2277
+ :return: custom property keys.
2278
+ """
1497
2279
  ...
1498
2280
 
1499
- def path_from_id(self):
1500
- """ """
2281
+ def path_from_id(self) -> str:
2282
+ """Returns the data path from the ID to this object (string).
2283
+
2284
+ :return: The path from `bpy.types.bpy_struct.id_data`
2285
+ to this struct and property (when given).
2286
+ :rtype: str
2287
+ """
1501
2288
  ...
1502
2289
 
1503
2290
  def path_resolve(self):
1504
- """ """
2291
+ """Returns the property from the path, raise an exception when not found."""
1505
2292
  ...
1506
2293
 
1507
2294
  def poll(self, context):
@@ -1512,37 +2299,53 @@ class DATA_PT_gpencil_onion_skinning(
1512
2299
  ...
1513
2300
 
1514
2301
  def pop(self):
1515
- """ """
2302
+ """Remove and return the value of the custom property assigned to key or default
2303
+ when not found (matches Python's dictionary function of the same name).
2304
+
2305
+ """
1516
2306
  ...
1517
2307
 
1518
2308
  def prepend(self, draw_func):
1519
- """
2309
+ """Prepend a draw function to this menu, takes the same arguments as
2310
+ the menus draw function
1520
2311
 
1521
- :param draw_func:
2312
+ :param draw_func:
1522
2313
  """
1523
2314
  ...
1524
2315
 
1525
- def property_overridable_library_set(self):
1526
- """ """
2316
+ def property_overridable_library_set(self) -> bool:
2317
+ """Define a property as overridable or not (only for custom properties!).
2318
+
2319
+ :return: True when the overridable status of the property was successfully set.
2320
+ :rtype: bool
2321
+ """
1527
2322
  ...
1528
2323
 
1529
2324
  def property_unset(self):
1530
- """ """
2325
+ """Unset a property, will use default value afterward."""
1531
2326
  ...
1532
2327
 
1533
2328
  def remove(self, draw_func):
1534
- """
2329
+ """Remove a draw function that has been added to this menu
1535
2330
 
1536
2331
  :param draw_func:
1537
2332
  """
1538
2333
  ...
1539
2334
 
1540
2335
  def type_recast(self):
1541
- """ """
2336
+ """Return a new instance, this is needed because types
2337
+ such as textures can be changed at runtime.
2338
+
2339
+ :return: a new instance of this object with the type initialized again.
2340
+ """
1542
2341
  ...
1543
2342
 
1544
2343
  def values(self):
1545
- """ """
2344
+ """Returns the values of this objects custom properties (matches Python's
2345
+ dictionary function of the same name).
2346
+
2347
+ :return: custom property values.
2348
+ """
1546
2349
  ...
1547
2350
 
1548
2351
  class DATA_PT_gpencil_onion_skinning_custom_colors(
@@ -1575,22 +2378,35 @@ class DATA_PT_gpencil_onion_skinning_custom_colors(
1575
2378
  """ """
1576
2379
 
1577
2380
  def append(self, draw_func):
1578
- """
2381
+ """Append a draw function to this menu,
2382
+ takes the same arguments as the menus draw function
1579
2383
 
1580
- :param draw_func:
2384
+ :param draw_func:
1581
2385
  """
1582
2386
  ...
1583
2387
 
1584
- def as_pointer(self):
1585
- """ """
2388
+ def as_pointer(self) -> int:
2389
+ """Returns the memory address which holds a pointer to Blender's internal data
2390
+
2391
+ :return: int (memory address).
2392
+ :rtype: int
2393
+ """
1586
2394
  ...
1587
2395
 
1588
- def bl_rna_get_subclass(self):
1589
- """ """
2396
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2397
+ """
2398
+
2399
+ :return: The RNA type or default when not found.
2400
+ :rtype: bpy.types.Struct
2401
+ """
1590
2402
  ...
1591
2403
 
1592
- def bl_rna_get_subclass_py(self):
1593
- """ """
2404
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2405
+ """
2406
+
2407
+ :return: The class or default when not found.
2408
+ :rtype: typing.Any
2409
+ """
1594
2410
  ...
1595
2411
 
1596
2412
  def draw(self, context):
@@ -1607,72 +2423,129 @@ class DATA_PT_gpencil_onion_skinning_custom_colors(
1607
2423
  """
1608
2424
  ...
1609
2425
 
1610
- def driver_add(self):
1611
- """ """
2426
+ def driver_add(self) -> bpy.types.FCurve:
2427
+ """Adds driver(s) to the given property
2428
+
2429
+ :return: The driver(s) added.
2430
+ :rtype: bpy.types.FCurve
2431
+ """
1612
2432
  ...
1613
2433
 
1614
- def driver_remove(self):
1615
- """ """
2434
+ def driver_remove(self) -> bool:
2435
+ """Remove driver(s) from the given property
2436
+
2437
+ :return: Success of driver removal.
2438
+ :rtype: bool
2439
+ """
1616
2440
  ...
1617
2441
 
1618
2442
  def get(self):
1619
- """ """
2443
+ """Returns the value of the custom property assigned to key or default
2444
+ when not found (matches Python's dictionary function of the same name).
2445
+
2446
+ """
1620
2447
  ...
1621
2448
 
1622
2449
  def id_properties_clear(self):
1623
- """ """
2450
+ """
2451
+
2452
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2453
+ """
1624
2454
  ...
1625
2455
 
1626
2456
  def id_properties_ensure(self):
1627
- """ """
2457
+ """
2458
+
2459
+ :return: the parent group for an RNA struct's custom IDProperties.
2460
+ """
1628
2461
  ...
1629
2462
 
1630
2463
  def id_properties_ui(self):
1631
- """ """
2464
+ """
2465
+
2466
+ :return: Return an object used to manage an IDProperty's UI data.
2467
+ """
1632
2468
  ...
1633
2469
 
1634
2470
  def is_extended(self):
1635
2471
  """ """
1636
2472
  ...
1637
2473
 
1638
- def is_property_hidden(self):
1639
- """ """
2474
+ def is_property_hidden(self) -> bool:
2475
+ """Check if a property is hidden.
2476
+
2477
+ :return: True when the property is hidden.
2478
+ :rtype: bool
2479
+ """
1640
2480
  ...
1641
2481
 
1642
- def is_property_overridable_library(self):
1643
- """ """
2482
+ def is_property_overridable_library(self) -> bool:
2483
+ """Check if a property is overridable.
2484
+
2485
+ :return: True when the property is overridable.
2486
+ :rtype: bool
2487
+ """
1644
2488
  ...
1645
2489
 
1646
- def is_property_readonly(self):
1647
- """ """
2490
+ def is_property_readonly(self) -> bool:
2491
+ """Check if a property is readonly.
2492
+
2493
+ :return: True when the property is readonly (not writable).
2494
+ :rtype: bool
2495
+ """
1648
2496
  ...
1649
2497
 
1650
- def is_property_set(self):
1651
- """ """
2498
+ def is_property_set(self) -> bool:
2499
+ """Check if a property is set, use for testing operator properties.
2500
+
2501
+ :return: True when the property has been set.
2502
+ :rtype: bool
2503
+ """
1652
2504
  ...
1653
2505
 
1654
2506
  def items(self):
1655
- """ """
2507
+ """Returns the items of this objects custom properties (matches Python's
2508
+ dictionary function of the same name).
2509
+
2510
+ :return: custom property key, value pairs.
2511
+ """
1656
2512
  ...
1657
2513
 
1658
- def keyframe_delete(self):
1659
- """ """
2514
+ def keyframe_delete(self) -> bool:
2515
+ """Remove a keyframe from this properties fcurve.
2516
+
2517
+ :return: Success of keyframe deletion.
2518
+ :rtype: bool
2519
+ """
1660
2520
  ...
1661
2521
 
1662
- def keyframe_insert(self):
1663
- """ """
2522
+ def keyframe_insert(self) -> bool:
2523
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2524
+
2525
+ :return: Success of keyframe insertion.
2526
+ :rtype: bool
2527
+ """
1664
2528
  ...
1665
2529
 
1666
2530
  def keys(self):
1667
- """ """
2531
+ """Returns the keys of this objects custom properties (matches Python's
2532
+ dictionary function of the same name).
2533
+
2534
+ :return: custom property keys.
2535
+ """
1668
2536
  ...
1669
2537
 
1670
- def path_from_id(self):
1671
- """ """
2538
+ def path_from_id(self) -> str:
2539
+ """Returns the data path from the ID to this object (string).
2540
+
2541
+ :return: The path from `bpy.types.bpy_struct.id_data`
2542
+ to this struct and property (when given).
2543
+ :rtype: str
2544
+ """
1672
2545
  ...
1673
2546
 
1674
2547
  def path_resolve(self):
1675
- """ """
2548
+ """Returns the property from the path, raise an exception when not found."""
1676
2549
  ...
1677
2550
 
1678
2551
  def poll(self, context):
@@ -1683,37 +2556,53 @@ class DATA_PT_gpencil_onion_skinning_custom_colors(
1683
2556
  ...
1684
2557
 
1685
2558
  def pop(self):
1686
- """ """
2559
+ """Remove and return the value of the custom property assigned to key or default
2560
+ when not found (matches Python's dictionary function of the same name).
2561
+
2562
+ """
1687
2563
  ...
1688
2564
 
1689
2565
  def prepend(self, draw_func):
1690
- """
2566
+ """Prepend a draw function to this menu, takes the same arguments as
2567
+ the menus draw function
1691
2568
 
1692
- :param draw_func:
2569
+ :param draw_func:
1693
2570
  """
1694
2571
  ...
1695
2572
 
1696
- def property_overridable_library_set(self):
1697
- """ """
2573
+ def property_overridable_library_set(self) -> bool:
2574
+ """Define a property as overridable or not (only for custom properties!).
2575
+
2576
+ :return: True when the overridable status of the property was successfully set.
2577
+ :rtype: bool
2578
+ """
1698
2579
  ...
1699
2580
 
1700
2581
  def property_unset(self):
1701
- """ """
2582
+ """Unset a property, will use default value afterward."""
1702
2583
  ...
1703
2584
 
1704
2585
  def remove(self, draw_func):
1705
- """
2586
+ """Remove a draw function that has been added to this menu
1706
2587
 
1707
2588
  :param draw_func:
1708
2589
  """
1709
2590
  ...
1710
2591
 
1711
2592
  def type_recast(self):
1712
- """ """
2593
+ """Return a new instance, this is needed because types
2594
+ such as textures can be changed at runtime.
2595
+
2596
+ :return: a new instance of this object with the type initialized again.
2597
+ """
1713
2598
  ...
1714
2599
 
1715
2600
  def values(self):
1716
- """ """
2601
+ """Returns the values of this objects custom properties (matches Python's
2602
+ dictionary function of the same name).
2603
+
2604
+ :return: custom property values.
2605
+ """
1717
2606
  ...
1718
2607
 
1719
2608
  class DATA_PT_gpencil_onion_skinning_display(
@@ -1746,22 +2635,35 @@ class DATA_PT_gpencil_onion_skinning_display(
1746
2635
  """ """
1747
2636
 
1748
2637
  def append(self, draw_func):
1749
- """
2638
+ """Append a draw function to this menu,
2639
+ takes the same arguments as the menus draw function
1750
2640
 
1751
- :param draw_func:
2641
+ :param draw_func:
1752
2642
  """
1753
2643
  ...
1754
2644
 
1755
- def as_pointer(self):
1756
- """ """
2645
+ def as_pointer(self) -> int:
2646
+ """Returns the memory address which holds a pointer to Blender's internal data
2647
+
2648
+ :return: int (memory address).
2649
+ :rtype: int
2650
+ """
1757
2651
  ...
1758
2652
 
1759
- def bl_rna_get_subclass(self):
1760
- """ """
2653
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2654
+ """
2655
+
2656
+ :return: The RNA type or default when not found.
2657
+ :rtype: bpy.types.Struct
2658
+ """
1761
2659
  ...
1762
2660
 
1763
- def bl_rna_get_subclass_py(self):
1764
- """ """
2661
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2662
+ """
2663
+
2664
+ :return: The class or default when not found.
2665
+ :rtype: typing.Any
2666
+ """
1765
2667
  ...
1766
2668
 
1767
2669
  def draw(self, context):
@@ -1771,72 +2673,129 @@ class DATA_PT_gpencil_onion_skinning_display(
1771
2673
  """
1772
2674
  ...
1773
2675
 
1774
- def driver_add(self):
1775
- """ """
2676
+ def driver_add(self) -> bpy.types.FCurve:
2677
+ """Adds driver(s) to the given property
2678
+
2679
+ :return: The driver(s) added.
2680
+ :rtype: bpy.types.FCurve
2681
+ """
1776
2682
  ...
1777
2683
 
1778
- def driver_remove(self):
1779
- """ """
2684
+ def driver_remove(self) -> bool:
2685
+ """Remove driver(s) from the given property
2686
+
2687
+ :return: Success of driver removal.
2688
+ :rtype: bool
2689
+ """
1780
2690
  ...
1781
2691
 
1782
2692
  def get(self):
1783
- """ """
2693
+ """Returns the value of the custom property assigned to key or default
2694
+ when not found (matches Python's dictionary function of the same name).
2695
+
2696
+ """
1784
2697
  ...
1785
2698
 
1786
2699
  def id_properties_clear(self):
1787
- """ """
2700
+ """
2701
+
2702
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2703
+ """
1788
2704
  ...
1789
2705
 
1790
2706
  def id_properties_ensure(self):
1791
- """ """
2707
+ """
2708
+
2709
+ :return: the parent group for an RNA struct's custom IDProperties.
2710
+ """
1792
2711
  ...
1793
2712
 
1794
2713
  def id_properties_ui(self):
1795
- """ """
2714
+ """
2715
+
2716
+ :return: Return an object used to manage an IDProperty's UI data.
2717
+ """
1796
2718
  ...
1797
2719
 
1798
2720
  def is_extended(self):
1799
2721
  """ """
1800
2722
  ...
1801
2723
 
1802
- def is_property_hidden(self):
1803
- """ """
2724
+ def is_property_hidden(self) -> bool:
2725
+ """Check if a property is hidden.
2726
+
2727
+ :return: True when the property is hidden.
2728
+ :rtype: bool
2729
+ """
1804
2730
  ...
1805
2731
 
1806
- def is_property_overridable_library(self):
1807
- """ """
2732
+ def is_property_overridable_library(self) -> bool:
2733
+ """Check if a property is overridable.
2734
+
2735
+ :return: True when the property is overridable.
2736
+ :rtype: bool
2737
+ """
1808
2738
  ...
1809
2739
 
1810
- def is_property_readonly(self):
1811
- """ """
2740
+ def is_property_readonly(self) -> bool:
2741
+ """Check if a property is readonly.
2742
+
2743
+ :return: True when the property is readonly (not writable).
2744
+ :rtype: bool
2745
+ """
1812
2746
  ...
1813
2747
 
1814
- def is_property_set(self):
1815
- """ """
2748
+ def is_property_set(self) -> bool:
2749
+ """Check if a property is set, use for testing operator properties.
2750
+
2751
+ :return: True when the property has been set.
2752
+ :rtype: bool
2753
+ """
1816
2754
  ...
1817
2755
 
1818
2756
  def items(self):
1819
- """ """
2757
+ """Returns the items of this objects custom properties (matches Python's
2758
+ dictionary function of the same name).
2759
+
2760
+ :return: custom property key, value pairs.
2761
+ """
1820
2762
  ...
1821
2763
 
1822
- def keyframe_delete(self):
1823
- """ """
2764
+ def keyframe_delete(self) -> bool:
2765
+ """Remove a keyframe from this properties fcurve.
2766
+
2767
+ :return: Success of keyframe deletion.
2768
+ :rtype: bool
2769
+ """
1824
2770
  ...
1825
2771
 
1826
- def keyframe_insert(self):
1827
- """ """
2772
+ def keyframe_insert(self) -> bool:
2773
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2774
+
2775
+ :return: Success of keyframe insertion.
2776
+ :rtype: bool
2777
+ """
1828
2778
  ...
1829
2779
 
1830
2780
  def keys(self):
1831
- """ """
2781
+ """Returns the keys of this objects custom properties (matches Python's
2782
+ dictionary function of the same name).
2783
+
2784
+ :return: custom property keys.
2785
+ """
1832
2786
  ...
1833
2787
 
1834
- def path_from_id(self):
1835
- """ """
2788
+ def path_from_id(self) -> str:
2789
+ """Returns the data path from the ID to this object (string).
2790
+
2791
+ :return: The path from `bpy.types.bpy_struct.id_data`
2792
+ to this struct and property (when given).
2793
+ :rtype: str
2794
+ """
1836
2795
  ...
1837
2796
 
1838
2797
  def path_resolve(self):
1839
- """ """
2798
+ """Returns the property from the path, raise an exception when not found."""
1840
2799
  ...
1841
2800
 
1842
2801
  def poll(self, context):
@@ -1847,37 +2806,53 @@ class DATA_PT_gpencil_onion_skinning_display(
1847
2806
  ...
1848
2807
 
1849
2808
  def pop(self):
1850
- """ """
2809
+ """Remove and return the value of the custom property assigned to key or default
2810
+ when not found (matches Python's dictionary function of the same name).
2811
+
2812
+ """
1851
2813
  ...
1852
2814
 
1853
2815
  def prepend(self, draw_func):
1854
- """
2816
+ """Prepend a draw function to this menu, takes the same arguments as
2817
+ the menus draw function
1855
2818
 
1856
- :param draw_func:
2819
+ :param draw_func:
1857
2820
  """
1858
2821
  ...
1859
2822
 
1860
- def property_overridable_library_set(self):
1861
- """ """
2823
+ def property_overridable_library_set(self) -> bool:
2824
+ """Define a property as overridable or not (only for custom properties!).
2825
+
2826
+ :return: True when the overridable status of the property was successfully set.
2827
+ :rtype: bool
2828
+ """
1862
2829
  ...
1863
2830
 
1864
2831
  def property_unset(self):
1865
- """ """
2832
+ """Unset a property, will use default value afterward."""
1866
2833
  ...
1867
2834
 
1868
2835
  def remove(self, draw_func):
1869
- """
2836
+ """Remove a draw function that has been added to this menu
1870
2837
 
1871
2838
  :param draw_func:
1872
2839
  """
1873
2840
  ...
1874
2841
 
1875
2842
  def type_recast(self):
1876
- """ """
2843
+ """Return a new instance, this is needed because types
2844
+ such as textures can be changed at runtime.
2845
+
2846
+ :return: a new instance of this object with the type initialized again.
2847
+ """
1877
2848
  ...
1878
2849
 
1879
2850
  def values(self):
1880
- """ """
2851
+ """Returns the values of this objects custom properties (matches Python's
2852
+ dictionary function of the same name).
2853
+
2854
+ :return: custom property values.
2855
+ """
1881
2856
  ...
1882
2857
 
1883
2858
  class DATA_PT_gpencil_strokes(bpy_types.Panel, DataButtonsPanel, bpy_types._GenericUI):
@@ -1905,22 +2880,35 @@ class DATA_PT_gpencil_strokes(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
1905
2880
  """ """
1906
2881
 
1907
2882
  def append(self, draw_func):
1908
- """
2883
+ """Append a draw function to this menu,
2884
+ takes the same arguments as the menus draw function
1909
2885
 
1910
- :param draw_func:
2886
+ :param draw_func:
1911
2887
  """
1912
2888
  ...
1913
2889
 
1914
- def as_pointer(self):
1915
- """ """
2890
+ def as_pointer(self) -> int:
2891
+ """Returns the memory address which holds a pointer to Blender's internal data
2892
+
2893
+ :return: int (memory address).
2894
+ :rtype: int
2895
+ """
1916
2896
  ...
1917
2897
 
1918
- def bl_rna_get_subclass(self):
1919
- """ """
2898
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2899
+ """
2900
+
2901
+ :return: The RNA type or default when not found.
2902
+ :rtype: bpy.types.Struct
2903
+ """
1920
2904
  ...
1921
2905
 
1922
- def bl_rna_get_subclass_py(self):
1923
- """ """
2906
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2907
+ """
2908
+
2909
+ :return: The class or default when not found.
2910
+ :rtype: typing.Any
2911
+ """
1924
2912
  ...
1925
2913
 
1926
2914
  def draw(self, context):
@@ -1930,72 +2918,129 @@ class DATA_PT_gpencil_strokes(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
1930
2918
  """
1931
2919
  ...
1932
2920
 
1933
- def driver_add(self):
1934
- """ """
2921
+ def driver_add(self) -> bpy.types.FCurve:
2922
+ """Adds driver(s) to the given property
2923
+
2924
+ :return: The driver(s) added.
2925
+ :rtype: bpy.types.FCurve
2926
+ """
1935
2927
  ...
1936
2928
 
1937
- def driver_remove(self):
1938
- """ """
2929
+ def driver_remove(self) -> bool:
2930
+ """Remove driver(s) from the given property
2931
+
2932
+ :return: Success of driver removal.
2933
+ :rtype: bool
2934
+ """
1939
2935
  ...
1940
2936
 
1941
2937
  def get(self):
1942
- """ """
2938
+ """Returns the value of the custom property assigned to key or default
2939
+ when not found (matches Python's dictionary function of the same name).
2940
+
2941
+ """
1943
2942
  ...
1944
2943
 
1945
2944
  def id_properties_clear(self):
1946
- """ """
2945
+ """
2946
+
2947
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2948
+ """
1947
2949
  ...
1948
2950
 
1949
2951
  def id_properties_ensure(self):
1950
- """ """
2952
+ """
2953
+
2954
+ :return: the parent group for an RNA struct's custom IDProperties.
2955
+ """
1951
2956
  ...
1952
2957
 
1953
2958
  def id_properties_ui(self):
1954
- """ """
2959
+ """
2960
+
2961
+ :return: Return an object used to manage an IDProperty's UI data.
2962
+ """
1955
2963
  ...
1956
2964
 
1957
2965
  def is_extended(self):
1958
2966
  """ """
1959
2967
  ...
1960
2968
 
1961
- def is_property_hidden(self):
1962
- """ """
1963
- ...
2969
+ def is_property_hidden(self) -> bool:
2970
+ """Check if a property is hidden.
2971
+
2972
+ :return: True when the property is hidden.
2973
+ :rtype: bool
2974
+ """
2975
+ ...
2976
+
2977
+ def is_property_overridable_library(self) -> bool:
2978
+ """Check if a property is overridable.
2979
+
2980
+ :return: True when the property is overridable.
2981
+ :rtype: bool
2982
+ """
2983
+ ...
2984
+
2985
+ def is_property_readonly(self) -> bool:
2986
+ """Check if a property is readonly.
1964
2987
 
1965
- def is_property_overridable_library(self):
1966
- """ """
2988
+ :return: True when the property is readonly (not writable).
2989
+ :rtype: bool
2990
+ """
1967
2991
  ...
1968
2992
 
1969
- def is_property_readonly(self):
1970
- """ """
1971
- ...
2993
+ def is_property_set(self) -> bool:
2994
+ """Check if a property is set, use for testing operator properties.
1972
2995
 
1973
- def is_property_set(self):
1974
- """ """
2996
+ :return: True when the property has been set.
2997
+ :rtype: bool
2998
+ """
1975
2999
  ...
1976
3000
 
1977
3001
  def items(self):
1978
- """ """
3002
+ """Returns the items of this objects custom properties (matches Python's
3003
+ dictionary function of the same name).
3004
+
3005
+ :return: custom property key, value pairs.
3006
+ """
1979
3007
  ...
1980
3008
 
1981
- def keyframe_delete(self):
1982
- """ """
3009
+ def keyframe_delete(self) -> bool:
3010
+ """Remove a keyframe from this properties fcurve.
3011
+
3012
+ :return: Success of keyframe deletion.
3013
+ :rtype: bool
3014
+ """
1983
3015
  ...
1984
3016
 
1985
- def keyframe_insert(self):
1986
- """ """
3017
+ def keyframe_insert(self) -> bool:
3018
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3019
+
3020
+ :return: Success of keyframe insertion.
3021
+ :rtype: bool
3022
+ """
1987
3023
  ...
1988
3024
 
1989
3025
  def keys(self):
1990
- """ """
3026
+ """Returns the keys of this objects custom properties (matches Python's
3027
+ dictionary function of the same name).
3028
+
3029
+ :return: custom property keys.
3030
+ """
1991
3031
  ...
1992
3032
 
1993
- def path_from_id(self):
1994
- """ """
3033
+ def path_from_id(self) -> str:
3034
+ """Returns the data path from the ID to this object (string).
3035
+
3036
+ :return: The path from `bpy.types.bpy_struct.id_data`
3037
+ to this struct and property (when given).
3038
+ :rtype: str
3039
+ """
1995
3040
  ...
1996
3041
 
1997
3042
  def path_resolve(self):
1998
- """ """
3043
+ """Returns the property from the path, raise an exception when not found."""
1999
3044
  ...
2000
3045
 
2001
3046
  def poll(self, context):
@@ -2006,37 +3051,53 @@ class DATA_PT_gpencil_strokes(bpy_types.Panel, DataButtonsPanel, bpy_types._Gene
2006
3051
  ...
2007
3052
 
2008
3053
  def pop(self):
2009
- """ """
3054
+ """Remove and return the value of the custom property assigned to key or default
3055
+ when not found (matches Python's dictionary function of the same name).
3056
+
3057
+ """
2010
3058
  ...
2011
3059
 
2012
3060
  def prepend(self, draw_func):
2013
- """
3061
+ """Prepend a draw function to this menu, takes the same arguments as
3062
+ the menus draw function
2014
3063
 
2015
- :param draw_func:
3064
+ :param draw_func:
2016
3065
  """
2017
3066
  ...
2018
3067
 
2019
- def property_overridable_library_set(self):
2020
- """ """
3068
+ def property_overridable_library_set(self) -> bool:
3069
+ """Define a property as overridable or not (only for custom properties!).
3070
+
3071
+ :return: True when the overridable status of the property was successfully set.
3072
+ :rtype: bool
3073
+ """
2021
3074
  ...
2022
3075
 
2023
3076
  def property_unset(self):
2024
- """ """
3077
+ """Unset a property, will use default value afterward."""
2025
3078
  ...
2026
3079
 
2027
3080
  def remove(self, draw_func):
2028
- """
3081
+ """Remove a draw function that has been added to this menu
2029
3082
 
2030
3083
  :param draw_func:
2031
3084
  """
2032
3085
  ...
2033
3086
 
2034
3087
  def type_recast(self):
2035
- """ """
3088
+ """Return a new instance, this is needed because types
3089
+ such as textures can be changed at runtime.
3090
+
3091
+ :return: a new instance of this object with the type initialized again.
3092
+ """
2036
3093
  ...
2037
3094
 
2038
3095
  def values(self):
2039
- """ """
3096
+ """Returns the values of this objects custom properties (matches Python's
3097
+ dictionary function of the same name).
3098
+
3099
+ :return: custom property values.
3100
+ """
2040
3101
  ...
2041
3102
 
2042
3103
  class DATA_PT_gpencil_layer_adjustments(
@@ -2072,22 +3133,35 @@ class DATA_PT_gpencil_layer_adjustments(
2072
3133
  """ """
2073
3134
 
2074
3135
  def append(self, draw_func):
2075
- """
3136
+ """Append a draw function to this menu,
3137
+ takes the same arguments as the menus draw function
2076
3138
 
2077
- :param draw_func:
3139
+ :param draw_func:
2078
3140
  """
2079
3141
  ...
2080
3142
 
2081
- def as_pointer(self):
2082
- """ """
3143
+ def as_pointer(self) -> int:
3144
+ """Returns the memory address which holds a pointer to Blender's internal data
3145
+
3146
+ :return: int (memory address).
3147
+ :rtype: int
3148
+ """
2083
3149
  ...
2084
3150
 
2085
- def bl_rna_get_subclass(self):
2086
- """ """
3151
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3152
+ """
3153
+
3154
+ :return: The RNA type or default when not found.
3155
+ :rtype: bpy.types.Struct
3156
+ """
2087
3157
  ...
2088
3158
 
2089
- def bl_rna_get_subclass_py(self):
2090
- """ """
3159
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3160
+ """
3161
+
3162
+ :return: The class or default when not found.
3163
+ :rtype: typing.Any
3164
+ """
2091
3165
  ...
2092
3166
 
2093
3167
  def draw(self, context):
@@ -2097,72 +3171,129 @@ class DATA_PT_gpencil_layer_adjustments(
2097
3171
  """
2098
3172
  ...
2099
3173
 
2100
- def driver_add(self):
2101
- """ """
3174
+ def driver_add(self) -> bpy.types.FCurve:
3175
+ """Adds driver(s) to the given property
3176
+
3177
+ :return: The driver(s) added.
3178
+ :rtype: bpy.types.FCurve
3179
+ """
2102
3180
  ...
2103
3181
 
2104
- def driver_remove(self):
2105
- """ """
3182
+ def driver_remove(self) -> bool:
3183
+ """Remove driver(s) from the given property
3184
+
3185
+ :return: Success of driver removal.
3186
+ :rtype: bool
3187
+ """
2106
3188
  ...
2107
3189
 
2108
3190
  def get(self):
2109
- """ """
3191
+ """Returns the value of the custom property assigned to key or default
3192
+ when not found (matches Python's dictionary function of the same name).
3193
+
3194
+ """
2110
3195
  ...
2111
3196
 
2112
3197
  def id_properties_clear(self):
2113
- """ """
3198
+ """
3199
+
3200
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3201
+ """
2114
3202
  ...
2115
3203
 
2116
3204
  def id_properties_ensure(self):
2117
- """ """
3205
+ """
3206
+
3207
+ :return: the parent group for an RNA struct's custom IDProperties.
3208
+ """
2118
3209
  ...
2119
3210
 
2120
3211
  def id_properties_ui(self):
2121
- """ """
3212
+ """
3213
+
3214
+ :return: Return an object used to manage an IDProperty's UI data.
3215
+ """
2122
3216
  ...
2123
3217
 
2124
3218
  def is_extended(self):
2125
3219
  """ """
2126
3220
  ...
2127
3221
 
2128
- def is_property_hidden(self):
2129
- """ """
3222
+ def is_property_hidden(self) -> bool:
3223
+ """Check if a property is hidden.
3224
+
3225
+ :return: True when the property is hidden.
3226
+ :rtype: bool
3227
+ """
2130
3228
  ...
2131
3229
 
2132
- def is_property_overridable_library(self):
2133
- """ """
3230
+ def is_property_overridable_library(self) -> bool:
3231
+ """Check if a property is overridable.
3232
+
3233
+ :return: True when the property is overridable.
3234
+ :rtype: bool
3235
+ """
2134
3236
  ...
2135
3237
 
2136
- def is_property_readonly(self):
2137
- """ """
3238
+ def is_property_readonly(self) -> bool:
3239
+ """Check if a property is readonly.
3240
+
3241
+ :return: True when the property is readonly (not writable).
3242
+ :rtype: bool
3243
+ """
2138
3244
  ...
2139
3245
 
2140
- def is_property_set(self):
2141
- """ """
3246
+ def is_property_set(self) -> bool:
3247
+ """Check if a property is set, use for testing operator properties.
3248
+
3249
+ :return: True when the property has been set.
3250
+ :rtype: bool
3251
+ """
2142
3252
  ...
2143
3253
 
2144
3254
  def items(self):
2145
- """ """
3255
+ """Returns the items of this objects custom properties (matches Python's
3256
+ dictionary function of the same name).
3257
+
3258
+ :return: custom property key, value pairs.
3259
+ """
2146
3260
  ...
2147
3261
 
2148
- def keyframe_delete(self):
2149
- """ """
3262
+ def keyframe_delete(self) -> bool:
3263
+ """Remove a keyframe from this properties fcurve.
3264
+
3265
+ :return: Success of keyframe deletion.
3266
+ :rtype: bool
3267
+ """
2150
3268
  ...
2151
3269
 
2152
- def keyframe_insert(self):
2153
- """ """
3270
+ def keyframe_insert(self) -> bool:
3271
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3272
+
3273
+ :return: Success of keyframe insertion.
3274
+ :rtype: bool
3275
+ """
2154
3276
  ...
2155
3277
 
2156
3278
  def keys(self):
2157
- """ """
3279
+ """Returns the keys of this objects custom properties (matches Python's
3280
+ dictionary function of the same name).
3281
+
3282
+ :return: custom property keys.
3283
+ """
2158
3284
  ...
2159
3285
 
2160
- def path_from_id(self):
2161
- """ """
3286
+ def path_from_id(self) -> str:
3287
+ """Returns the data path from the ID to this object (string).
3288
+
3289
+ :return: The path from `bpy.types.bpy_struct.id_data`
3290
+ to this struct and property (when given).
3291
+ :rtype: str
3292
+ """
2162
3293
  ...
2163
3294
 
2164
3295
  def path_resolve(self):
2165
- """ """
3296
+ """Returns the property from the path, raise an exception when not found."""
2166
3297
  ...
2167
3298
 
2168
3299
  def poll(self, context):
@@ -2173,37 +3304,53 @@ class DATA_PT_gpencil_layer_adjustments(
2173
3304
  ...
2174
3305
 
2175
3306
  def pop(self):
2176
- """ """
3307
+ """Remove and return the value of the custom property assigned to key or default
3308
+ when not found (matches Python's dictionary function of the same name).
3309
+
3310
+ """
2177
3311
  ...
2178
3312
 
2179
3313
  def prepend(self, draw_func):
2180
- """
3314
+ """Prepend a draw function to this menu, takes the same arguments as
3315
+ the menus draw function
2181
3316
 
2182
- :param draw_func:
3317
+ :param draw_func:
2183
3318
  """
2184
3319
  ...
2185
3320
 
2186
- def property_overridable_library_set(self):
2187
- """ """
3321
+ def property_overridable_library_set(self) -> bool:
3322
+ """Define a property as overridable or not (only for custom properties!).
3323
+
3324
+ :return: True when the overridable status of the property was successfully set.
3325
+ :rtype: bool
3326
+ """
2188
3327
  ...
2189
3328
 
2190
3329
  def property_unset(self):
2191
- """ """
3330
+ """Unset a property, will use default value afterward."""
2192
3331
  ...
2193
3332
 
2194
3333
  def remove(self, draw_func):
2195
- """
3334
+ """Remove a draw function that has been added to this menu
2196
3335
 
2197
3336
  :param draw_func:
2198
3337
  """
2199
3338
  ...
2200
3339
 
2201
3340
  def type_recast(self):
2202
- """ """
3341
+ """Return a new instance, this is needed because types
3342
+ such as textures can be changed at runtime.
3343
+
3344
+ :return: a new instance of this object with the type initialized again.
3345
+ """
2203
3346
  ...
2204
3347
 
2205
3348
  def values(self):
2206
- """ """
3349
+ """Returns the values of this objects custom properties (matches Python's
3350
+ dictionary function of the same name).
3351
+
3352
+ :return: custom property values.
3353
+ """
2207
3354
  ...
2208
3355
 
2209
3356
  class DATA_PT_gpencil_layer_display(
@@ -2239,22 +3386,35 @@ class DATA_PT_gpencil_layer_display(
2239
3386
  """ """
2240
3387
 
2241
3388
  def append(self, draw_func):
2242
- """
3389
+ """Append a draw function to this menu,
3390
+ takes the same arguments as the menus draw function
2243
3391
 
2244
- :param draw_func:
3392
+ :param draw_func:
2245
3393
  """
2246
3394
  ...
2247
3395
 
2248
- def as_pointer(self):
2249
- """ """
3396
+ def as_pointer(self) -> int:
3397
+ """Returns the memory address which holds a pointer to Blender's internal data
3398
+
3399
+ :return: int (memory address).
3400
+ :rtype: int
3401
+ """
2250
3402
  ...
2251
3403
 
2252
- def bl_rna_get_subclass(self):
2253
- """ """
3404
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3405
+ """
3406
+
3407
+ :return: The RNA type or default when not found.
3408
+ :rtype: bpy.types.Struct
3409
+ """
2254
3410
  ...
2255
3411
 
2256
- def bl_rna_get_subclass_py(self):
2257
- """ """
3412
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3413
+ """
3414
+
3415
+ :return: The class or default when not found.
3416
+ :rtype: typing.Any
3417
+ """
2258
3418
  ...
2259
3419
 
2260
3420
  def draw(self, context):
@@ -2264,72 +3424,129 @@ class DATA_PT_gpencil_layer_display(
2264
3424
  """
2265
3425
  ...
2266
3426
 
2267
- def driver_add(self):
2268
- """ """
3427
+ def driver_add(self) -> bpy.types.FCurve:
3428
+ """Adds driver(s) to the given property
3429
+
3430
+ :return: The driver(s) added.
3431
+ :rtype: bpy.types.FCurve
3432
+ """
2269
3433
  ...
2270
3434
 
2271
- def driver_remove(self):
2272
- """ """
3435
+ def driver_remove(self) -> bool:
3436
+ """Remove driver(s) from the given property
3437
+
3438
+ :return: Success of driver removal.
3439
+ :rtype: bool
3440
+ """
2273
3441
  ...
2274
3442
 
2275
3443
  def get(self):
2276
- """ """
3444
+ """Returns the value of the custom property assigned to key or default
3445
+ when not found (matches Python's dictionary function of the same name).
3446
+
3447
+ """
2277
3448
  ...
2278
3449
 
2279
3450
  def id_properties_clear(self):
2280
- """ """
3451
+ """
3452
+
3453
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3454
+ """
2281
3455
  ...
2282
3456
 
2283
3457
  def id_properties_ensure(self):
2284
- """ """
3458
+ """
3459
+
3460
+ :return: the parent group for an RNA struct's custom IDProperties.
3461
+ """
2285
3462
  ...
2286
3463
 
2287
3464
  def id_properties_ui(self):
2288
- """ """
3465
+ """
3466
+
3467
+ :return: Return an object used to manage an IDProperty's UI data.
3468
+ """
2289
3469
  ...
2290
3470
 
2291
3471
  def is_extended(self):
2292
3472
  """ """
2293
3473
  ...
2294
3474
 
2295
- def is_property_hidden(self):
2296
- """ """
3475
+ def is_property_hidden(self) -> bool:
3476
+ """Check if a property is hidden.
3477
+
3478
+ :return: True when the property is hidden.
3479
+ :rtype: bool
3480
+ """
2297
3481
  ...
2298
3482
 
2299
- def is_property_overridable_library(self):
2300
- """ """
3483
+ def is_property_overridable_library(self) -> bool:
3484
+ """Check if a property is overridable.
3485
+
3486
+ :return: True when the property is overridable.
3487
+ :rtype: bool
3488
+ """
2301
3489
  ...
2302
3490
 
2303
- def is_property_readonly(self):
2304
- """ """
3491
+ def is_property_readonly(self) -> bool:
3492
+ """Check if a property is readonly.
3493
+
3494
+ :return: True when the property is readonly (not writable).
3495
+ :rtype: bool
3496
+ """
2305
3497
  ...
2306
3498
 
2307
- def is_property_set(self):
2308
- """ """
3499
+ def is_property_set(self) -> bool:
3500
+ """Check if a property is set, use for testing operator properties.
3501
+
3502
+ :return: True when the property has been set.
3503
+ :rtype: bool
3504
+ """
2309
3505
  ...
2310
3506
 
2311
3507
  def items(self):
2312
- """ """
3508
+ """Returns the items of this objects custom properties (matches Python's
3509
+ dictionary function of the same name).
3510
+
3511
+ :return: custom property key, value pairs.
3512
+ """
2313
3513
  ...
2314
3514
 
2315
- def keyframe_delete(self):
2316
- """ """
3515
+ def keyframe_delete(self) -> bool:
3516
+ """Remove a keyframe from this properties fcurve.
3517
+
3518
+ :return: Success of keyframe deletion.
3519
+ :rtype: bool
3520
+ """
2317
3521
  ...
2318
3522
 
2319
- def keyframe_insert(self):
2320
- """ """
3523
+ def keyframe_insert(self) -> bool:
3524
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3525
+
3526
+ :return: Success of keyframe insertion.
3527
+ :rtype: bool
3528
+ """
2321
3529
  ...
2322
3530
 
2323
3531
  def keys(self):
2324
- """ """
3532
+ """Returns the keys of this objects custom properties (matches Python's
3533
+ dictionary function of the same name).
3534
+
3535
+ :return: custom property keys.
3536
+ """
2325
3537
  ...
2326
3538
 
2327
- def path_from_id(self):
2328
- """ """
3539
+ def path_from_id(self) -> str:
3540
+ """Returns the data path from the ID to this object (string).
3541
+
3542
+ :return: The path from `bpy.types.bpy_struct.id_data`
3543
+ to this struct and property (when given).
3544
+ :rtype: str
3545
+ """
2329
3546
  ...
2330
3547
 
2331
3548
  def path_resolve(self):
2332
- """ """
3549
+ """Returns the property from the path, raise an exception when not found."""
2333
3550
  ...
2334
3551
 
2335
3552
  def poll(self, context):
@@ -2340,37 +3557,53 @@ class DATA_PT_gpencil_layer_display(
2340
3557
  ...
2341
3558
 
2342
3559
  def pop(self):
2343
- """ """
3560
+ """Remove and return the value of the custom property assigned to key or default
3561
+ when not found (matches Python's dictionary function of the same name).
3562
+
3563
+ """
2344
3564
  ...
2345
3565
 
2346
3566
  def prepend(self, draw_func):
2347
- """
3567
+ """Prepend a draw function to this menu, takes the same arguments as
3568
+ the menus draw function
2348
3569
 
2349
- :param draw_func:
3570
+ :param draw_func:
2350
3571
  """
2351
3572
  ...
2352
3573
 
2353
- def property_overridable_library_set(self):
2354
- """ """
3574
+ def property_overridable_library_set(self) -> bool:
3575
+ """Define a property as overridable or not (only for custom properties!).
3576
+
3577
+ :return: True when the overridable status of the property was successfully set.
3578
+ :rtype: bool
3579
+ """
2355
3580
  ...
2356
3581
 
2357
3582
  def property_unset(self):
2358
- """ """
3583
+ """Unset a property, will use default value afterward."""
2359
3584
  ...
2360
3585
 
2361
3586
  def remove(self, draw_func):
2362
- """
3587
+ """Remove a draw function that has been added to this menu
2363
3588
 
2364
3589
  :param draw_func:
2365
3590
  """
2366
3591
  ...
2367
3592
 
2368
3593
  def type_recast(self):
2369
- """ """
3594
+ """Return a new instance, this is needed because types
3595
+ such as textures can be changed at runtime.
3596
+
3597
+ :return: a new instance of this object with the type initialized again.
3598
+ """
2370
3599
  ...
2371
3600
 
2372
3601
  def values(self):
2373
- """ """
3602
+ """Returns the values of this objects custom properties (matches Python's
3603
+ dictionary function of the same name).
3604
+
3605
+ :return: custom property values.
3606
+ """
2374
3607
  ...
2375
3608
 
2376
3609
  class DATA_PT_gpencil_layer_masks(
@@ -2406,22 +3639,35 @@ class DATA_PT_gpencil_layer_masks(
2406
3639
  """ """
2407
3640
 
2408
3641
  def append(self, draw_func):
2409
- """
3642
+ """Append a draw function to this menu,
3643
+ takes the same arguments as the menus draw function
2410
3644
 
2411
- :param draw_func:
3645
+ :param draw_func:
2412
3646
  """
2413
3647
  ...
2414
3648
 
2415
- def as_pointer(self):
2416
- """ """
3649
+ def as_pointer(self) -> int:
3650
+ """Returns the memory address which holds a pointer to Blender's internal data
3651
+
3652
+ :return: int (memory address).
3653
+ :rtype: int
3654
+ """
2417
3655
  ...
2418
3656
 
2419
- def bl_rna_get_subclass(self):
2420
- """ """
3657
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3658
+ """
3659
+
3660
+ :return: The RNA type or default when not found.
3661
+ :rtype: bpy.types.Struct
3662
+ """
2421
3663
  ...
2422
3664
 
2423
- def bl_rna_get_subclass_py(self):
2424
- """ """
3665
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3666
+ """
3667
+
3668
+ :return: The class or default when not found.
3669
+ :rtype: typing.Any
3670
+ """
2425
3671
  ...
2426
3672
 
2427
3673
  def draw(self, context):
@@ -2438,72 +3684,129 @@ class DATA_PT_gpencil_layer_masks(
2438
3684
  """
2439
3685
  ...
2440
3686
 
2441
- def driver_add(self):
2442
- """ """
3687
+ def driver_add(self) -> bpy.types.FCurve:
3688
+ """Adds driver(s) to the given property
3689
+
3690
+ :return: The driver(s) added.
3691
+ :rtype: bpy.types.FCurve
3692
+ """
2443
3693
  ...
2444
3694
 
2445
- def driver_remove(self):
2446
- """ """
3695
+ def driver_remove(self) -> bool:
3696
+ """Remove driver(s) from the given property
3697
+
3698
+ :return: Success of driver removal.
3699
+ :rtype: bool
3700
+ """
2447
3701
  ...
2448
3702
 
2449
3703
  def get(self):
2450
- """ """
3704
+ """Returns the value of the custom property assigned to key or default
3705
+ when not found (matches Python's dictionary function of the same name).
3706
+
3707
+ """
2451
3708
  ...
2452
3709
 
2453
3710
  def id_properties_clear(self):
2454
- """ """
3711
+ """
3712
+
3713
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3714
+ """
2455
3715
  ...
2456
3716
 
2457
3717
  def id_properties_ensure(self):
2458
- """ """
3718
+ """
3719
+
3720
+ :return: the parent group for an RNA struct's custom IDProperties.
3721
+ """
2459
3722
  ...
2460
3723
 
2461
3724
  def id_properties_ui(self):
2462
- """ """
3725
+ """
3726
+
3727
+ :return: Return an object used to manage an IDProperty's UI data.
3728
+ """
2463
3729
  ...
2464
3730
 
2465
3731
  def is_extended(self):
2466
3732
  """ """
2467
3733
  ...
2468
3734
 
2469
- def is_property_hidden(self):
2470
- """ """
3735
+ def is_property_hidden(self) -> bool:
3736
+ """Check if a property is hidden.
3737
+
3738
+ :return: True when the property is hidden.
3739
+ :rtype: bool
3740
+ """
2471
3741
  ...
2472
3742
 
2473
- def is_property_overridable_library(self):
2474
- """ """
3743
+ def is_property_overridable_library(self) -> bool:
3744
+ """Check if a property is overridable.
3745
+
3746
+ :return: True when the property is overridable.
3747
+ :rtype: bool
3748
+ """
2475
3749
  ...
2476
3750
 
2477
- def is_property_readonly(self):
2478
- """ """
3751
+ def is_property_readonly(self) -> bool:
3752
+ """Check if a property is readonly.
3753
+
3754
+ :return: True when the property is readonly (not writable).
3755
+ :rtype: bool
3756
+ """
2479
3757
  ...
2480
3758
 
2481
- def is_property_set(self):
2482
- """ """
3759
+ def is_property_set(self) -> bool:
3760
+ """Check if a property is set, use for testing operator properties.
3761
+
3762
+ :return: True when the property has been set.
3763
+ :rtype: bool
3764
+ """
2483
3765
  ...
2484
3766
 
2485
3767
  def items(self):
2486
- """ """
3768
+ """Returns the items of this objects custom properties (matches Python's
3769
+ dictionary function of the same name).
3770
+
3771
+ :return: custom property key, value pairs.
3772
+ """
2487
3773
  ...
2488
3774
 
2489
- def keyframe_delete(self):
2490
- """ """
3775
+ def keyframe_delete(self) -> bool:
3776
+ """Remove a keyframe from this properties fcurve.
3777
+
3778
+ :return: Success of keyframe deletion.
3779
+ :rtype: bool
3780
+ """
2491
3781
  ...
2492
3782
 
2493
- def keyframe_insert(self):
2494
- """ """
3783
+ def keyframe_insert(self) -> bool:
3784
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
3785
+
3786
+ :return: Success of keyframe insertion.
3787
+ :rtype: bool
3788
+ """
3789
+ ...
3790
+
3791
+ def keys(self):
3792
+ """Returns the keys of this objects custom properties (matches Python's
3793
+ dictionary function of the same name).
3794
+
3795
+ :return: custom property keys.
3796
+ """
2495
3797
  ...
2496
3798
 
2497
- def keys(self):
2498
- """ """
2499
- ...
3799
+ def path_from_id(self) -> str:
3800
+ """Returns the data path from the ID to this object (string).
2500
3801
 
2501
- def path_from_id(self):
2502
- """ """
3802
+ :return: The path from `bpy.types.bpy_struct.id_data`
3803
+ to this struct and property (when given).
3804
+ :rtype: str
3805
+ """
2503
3806
  ...
2504
3807
 
2505
3808
  def path_resolve(self):
2506
- """ """
3809
+ """Returns the property from the path, raise an exception when not found."""
2507
3810
  ...
2508
3811
 
2509
3812
  def poll(self, context):
@@ -2514,37 +3817,53 @@ class DATA_PT_gpencil_layer_masks(
2514
3817
  ...
2515
3818
 
2516
3819
  def pop(self):
2517
- """ """
3820
+ """Remove and return the value of the custom property assigned to key or default
3821
+ when not found (matches Python's dictionary function of the same name).
3822
+
3823
+ """
2518
3824
  ...
2519
3825
 
2520
3826
  def prepend(self, draw_func):
2521
- """
3827
+ """Prepend a draw function to this menu, takes the same arguments as
3828
+ the menus draw function
2522
3829
 
2523
- :param draw_func:
3830
+ :param draw_func:
2524
3831
  """
2525
3832
  ...
2526
3833
 
2527
- def property_overridable_library_set(self):
2528
- """ """
3834
+ def property_overridable_library_set(self) -> bool:
3835
+ """Define a property as overridable or not (only for custom properties!).
3836
+
3837
+ :return: True when the overridable status of the property was successfully set.
3838
+ :rtype: bool
3839
+ """
2529
3840
  ...
2530
3841
 
2531
3842
  def property_unset(self):
2532
- """ """
3843
+ """Unset a property, will use default value afterward."""
2533
3844
  ...
2534
3845
 
2535
3846
  def remove(self, draw_func):
2536
- """
3847
+ """Remove a draw function that has been added to this menu
2537
3848
 
2538
3849
  :param draw_func:
2539
3850
  """
2540
3851
  ...
2541
3852
 
2542
3853
  def type_recast(self):
2543
- """ """
3854
+ """Return a new instance, this is needed because types
3855
+ such as textures can be changed at runtime.
3856
+
3857
+ :return: a new instance of this object with the type initialized again.
3858
+ """
2544
3859
  ...
2545
3860
 
2546
3861
  def values(self):
2547
- """ """
3862
+ """Returns the values of this objects custom properties (matches Python's
3863
+ dictionary function of the same name).
3864
+
3865
+ :return: custom property values.
3866
+ """
2548
3867
  ...
2549
3868
 
2550
3869
  class DATA_PT_gpencil_layer_relations(
@@ -2580,22 +3899,35 @@ class DATA_PT_gpencil_layer_relations(
2580
3899
  """ """
2581
3900
 
2582
3901
  def append(self, draw_func):
2583
- """
3902
+ """Append a draw function to this menu,
3903
+ takes the same arguments as the menus draw function
2584
3904
 
2585
- :param draw_func:
3905
+ :param draw_func:
2586
3906
  """
2587
3907
  ...
2588
3908
 
2589
- def as_pointer(self):
2590
- """ """
3909
+ def as_pointer(self) -> int:
3910
+ """Returns the memory address which holds a pointer to Blender's internal data
3911
+
3912
+ :return: int (memory address).
3913
+ :rtype: int
3914
+ """
2591
3915
  ...
2592
3916
 
2593
- def bl_rna_get_subclass(self):
2594
- """ """
3917
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
3918
+ """
3919
+
3920
+ :return: The RNA type or default when not found.
3921
+ :rtype: bpy.types.Struct
3922
+ """
2595
3923
  ...
2596
3924
 
2597
- def bl_rna_get_subclass_py(self):
2598
- """ """
3925
+ def bl_rna_get_subclass_py(self) -> typing.Any:
3926
+ """
3927
+
3928
+ :return: The class or default when not found.
3929
+ :rtype: typing.Any
3930
+ """
2599
3931
  ...
2600
3932
 
2601
3933
  def draw(self, context):
@@ -2605,72 +3937,129 @@ class DATA_PT_gpencil_layer_relations(
2605
3937
  """
2606
3938
  ...
2607
3939
 
2608
- def driver_add(self):
2609
- """ """
3940
+ def driver_add(self) -> bpy.types.FCurve:
3941
+ """Adds driver(s) to the given property
3942
+
3943
+ :return: The driver(s) added.
3944
+ :rtype: bpy.types.FCurve
3945
+ """
2610
3946
  ...
2611
3947
 
2612
- def driver_remove(self):
2613
- """ """
3948
+ def driver_remove(self) -> bool:
3949
+ """Remove driver(s) from the given property
3950
+
3951
+ :return: Success of driver removal.
3952
+ :rtype: bool
3953
+ """
2614
3954
  ...
2615
3955
 
2616
3956
  def get(self):
2617
- """ """
3957
+ """Returns the value of the custom property assigned to key or default
3958
+ when not found (matches Python's dictionary function of the same name).
3959
+
3960
+ """
2618
3961
  ...
2619
3962
 
2620
3963
  def id_properties_clear(self):
2621
- """ """
3964
+ """
3965
+
3966
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
3967
+ """
2622
3968
  ...
2623
3969
 
2624
3970
  def id_properties_ensure(self):
2625
- """ """
3971
+ """
3972
+
3973
+ :return: the parent group for an RNA struct's custom IDProperties.
3974
+ """
2626
3975
  ...
2627
3976
 
2628
3977
  def id_properties_ui(self):
2629
- """ """
3978
+ """
3979
+
3980
+ :return: Return an object used to manage an IDProperty's UI data.
3981
+ """
2630
3982
  ...
2631
3983
 
2632
3984
  def is_extended(self):
2633
3985
  """ """
2634
3986
  ...
2635
3987
 
2636
- def is_property_hidden(self):
2637
- """ """
3988
+ def is_property_hidden(self) -> bool:
3989
+ """Check if a property is hidden.
3990
+
3991
+ :return: True when the property is hidden.
3992
+ :rtype: bool
3993
+ """
2638
3994
  ...
2639
3995
 
2640
- def is_property_overridable_library(self):
2641
- """ """
3996
+ def is_property_overridable_library(self) -> bool:
3997
+ """Check if a property is overridable.
3998
+
3999
+ :return: True when the property is overridable.
4000
+ :rtype: bool
4001
+ """
2642
4002
  ...
2643
4003
 
2644
- def is_property_readonly(self):
2645
- """ """
4004
+ def is_property_readonly(self) -> bool:
4005
+ """Check if a property is readonly.
4006
+
4007
+ :return: True when the property is readonly (not writable).
4008
+ :rtype: bool
4009
+ """
2646
4010
  ...
2647
4011
 
2648
- def is_property_set(self):
2649
- """ """
4012
+ def is_property_set(self) -> bool:
4013
+ """Check if a property is set, use for testing operator properties.
4014
+
4015
+ :return: True when the property has been set.
4016
+ :rtype: bool
4017
+ """
2650
4018
  ...
2651
4019
 
2652
4020
  def items(self):
2653
- """ """
4021
+ """Returns the items of this objects custom properties (matches Python's
4022
+ dictionary function of the same name).
4023
+
4024
+ :return: custom property key, value pairs.
4025
+ """
2654
4026
  ...
2655
4027
 
2656
- def keyframe_delete(self):
2657
- """ """
4028
+ def keyframe_delete(self) -> bool:
4029
+ """Remove a keyframe from this properties fcurve.
4030
+
4031
+ :return: Success of keyframe deletion.
4032
+ :rtype: bool
4033
+ """
2658
4034
  ...
2659
4035
 
2660
- def keyframe_insert(self):
2661
- """ """
4036
+ def keyframe_insert(self) -> bool:
4037
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4038
+
4039
+ :return: Success of keyframe insertion.
4040
+ :rtype: bool
4041
+ """
2662
4042
  ...
2663
4043
 
2664
4044
  def keys(self):
2665
- """ """
4045
+ """Returns the keys of this objects custom properties (matches Python's
4046
+ dictionary function of the same name).
4047
+
4048
+ :return: custom property keys.
4049
+ """
2666
4050
  ...
2667
4051
 
2668
- def path_from_id(self):
2669
- """ """
4052
+ def path_from_id(self) -> str:
4053
+ """Returns the data path from the ID to this object (string).
4054
+
4055
+ :return: The path from `bpy.types.bpy_struct.id_data`
4056
+ to this struct and property (when given).
4057
+ :rtype: str
4058
+ """
2670
4059
  ...
2671
4060
 
2672
4061
  def path_resolve(self):
2673
- """ """
4062
+ """Returns the property from the path, raise an exception when not found."""
2674
4063
  ...
2675
4064
 
2676
4065
  def poll(self, context):
@@ -2681,37 +4070,53 @@ class DATA_PT_gpencil_layer_relations(
2681
4070
  ...
2682
4071
 
2683
4072
  def pop(self):
2684
- """ """
4073
+ """Remove and return the value of the custom property assigned to key or default
4074
+ when not found (matches Python's dictionary function of the same name).
4075
+
4076
+ """
2685
4077
  ...
2686
4078
 
2687
4079
  def prepend(self, draw_func):
2688
- """
4080
+ """Prepend a draw function to this menu, takes the same arguments as
4081
+ the menus draw function
2689
4082
 
2690
- :param draw_func:
4083
+ :param draw_func:
2691
4084
  """
2692
4085
  ...
2693
4086
 
2694
- def property_overridable_library_set(self):
2695
- """ """
4087
+ def property_overridable_library_set(self) -> bool:
4088
+ """Define a property as overridable or not (only for custom properties!).
4089
+
4090
+ :return: True when the overridable status of the property was successfully set.
4091
+ :rtype: bool
4092
+ """
2696
4093
  ...
2697
4094
 
2698
4095
  def property_unset(self):
2699
- """ """
4096
+ """Unset a property, will use default value afterward."""
2700
4097
  ...
2701
4098
 
2702
4099
  def remove(self, draw_func):
2703
- """
4100
+ """Remove a draw function that has been added to this menu
2704
4101
 
2705
4102
  :param draw_func:
2706
4103
  """
2707
4104
  ...
2708
4105
 
2709
4106
  def type_recast(self):
2710
- """ """
4107
+ """Return a new instance, this is needed because types
4108
+ such as textures can be changed at runtime.
4109
+
4110
+ :return: a new instance of this object with the type initialized again.
4111
+ """
2711
4112
  ...
2712
4113
 
2713
4114
  def values(self):
2714
- """ """
4115
+ """Returns the values of this objects custom properties (matches Python's
4116
+ dictionary function of the same name).
4117
+
4118
+ :return: custom property values.
4119
+ """
2715
4120
  ...
2716
4121
 
2717
4122
  class DATA_PT_gpencil_layer_transform(
@@ -2747,22 +4152,35 @@ class DATA_PT_gpencil_layer_transform(
2747
4152
  """ """
2748
4153
 
2749
4154
  def append(self, draw_func):
2750
- """
4155
+ """Append a draw function to this menu,
4156
+ takes the same arguments as the menus draw function
2751
4157
 
2752
- :param draw_func:
4158
+ :param draw_func:
2753
4159
  """
2754
4160
  ...
2755
4161
 
2756
- def as_pointer(self):
2757
- """ """
4162
+ def as_pointer(self) -> int:
4163
+ """Returns the memory address which holds a pointer to Blender's internal data
4164
+
4165
+ :return: int (memory address).
4166
+ :rtype: int
4167
+ """
2758
4168
  ...
2759
4169
 
2760
- def bl_rna_get_subclass(self):
2761
- """ """
4170
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
4171
+ """
4172
+
4173
+ :return: The RNA type or default when not found.
4174
+ :rtype: bpy.types.Struct
4175
+ """
2762
4176
  ...
2763
4177
 
2764
- def bl_rna_get_subclass_py(self):
2765
- """ """
4178
+ def bl_rna_get_subclass_py(self) -> typing.Any:
4179
+ """
4180
+
4181
+ :return: The class or default when not found.
4182
+ :rtype: typing.Any
4183
+ """
2766
4184
  ...
2767
4185
 
2768
4186
  def draw(self, context):
@@ -2772,72 +4190,129 @@ class DATA_PT_gpencil_layer_transform(
2772
4190
  """
2773
4191
  ...
2774
4192
 
2775
- def driver_add(self):
2776
- """ """
4193
+ def driver_add(self) -> bpy.types.FCurve:
4194
+ """Adds driver(s) to the given property
4195
+
4196
+ :return: The driver(s) added.
4197
+ :rtype: bpy.types.FCurve
4198
+ """
2777
4199
  ...
2778
4200
 
2779
- def driver_remove(self):
2780
- """ """
4201
+ def driver_remove(self) -> bool:
4202
+ """Remove driver(s) from the given property
4203
+
4204
+ :return: Success of driver removal.
4205
+ :rtype: bool
4206
+ """
2781
4207
  ...
2782
4208
 
2783
4209
  def get(self):
2784
- """ """
4210
+ """Returns the value of the custom property assigned to key or default
4211
+ when not found (matches Python's dictionary function of the same name).
4212
+
4213
+ """
2785
4214
  ...
2786
4215
 
2787
4216
  def id_properties_clear(self):
2788
- """ """
4217
+ """
4218
+
4219
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4220
+ """
2789
4221
  ...
2790
4222
 
2791
4223
  def id_properties_ensure(self):
2792
- """ """
4224
+ """
4225
+
4226
+ :return: the parent group for an RNA struct's custom IDProperties.
4227
+ """
2793
4228
  ...
2794
4229
 
2795
4230
  def id_properties_ui(self):
2796
- """ """
4231
+ """
4232
+
4233
+ :return: Return an object used to manage an IDProperty's UI data.
4234
+ """
2797
4235
  ...
2798
4236
 
2799
4237
  def is_extended(self):
2800
4238
  """ """
2801
4239
  ...
2802
4240
 
2803
- def is_property_hidden(self):
2804
- """ """
4241
+ def is_property_hidden(self) -> bool:
4242
+ """Check if a property is hidden.
4243
+
4244
+ :return: True when the property is hidden.
4245
+ :rtype: bool
4246
+ """
2805
4247
  ...
2806
4248
 
2807
- def is_property_overridable_library(self):
2808
- """ """
4249
+ def is_property_overridable_library(self) -> bool:
4250
+ """Check if a property is overridable.
4251
+
4252
+ :return: True when the property is overridable.
4253
+ :rtype: bool
4254
+ """
2809
4255
  ...
2810
4256
 
2811
- def is_property_readonly(self):
2812
- """ """
4257
+ def is_property_readonly(self) -> bool:
4258
+ """Check if a property is readonly.
4259
+
4260
+ :return: True when the property is readonly (not writable).
4261
+ :rtype: bool
4262
+ """
2813
4263
  ...
2814
4264
 
2815
- def is_property_set(self):
2816
- """ """
4265
+ def is_property_set(self) -> bool:
4266
+ """Check if a property is set, use for testing operator properties.
4267
+
4268
+ :return: True when the property has been set.
4269
+ :rtype: bool
4270
+ """
2817
4271
  ...
2818
4272
 
2819
4273
  def items(self):
2820
- """ """
4274
+ """Returns the items of this objects custom properties (matches Python's
4275
+ dictionary function of the same name).
4276
+
4277
+ :return: custom property key, value pairs.
4278
+ """
2821
4279
  ...
2822
4280
 
2823
- def keyframe_delete(self):
2824
- """ """
4281
+ def keyframe_delete(self) -> bool:
4282
+ """Remove a keyframe from this properties fcurve.
4283
+
4284
+ :return: Success of keyframe deletion.
4285
+ :rtype: bool
4286
+ """
2825
4287
  ...
2826
4288
 
2827
- def keyframe_insert(self):
2828
- """ """
4289
+ def keyframe_insert(self) -> bool:
4290
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4291
+
4292
+ :return: Success of keyframe insertion.
4293
+ :rtype: bool
4294
+ """
2829
4295
  ...
2830
4296
 
2831
4297
  def keys(self):
2832
- """ """
4298
+ """Returns the keys of this objects custom properties (matches Python's
4299
+ dictionary function of the same name).
4300
+
4301
+ :return: custom property keys.
4302
+ """
2833
4303
  ...
2834
4304
 
2835
- def path_from_id(self):
2836
- """ """
4305
+ def path_from_id(self) -> str:
4306
+ """Returns the data path from the ID to this object (string).
4307
+
4308
+ :return: The path from `bpy.types.bpy_struct.id_data`
4309
+ to this struct and property (when given).
4310
+ :rtype: str
4311
+ """
2837
4312
  ...
2838
4313
 
2839
4314
  def path_resolve(self):
2840
- """ """
4315
+ """Returns the property from the path, raise an exception when not found."""
2841
4316
  ...
2842
4317
 
2843
4318
  def poll(self, context):
@@ -2848,37 +4323,53 @@ class DATA_PT_gpencil_layer_transform(
2848
4323
  ...
2849
4324
 
2850
4325
  def pop(self):
2851
- """ """
4326
+ """Remove and return the value of the custom property assigned to key or default
4327
+ when not found (matches Python's dictionary function of the same name).
4328
+
4329
+ """
2852
4330
  ...
2853
4331
 
2854
4332
  def prepend(self, draw_func):
2855
- """
4333
+ """Prepend a draw function to this menu, takes the same arguments as
4334
+ the menus draw function
2856
4335
 
2857
- :param draw_func:
4336
+ :param draw_func:
2858
4337
  """
2859
4338
  ...
2860
4339
 
2861
- def property_overridable_library_set(self):
2862
- """ """
4340
+ def property_overridable_library_set(self) -> bool:
4341
+ """Define a property as overridable or not (only for custom properties!).
4342
+
4343
+ :return: True when the overridable status of the property was successfully set.
4344
+ :rtype: bool
4345
+ """
2863
4346
  ...
2864
4347
 
2865
4348
  def property_unset(self):
2866
- """ """
4349
+ """Unset a property, will use default value afterward."""
2867
4350
  ...
2868
4351
 
2869
4352
  def remove(self, draw_func):
2870
- """
4353
+ """Remove a draw function that has been added to this menu
2871
4354
 
2872
4355
  :param draw_func:
2873
4356
  """
2874
4357
  ...
2875
4358
 
2876
4359
  def type_recast(self):
2877
- """ """
4360
+ """Return a new instance, this is needed because types
4361
+ such as textures can be changed at runtime.
4362
+
4363
+ :return: a new instance of this object with the type initialized again.
4364
+ """
2878
4365
  ...
2879
4366
 
2880
4367
  def values(self):
2881
- """ """
4368
+ """Returns the values of this objects custom properties (matches Python's
4369
+ dictionary function of the same name).
4370
+
4371
+ :return: custom property values.
4372
+ """
2882
4373
  ...
2883
4374
 
2884
4375
  class DATA_PT_gpencil_vertex_groups(
@@ -2908,22 +4399,35 @@ class DATA_PT_gpencil_vertex_groups(
2908
4399
  """ """
2909
4400
 
2910
4401
  def append(self, draw_func):
2911
- """
4402
+ """Append a draw function to this menu,
4403
+ takes the same arguments as the menus draw function
2912
4404
 
2913
- :param draw_func:
4405
+ :param draw_func:
2914
4406
  """
2915
4407
  ...
2916
4408
 
2917
- def as_pointer(self):
2918
- """ """
4409
+ def as_pointer(self) -> int:
4410
+ """Returns the memory address which holds a pointer to Blender's internal data
4411
+
4412
+ :return: int (memory address).
4413
+ :rtype: int
4414
+ """
2919
4415
  ...
2920
4416
 
2921
- def bl_rna_get_subclass(self):
2922
- """ """
4417
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
4418
+ """
4419
+
4420
+ :return: The RNA type or default when not found.
4421
+ :rtype: bpy.types.Struct
4422
+ """
2923
4423
  ...
2924
4424
 
2925
- def bl_rna_get_subclass_py(self):
2926
- """ """
4425
+ def bl_rna_get_subclass_py(self) -> typing.Any:
4426
+ """
4427
+
4428
+ :return: The class or default when not found.
4429
+ :rtype: typing.Any
4430
+ """
2927
4431
  ...
2928
4432
 
2929
4433
  def draw(self, context):
@@ -2933,72 +4437,129 @@ class DATA_PT_gpencil_vertex_groups(
2933
4437
  """
2934
4438
  ...
2935
4439
 
2936
- def driver_add(self):
2937
- """ """
4440
+ def driver_add(self) -> bpy.types.FCurve:
4441
+ """Adds driver(s) to the given property
4442
+
4443
+ :return: The driver(s) added.
4444
+ :rtype: bpy.types.FCurve
4445
+ """
2938
4446
  ...
2939
4447
 
2940
- def driver_remove(self):
2941
- """ """
4448
+ def driver_remove(self) -> bool:
4449
+ """Remove driver(s) from the given property
4450
+
4451
+ :return: Success of driver removal.
4452
+ :rtype: bool
4453
+ """
2942
4454
  ...
2943
4455
 
2944
4456
  def get(self):
2945
- """ """
4457
+ """Returns the value of the custom property assigned to key or default
4458
+ when not found (matches Python's dictionary function of the same name).
4459
+
4460
+ """
2946
4461
  ...
2947
4462
 
2948
4463
  def id_properties_clear(self):
2949
- """ """
4464
+ """
4465
+
4466
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
4467
+ """
2950
4468
  ...
2951
4469
 
2952
4470
  def id_properties_ensure(self):
2953
- """ """
4471
+ """
4472
+
4473
+ :return: the parent group for an RNA struct's custom IDProperties.
4474
+ """
2954
4475
  ...
2955
4476
 
2956
4477
  def id_properties_ui(self):
2957
- """ """
4478
+ """
4479
+
4480
+ :return: Return an object used to manage an IDProperty's UI data.
4481
+ """
2958
4482
  ...
2959
4483
 
2960
4484
  def is_extended(self):
2961
4485
  """ """
2962
4486
  ...
2963
4487
 
2964
- def is_property_hidden(self):
2965
- """ """
4488
+ def is_property_hidden(self) -> bool:
4489
+ """Check if a property is hidden.
4490
+
4491
+ :return: True when the property is hidden.
4492
+ :rtype: bool
4493
+ """
2966
4494
  ...
2967
4495
 
2968
- def is_property_overridable_library(self):
2969
- """ """
4496
+ def is_property_overridable_library(self) -> bool:
4497
+ """Check if a property is overridable.
4498
+
4499
+ :return: True when the property is overridable.
4500
+ :rtype: bool
4501
+ """
2970
4502
  ...
2971
4503
 
2972
- def is_property_readonly(self):
2973
- """ """
4504
+ def is_property_readonly(self) -> bool:
4505
+ """Check if a property is readonly.
4506
+
4507
+ :return: True when the property is readonly (not writable).
4508
+ :rtype: bool
4509
+ """
2974
4510
  ...
2975
4511
 
2976
- def is_property_set(self):
2977
- """ """
4512
+ def is_property_set(self) -> bool:
4513
+ """Check if a property is set, use for testing operator properties.
4514
+
4515
+ :return: True when the property has been set.
4516
+ :rtype: bool
4517
+ """
2978
4518
  ...
2979
4519
 
2980
4520
  def items(self):
2981
- """ """
4521
+ """Returns the items of this objects custom properties (matches Python's
4522
+ dictionary function of the same name).
4523
+
4524
+ :return: custom property key, value pairs.
4525
+ """
2982
4526
  ...
2983
4527
 
2984
- def keyframe_delete(self):
2985
- """ """
4528
+ def keyframe_delete(self) -> bool:
4529
+ """Remove a keyframe from this properties fcurve.
4530
+
4531
+ :return: Success of keyframe deletion.
4532
+ :rtype: bool
4533
+ """
2986
4534
  ...
2987
4535
 
2988
- def keyframe_insert(self):
2989
- """ """
4536
+ def keyframe_insert(self) -> bool:
4537
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
4538
+
4539
+ :return: Success of keyframe insertion.
4540
+ :rtype: bool
4541
+ """
2990
4542
  ...
2991
4543
 
2992
4544
  def keys(self):
2993
- """ """
4545
+ """Returns the keys of this objects custom properties (matches Python's
4546
+ dictionary function of the same name).
4547
+
4548
+ :return: custom property keys.
4549
+ """
2994
4550
  ...
2995
4551
 
2996
- def path_from_id(self):
2997
- """ """
4552
+ def path_from_id(self) -> str:
4553
+ """Returns the data path from the ID to this object (string).
4554
+
4555
+ :return: The path from `bpy.types.bpy_struct.id_data`
4556
+ to this struct and property (when given).
4557
+ :rtype: str
4558
+ """
2998
4559
  ...
2999
4560
 
3000
4561
  def path_resolve(self):
3001
- """ """
4562
+ """Returns the property from the path, raise an exception when not found."""
3002
4563
  ...
3003
4564
 
3004
4565
  def poll(self, context):
@@ -3009,35 +4570,51 @@ class DATA_PT_gpencil_vertex_groups(
3009
4570
  ...
3010
4571
 
3011
4572
  def pop(self):
3012
- """ """
4573
+ """Remove and return the value of the custom property assigned to key or default
4574
+ when not found (matches Python's dictionary function of the same name).
4575
+
4576
+ """
3013
4577
  ...
3014
4578
 
3015
4579
  def prepend(self, draw_func):
3016
- """
4580
+ """Prepend a draw function to this menu, takes the same arguments as
4581
+ the menus draw function
3017
4582
 
3018
- :param draw_func:
4583
+ :param draw_func:
3019
4584
  """
3020
4585
  ...
3021
4586
 
3022
- def property_overridable_library_set(self):
3023
- """ """
4587
+ def property_overridable_library_set(self) -> bool:
4588
+ """Define a property as overridable or not (only for custom properties!).
4589
+
4590
+ :return: True when the overridable status of the property was successfully set.
4591
+ :rtype: bool
4592
+ """
3024
4593
  ...
3025
4594
 
3026
4595
  def property_unset(self):
3027
- """ """
4596
+ """Unset a property, will use default value afterward."""
3028
4597
  ...
3029
4598
 
3030
4599
  def remove(self, draw_func):
3031
- """
4600
+ """Remove a draw function that has been added to this menu
3032
4601
 
3033
4602
  :param draw_func:
3034
4603
  """
3035
4604
  ...
3036
4605
 
3037
4606
  def type_recast(self):
3038
- """ """
4607
+ """Return a new instance, this is needed because types
4608
+ such as textures can be changed at runtime.
4609
+
4610
+ :return: a new instance of this object with the type initialized again.
4611
+ """
3039
4612
  ...
3040
4613
 
3041
4614
  def values(self):
3042
- """ """
4615
+ """Returns the values of this objects custom properties (matches Python's
4616
+ dictionary function of the same name).
4617
+
4618
+ :return: custom property values.
4619
+ """
3043
4620
  ...