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

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

Potentially problematic release.


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

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