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

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

Potentially problematic release.


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

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