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

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

Potentially problematic release.


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

Files changed (549) hide show
  1. _bpy_internal/freedesktop/__init__.pyi +17 -84
  2. addon_utils/__init__.pyi +44 -38
  3. animsys_refactor/__init__.pyi +7 -27
  4. aud/__init__.pyi +8 -11
  5. bgl/__init__.pyi +121 -1812
  6. bl_app_override/__init__.pyi +8 -19
  7. bl_app_override/helpers/__init__.pyi +5 -23
  8. bl_app_template_utils/__init__.pyi +5 -17
  9. bl_console_utils/autocomplete/complete_calltip/__init__.pyi +48 -10
  10. bl_console_utils/autocomplete/complete_import/__init__.pyi +27 -6
  11. bl_console_utils/autocomplete/complete_namespace/__init__.pyi +40 -8
  12. bl_console_utils/autocomplete/intellisense/__init__.pyi +31 -4
  13. bl_i18n_utils/bl_extract_messages/__init__.pyi +16 -67
  14. bl_i18n_utils/merge_po/__init__.pyi +1 -4
  15. bl_i18n_utils/settings/__init__.pyi +6 -24
  16. bl_i18n_utils/utils/__init__.pyi +93 -122
  17. bl_i18n_utils/utils_cli/__init__.pyi +6 -29
  18. bl_i18n_utils/utils_languages_menu/__init__.pyi +1 -4
  19. bl_i18n_utils/utils_rtl/__init__.pyi +8 -2
  20. bl_keymap_utils/io/__init__.pyi +9 -40
  21. bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -2
  22. bl_keymap_utils/keymap_hierarchy/__init__.pyi +1 -4
  23. bl_keymap_utils/platform_helpers/__init__.pyi +2 -6
  24. bl_keymap_utils/versioning/__init__.pyi +1 -4
  25. bl_operators/__init__.pyi +2 -9
  26. bl_operators/add_mesh_torus/__init__.pyi +128 -59
  27. bl_operators/anim/__init__.pyi +1001 -398
  28. bl_operators/assets/__init__.pyi +376 -152
  29. bl_operators/bmesh/find_adjacent/__init__.pyi +10 -37
  30. bl_operators/clip/__init__.pyi +1264 -532
  31. bl_operators/console/__init__.pyi +626 -242
  32. bl_operators/constraint/__init__.pyi +502 -201
  33. bl_operators/file/__init__.pyi +376 -150
  34. bl_operators/freestyle/__init__.pyi +501 -200
  35. bl_operators/geometry_nodes/__init__.pyi +514 -266
  36. bl_operators/image/__init__.pyi +621 -251
  37. bl_operators/mesh/__init__.pyi +376 -150
  38. bl_operators/node/__init__.pyi +1253 -516
  39. bl_operators/object/__init__.pyi +1879 -755
  40. bl_operators/object_align/__init__.pyi +129 -64
  41. bl_operators/object_quick_effects/__init__.pyi +504 -213
  42. bl_operators/object_randomize_transform/__init__.pyi +129 -54
  43. bl_operators/presets/__init__.pyi +3072 -1403
  44. bl_operators/rigidbody/__init__.pyi +376 -150
  45. bl_operators/screen_play_rendered_anim/__init__.pyi +127 -54
  46. bl_operators/sequencer/__init__.pyi +1010 -434
  47. bl_operators/spreadsheet/__init__.pyi +126 -50
  48. bl_operators/userpref/__init__.pyi +3253 -1267
  49. bl_operators/uvcalc_follow_active/__init__.pyi +128 -59
  50. bl_operators/uvcalc_lightmap/__init__.pyi +139 -80
  51. bl_operators/uvcalc_transform/__init__.pyi +297 -159
  52. bl_operators/vertexpaint_dirt/__init__.pyi +128 -59
  53. bl_operators/view3d/__init__.pyi +868 -342
  54. bl_operators/wm/__init__.pyi +5795 -2388
  55. bl_operators/world/__init__.pyi +126 -50
  56. bl_previews_utils/bl_previews_render/__init__.pyi +7 -34
  57. bl_rna_utils/data_path/__init__.pyi +8 -4
  58. bl_text_utils/external_editor/__init__.pyi +1 -4
  59. bl_ui/__init__.pyi +366 -269
  60. bl_ui/anim/__init__.pyi +164 -74
  61. bl_ui/asset_shelf/__init__.pyi +129 -56
  62. bl_ui/generic_ui_list/__init__.pyi +412 -163
  63. bl_ui/node_add_menu/__init__.pyi +171 -94
  64. bl_ui/node_add_menu_compositor/__init__.pyi +2918 -1353
  65. bl_ui/node_add_menu_geometry/__init__.pyi +7789 -3616
  66. bl_ui/node_add_menu_shader/__init__.pyi +1630 -790
  67. bl_ui/node_add_menu_texture/__init__.pyi +1459 -675
  68. bl_ui/properties_animviz/__init__.pyi +2 -16
  69. bl_ui/properties_collection/__init__.pyi +807 -379
  70. bl_ui/properties_constraint/__init__.pyi +10292 -4941
  71. bl_ui/properties_data_armature/__init__.pyi +1615 -753
  72. bl_ui/properties_data_bone/__init__.pyi +1284 -608
  73. bl_ui/properties_data_camera/__init__.pyi +1854 -927
  74. bl_ui/properties_data_curve/__init__.pyi +1927 -937
  75. bl_ui/properties_data_curves/__init__.pyi +806 -375
  76. bl_ui/properties_data_empty/__init__.pyi +257 -125
  77. bl_ui/properties_data_gpencil/__init__.pyi +2376 -1130
  78. bl_ui/properties_data_grease_pencil/__init__.pyi +1898 -894
  79. bl_ui/properties_data_lattice/__init__.pyi +388 -188
  80. bl_ui/properties_data_light/__init__.pyi +1540 -756
  81. bl_ui/properties_data_lightprobe/__init__.pyi +1666 -810
  82. bl_ui/properties_data_mesh/__init__.pyi +2707 -1235
  83. bl_ui/properties_data_metaball/__init__.pyi +644 -308
  84. bl_ui/properties_data_modifier/__init__.pyi +1353 -671
  85. bl_ui/properties_data_pointcloud/__init__.pyi +679 -316
  86. bl_ui/properties_data_shaderfx/__init__.pyi +129 -67
  87. bl_ui/properties_data_speaker/__init__.pyi +644 -316
  88. bl_ui/properties_data_volume/__init__.pyi +1028 -484
  89. bl_ui/properties_freestyle/__init__.pyi +3112 -1619
  90. bl_ui/properties_grease_pencil_common/__init__.pyi +2454 -1123
  91. bl_ui/properties_mask_common/__init__.pyi +1102 -523
  92. bl_ui/properties_material/__init__.pyi +2089 -1009
  93. bl_ui/properties_material_gpencil/__init__.pyi +1348 -635
  94. bl_ui/properties_object/__init__.pyi +1832 -873
  95. bl_ui/properties_output/__init__.pyi +2405 -1173
  96. bl_ui/properties_paint_common/__init__.pyi +416 -386
  97. bl_ui/properties_particle/__init__.pyi +6740 -3346
  98. bl_ui/properties_physics_cloth/__init__.pyi +1822 -907
  99. bl_ui/properties_physics_common/__init__.pyi +135 -98
  100. bl_ui/properties_physics_dynamicpaint/__init__.pyi +2817 -1391
  101. bl_ui/properties_physics_field/__init__.pyi +1282 -627
  102. bl_ui/properties_physics_fluid/__init__.pyi +3614 -1794
  103. bl_ui/properties_physics_geometry_nodes/__init__.pyi +129 -60
  104. bl_ui/properties_physics_rigidbody/__init__.pyi +1026 -515
  105. bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +1665 -811
  106. bl_ui/properties_physics_softbody/__init__.pyi +1922 -967
  107. bl_ui/properties_render/__init__.pyi +6843 -3367
  108. bl_ui/properties_scene/__init__.pyi +1924 -913
  109. bl_ui/properties_texture/__init__.pyi +3371 -1667
  110. bl_ui/properties_view_layer/__init__.pyi +2344 -1107
  111. bl_ui/properties_workspace/__init__.pyi +516 -244
  112. bl_ui/properties_world/__init__.pyi +1284 -630
  113. bl_ui/space_clip/__init__.pyi +10172 -4695
  114. bl_ui/space_console/__init__.pyi +940 -423
  115. bl_ui/space_dopesheet/__init__.pyi +4325 -2013
  116. bl_ui/space_filebrowser/__init__.pyi +4172 -1903
  117. bl_ui/space_graph/__init__.pyi +3107 -1394
  118. bl_ui/space_image/__init__.pyi +9764 -4614
  119. bl_ui/space_info/__init__.pyi +939 -421
  120. bl_ui/space_nla/__init__.pyi +2623 -1183
  121. bl_ui/space_node/__init__.pyi +3995 -1840
  122. bl_ui/space_outliner/__init__.pyi +2203 -991
  123. bl_ui/space_properties/__init__.pyi +386 -165
  124. bl_ui/space_sequencer/__init__.pyi +10809 -4978
  125. bl_ui/space_spreadsheet/__init__.pyi +130 -53
  126. bl_ui/space_statusbar/__init__.pyi +129 -52
  127. bl_ui/space_text/__init__.pyi +2457 -1100
  128. bl_ui/space_time/__init__.pyi +1034 -481
  129. bl_ui/space_toolsystem_common/__init__.pyi +56 -211
  130. bl_ui/space_toolsystem_toolbar/__init__.pyi +153 -882
  131. bl_ui/space_topbar/__init__.pyi +3982 -1805
  132. bl_ui/space_userpref/__init__.pyi +11383 -5290
  133. bl_ui/space_view3d/__init__.pyi +40873 -18532
  134. bl_ui/space_view3d_toolbar/__init__.pyi +12570 -6502
  135. bl_ui/temp_anim_layers/__init__.pyi +130 -62
  136. bl_ui/utils/__init__.pyi +28 -27
  137. bl_ui_utils/bug_report_url/__init__.pyi +1 -4
  138. bl_ui_utils/layout/__init__.pyi +1 -1
  139. blend_render_info/__init__.pyi +3 -10
  140. blf/__init__.pyi +4 -4
  141. bmesh/geometry/__init__.pyi +2 -3
  142. bmesh/ops/__init__.pyi +372 -419
  143. bmesh/types/__init__.pyi +39 -56
  144. bmesh/utils/__init__.pyi +10 -13
  145. bpy/app/__init__.pyi +4 -4
  146. bpy/app/handlers/__init__.pyi +36 -36
  147. bpy/app/icons/__init__.pyi +8 -8
  148. bpy/app/timers/__init__.pyi +10 -10
  149. bpy/app/translations/__init__.pyi +20 -22
  150. bpy/msgbus/__init__.pyi +2 -4
  151. bpy/ops/action/__init__.pyi +316 -394
  152. bpy/ops/anim/__init__.pyi +442 -548
  153. bpy/ops/armature/__init__.pyi +374 -470
  154. bpy/ops/asset/__init__.pyi +152 -184
  155. bpy/ops/bl_pkg/__init__.pyi +221 -272
  156. bpy/ops/boid/__init__.pyi +50 -66
  157. bpy/ops/brush/__init__.pyi +72 -90
  158. bpy/ops/buttons/__init__.pyi +132 -144
  159. bpy/ops/cachefile/__init__.pyi +128 -138
  160. bpy/ops/camera/__init__.pyi +26 -30
  161. bpy/ops/clip/__init__.pyi +777 -964
  162. bpy/ops/cloth/__init__.pyi +12 -14
  163. bpy/ops/collection/__init__.pyi +68 -86
  164. bpy/ops/console/__init__.pyi +158 -200
  165. bpy/ops/constraint/__init__.pyi +178 -214
  166. bpy/ops/curve/__init__.pyi +473 -576
  167. bpy/ops/curves/__init__.pyi +247 -302
  168. bpy/ops/cycles/__init__.pyi +28 -34
  169. bpy/ops/dpaint/__init__.pyi +34 -44
  170. bpy/ops/ed/__init__.pyi +126 -150
  171. bpy/ops/export_anim/__init__.pyi +22 -24
  172. bpy/ops/export_scene/__init__.pyi +302 -336
  173. bpy/ops/file/__init__.pyi +352 -432
  174. bpy/ops/fluid/__init__.pyi +90 -118
  175. bpy/ops/font/__init__.pyi +258 -304
  176. bpy/ops/geometry/__init__.pyi +100 -120
  177. bpy/ops/gizmogroup/__init__.pyi +22 -26
  178. bpy/ops/gpencil/__init__.pyi +1469 -1778
  179. bpy/ops/graph/__init__.pyi +644 -776
  180. bpy/ops/grease_pencil/__init__.pyi +597 -748
  181. bpy/ops/image/__init__.pyi +648 -744
  182. bpy/ops/import_anim/__init__.pyi +30 -32
  183. bpy/ops/import_curve/__init__.pyi +10 -12
  184. bpy/ops/import_scene/__init__.pyi +88 -96
  185. bpy/ops/info/__init__.pyi +60 -74
  186. bpy/ops/lattice/__init__.pyi +64 -80
  187. bpy/ops/marker/__init__.pyi +108 -130
  188. bpy/ops/mask/__init__.pyi +322 -402
  189. bpy/ops/material/__init__.pyi +18 -24
  190. bpy/ops/mball/__init__.pyi +70 -86
  191. bpy/ops/mesh/__init__.pyi +1986 -2322
  192. bpy/ops/nla/__init__.pyi +333 -411
  193. bpy/ops/node/__init__.pyi +886 -1100
  194. bpy/ops/object/__init__.pyi +2585 -3078
  195. bpy/ops/outliner/__init__.pyi +498 -636
  196. bpy/ops/paint/__init__.pyi +565 -680
  197. bpy/ops/paintcurve/__init__.pyi +64 -80
  198. bpy/ops/palette/__init__.pyi +50 -64
  199. bpy/ops/particle/__init__.pyi +267 -340
  200. bpy/ops/pose/__init__.pyi +336 -414
  201. bpy/ops/poselib/__init__.pyi +72 -90
  202. bpy/ops/preferences/__init__.pyi +386 -463
  203. bpy/ops/ptcache/__init__.pyi +46 -60
  204. bpy/ops/render/__init__.pyi +130 -154
  205. bpy/ops/rigidbody/__init__.pyi +102 -128
  206. bpy/ops/scene/__init__.pyi +280 -358
  207. bpy/ops/screen/__init__.pyi +382 -460
  208. bpy/ops/script/__init__.pyi +24 -30
  209. bpy/ops/sculpt/__init__.pyi +458 -532
  210. bpy/ops/sculpt_curves/__init__.pyi +41 -50
  211. bpy/ops/sequencer/__init__.pyi +1066 -1244
  212. bpy/ops/sound/__init__.pyi +216 -230
  213. bpy/ops/spreadsheet/__init__.pyi +30 -38
  214. bpy/ops/surface/__init__.pyi +108 -120
  215. bpy/ops/text/__init__.pyi +390 -476
  216. bpy/ops/text_editor/__init__.pyi +12 -14
  217. bpy/ops/texture/__init__.pyi +26 -34
  218. bpy/ops/transform/__init__.pyi +792 -878
  219. bpy/ops/ui/__init__.pyi +228 -294
  220. bpy/ops/uilist/__init__.pyi +32 -38
  221. bpy/ops/uv/__init__.pyi +602 -704
  222. bpy/ops/view2d/__init__.pyi +156 -184
  223. bpy/ops/view3d/__init__.pyi +582 -718
  224. bpy/ops/wm/__init__.pyi +2683 -2928
  225. bpy/ops/workspace/__init__.pyi +46 -60
  226. bpy/ops/world/__init__.pyi +12 -16
  227. bpy/path/__init__.pyi +179 -75
  228. bpy/props/__init__.pyi +261 -263
  229. bpy/types/__init__.pyi +17058 -26311
  230. bpy/utils/__init__.pyi +247 -179
  231. bpy/utils/previews/__init__.pyi +58 -28
  232. bpy/utils/units/__init__.pyi +20 -20
  233. bpy_extras/anim_utils/__init__.pyi +68 -29
  234. bpy_extras/asset_utils/__init__.pyi +0 -10
  235. bpy_extras/bmesh_utils/__init__.pyi +9 -6
  236. bpy_extras/extensions/junction_module/__init__.pyi +6 -8
  237. bpy_extras/id_map_utils/__init__.pyi +3 -3
  238. bpy_extras/image_utils/__init__.pyi +44 -11
  239. bpy_extras/io_utils/__init__.pyi +116 -41
  240. bpy_extras/keyconfig_utils/__init__.pyi +4 -11
  241. bpy_extras/mesh_utils/__init__.pyi +71 -19
  242. bpy_extras/node_shader_utils/__init__.pyi +52 -288
  243. bpy_extras/node_utils/__init__.pyi +10 -10
  244. bpy_extras/object_utils/__init__.pyi +71 -14
  245. bpy_extras/view3d_utils/__init__.pyi +80 -10
  246. bpy_extras/wm_utils/progress_report/__init__.pyi +15 -38
  247. bpy_restrict_state/__init__.pyi +1 -14
  248. bpy_types/__init__.pyi +4203 -1605
  249. console_python/__init__.pyi +12 -37
  250. console_shell/__init__.pyi +5 -24
  251. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/METADATA +1 -1
  252. fake_bpy_module-20240518.dist-info/RECORD +353 -0
  253. freestyle/chainingiterators/__init__.pyi +14 -44
  254. freestyle/functions/__init__.pyi +7 -33
  255. freestyle/predicates/__init__.pyi +44 -217
  256. freestyle/shaders/__init__.pyi +2 -12
  257. freestyle/types/__init__.pyi +84 -96
  258. freestyle/utils/ContextFunctions/__init__.pyi +2 -2
  259. freestyle/utils/__init__.pyi +6 -18
  260. gpu/matrix/__init__.pyi +6 -8
  261. gpu/state/__init__.pyi +2 -2
  262. gpu/types/__init__.pyi +12 -12
  263. gpu_extras/presets/__init__.pyi +2 -5
  264. graphviz_export/__init__.pyi +4 -9
  265. idprop/types/__init__.pyi +8 -35
  266. imbuf/__init__.pyi +4 -4
  267. imbuf/types/__init__.pyi +0 -2
  268. keyingsets_builtins/__init__.pyi +2692 -997
  269. keyingsets_utils/__init__.pyi +14 -69
  270. mathutils/__init__.pyi +194 -238
  271. mathutils/bvhtree/__init__.pyi +4 -6
  272. mathutils/geometry/__init__.pyi +153 -155
  273. mathutils/kdtree/__init__.pyi +8 -12
  274. mathutils/noise/__init__.pyi +26 -26
  275. nodeitems_builtins/__init__.pyi +5 -30
  276. nodeitems_utils/__init__.pyi +8 -45
  277. rna_info/__init__.pyi +39 -215
  278. rna_keymap_ui/__init__.pyi +6 -29
  279. rna_prop_ui/__init__.pyi +24 -62
  280. rna_xml/__init__.pyi +16 -39
  281. sys_info/__init__.pyi +1 -4
  282. _bpy_internal/freedesktop/py.typed +0 -0
  283. bl_app_override/helpers/py.typed +0 -0
  284. bl_console_utils/autocomplete/complete_calltip/py.typed +0 -0
  285. bl_console_utils/autocomplete/complete_import/py.typed +0 -0
  286. bl_console_utils/autocomplete/complete_namespace/py.typed +0 -0
  287. bl_console_utils/autocomplete/intellisense/py.typed +0 -0
  288. bl_console_utils/autocomplete/py.typed +0 -0
  289. bl_i18n_utils/bl_extract_messages/py.typed +0 -0
  290. bl_i18n_utils/merge_po/py.typed +0 -0
  291. bl_i18n_utils/settings/py.typed +0 -0
  292. bl_i18n_utils/utils/py.typed +0 -0
  293. bl_i18n_utils/utils_cli/py.typed +0 -0
  294. bl_i18n_utils/utils_languages_menu/py.typed +0 -0
  295. bl_i18n_utils/utils_rtl/py.typed +0 -0
  296. bl_keymap_utils/io/py.typed +0 -0
  297. bl_keymap_utils/keymap_from_toolbar/py.typed +0 -0
  298. bl_keymap_utils/keymap_hierarchy/py.typed +0 -0
  299. bl_keymap_utils/platform_helpers/py.typed +0 -0
  300. bl_keymap_utils/versioning/py.typed +0 -0
  301. bl_operators/add_mesh_torus/py.typed +0 -0
  302. bl_operators/anim/py.typed +0 -0
  303. bl_operators/assets/py.typed +0 -0
  304. bl_operators/bmesh/find_adjacent/py.typed +0 -0
  305. bl_operators/bmesh/py.typed +0 -0
  306. bl_operators/clip/py.typed +0 -0
  307. bl_operators/console/py.typed +0 -0
  308. bl_operators/constraint/py.typed +0 -0
  309. bl_operators/file/py.typed +0 -0
  310. bl_operators/freestyle/py.typed +0 -0
  311. bl_operators/geometry_nodes/py.typed +0 -0
  312. bl_operators/image/py.typed +0 -0
  313. bl_operators/mesh/py.typed +0 -0
  314. bl_operators/node/py.typed +0 -0
  315. bl_operators/object/py.typed +0 -0
  316. bl_operators/object_align/py.typed +0 -0
  317. bl_operators/object_quick_effects/py.typed +0 -0
  318. bl_operators/object_randomize_transform/py.typed +0 -0
  319. bl_operators/presets/py.typed +0 -0
  320. bl_operators/rigidbody/py.typed +0 -0
  321. bl_operators/screen_play_rendered_anim/py.typed +0 -0
  322. bl_operators/sequencer/py.typed +0 -0
  323. bl_operators/spreadsheet/py.typed +0 -0
  324. bl_operators/userpref/py.typed +0 -0
  325. bl_operators/uvcalc_follow_active/py.typed +0 -0
  326. bl_operators/uvcalc_lightmap/py.typed +0 -0
  327. bl_operators/uvcalc_transform/py.typed +0 -0
  328. bl_operators/vertexpaint_dirt/py.typed +0 -0
  329. bl_operators/view3d/py.typed +0 -0
  330. bl_operators/wm/py.typed +0 -0
  331. bl_operators/world/py.typed +0 -0
  332. bl_previews_utils/bl_previews_render/py.typed +0 -0
  333. bl_rna_utils/data_path/py.typed +0 -0
  334. bl_text_utils/external_editor/py.typed +0 -0
  335. bl_ui/anim/py.typed +0 -0
  336. bl_ui/asset_shelf/py.typed +0 -0
  337. bl_ui/generic_ui_list/py.typed +0 -0
  338. bl_ui/node_add_menu/py.typed +0 -0
  339. bl_ui/node_add_menu_compositor/py.typed +0 -0
  340. bl_ui/node_add_menu_geometry/py.typed +0 -0
  341. bl_ui/node_add_menu_shader/py.typed +0 -0
  342. bl_ui/node_add_menu_texture/py.typed +0 -0
  343. bl_ui/properties_animviz/py.typed +0 -0
  344. bl_ui/properties_collection/py.typed +0 -0
  345. bl_ui/properties_constraint/py.typed +0 -0
  346. bl_ui/properties_data_armature/py.typed +0 -0
  347. bl_ui/properties_data_bone/py.typed +0 -0
  348. bl_ui/properties_data_camera/py.typed +0 -0
  349. bl_ui/properties_data_curve/py.typed +0 -0
  350. bl_ui/properties_data_curves/py.typed +0 -0
  351. bl_ui/properties_data_empty/py.typed +0 -0
  352. bl_ui/properties_data_gpencil/py.typed +0 -0
  353. bl_ui/properties_data_grease_pencil/py.typed +0 -0
  354. bl_ui/properties_data_lattice/py.typed +0 -0
  355. bl_ui/properties_data_light/py.typed +0 -0
  356. bl_ui/properties_data_lightprobe/py.typed +0 -0
  357. bl_ui/properties_data_mesh/py.typed +0 -0
  358. bl_ui/properties_data_metaball/py.typed +0 -0
  359. bl_ui/properties_data_modifier/py.typed +0 -0
  360. bl_ui/properties_data_pointcloud/py.typed +0 -0
  361. bl_ui/properties_data_shaderfx/py.typed +0 -0
  362. bl_ui/properties_data_speaker/py.typed +0 -0
  363. bl_ui/properties_data_volume/py.typed +0 -0
  364. bl_ui/properties_freestyle/py.typed +0 -0
  365. bl_ui/properties_grease_pencil_common/py.typed +0 -0
  366. bl_ui/properties_mask_common/py.typed +0 -0
  367. bl_ui/properties_material/py.typed +0 -0
  368. bl_ui/properties_material_gpencil/py.typed +0 -0
  369. bl_ui/properties_object/py.typed +0 -0
  370. bl_ui/properties_output/py.typed +0 -0
  371. bl_ui/properties_paint_common/py.typed +0 -0
  372. bl_ui/properties_particle/py.typed +0 -0
  373. bl_ui/properties_physics_cloth/py.typed +0 -0
  374. bl_ui/properties_physics_common/py.typed +0 -0
  375. bl_ui/properties_physics_dynamicpaint/py.typed +0 -0
  376. bl_ui/properties_physics_field/py.typed +0 -0
  377. bl_ui/properties_physics_fluid/py.typed +0 -0
  378. bl_ui/properties_physics_geometry_nodes/py.typed +0 -0
  379. bl_ui/properties_physics_rigidbody/py.typed +0 -0
  380. bl_ui/properties_physics_rigidbody_constraint/py.typed +0 -0
  381. bl_ui/properties_physics_softbody/py.typed +0 -0
  382. bl_ui/properties_render/py.typed +0 -0
  383. bl_ui/properties_scene/py.typed +0 -0
  384. bl_ui/properties_texture/py.typed +0 -0
  385. bl_ui/properties_view_layer/py.typed +0 -0
  386. bl_ui/properties_workspace/py.typed +0 -0
  387. bl_ui/properties_world/py.typed +0 -0
  388. bl_ui/space_clip/py.typed +0 -0
  389. bl_ui/space_console/py.typed +0 -0
  390. bl_ui/space_dopesheet/py.typed +0 -0
  391. bl_ui/space_filebrowser/py.typed +0 -0
  392. bl_ui/space_graph/py.typed +0 -0
  393. bl_ui/space_image/py.typed +0 -0
  394. bl_ui/space_info/py.typed +0 -0
  395. bl_ui/space_nla/py.typed +0 -0
  396. bl_ui/space_node/py.typed +0 -0
  397. bl_ui/space_outliner/py.typed +0 -0
  398. bl_ui/space_properties/py.typed +0 -0
  399. bl_ui/space_sequencer/py.typed +0 -0
  400. bl_ui/space_spreadsheet/py.typed +0 -0
  401. bl_ui/space_statusbar/py.typed +0 -0
  402. bl_ui/space_text/py.typed +0 -0
  403. bl_ui/space_time/py.typed +0 -0
  404. bl_ui/space_toolsystem_common/py.typed +0 -0
  405. bl_ui/space_toolsystem_toolbar/py.typed +0 -0
  406. bl_ui/space_topbar/py.typed +0 -0
  407. bl_ui/space_userpref/py.typed +0 -0
  408. bl_ui/space_view3d/py.typed +0 -0
  409. bl_ui/space_view3d_toolbar/py.typed +0 -0
  410. bl_ui/temp_anim_layers/py.typed +0 -0
  411. bl_ui/utils/py.typed +0 -0
  412. bl_ui_utils/bug_report_url/py.typed +0 -0
  413. bl_ui_utils/layout/py.typed +0 -0
  414. bmesh/geometry/py.typed +0 -0
  415. bmesh/ops/py.typed +0 -0
  416. bmesh/types/py.typed +0 -0
  417. bmesh/utils/py.typed +0 -0
  418. bpy/app/handlers/py.typed +0 -0
  419. bpy/app/icons/py.typed +0 -0
  420. bpy/app/py.typed +0 -0
  421. bpy/app/timers/py.typed +0 -0
  422. bpy/app/translations/py.typed +0 -0
  423. bpy/msgbus/py.typed +0 -0
  424. bpy/ops/action/py.typed +0 -0
  425. bpy/ops/anim/py.typed +0 -0
  426. bpy/ops/armature/py.typed +0 -0
  427. bpy/ops/asset/py.typed +0 -0
  428. bpy/ops/bl_pkg/py.typed +0 -0
  429. bpy/ops/boid/py.typed +0 -0
  430. bpy/ops/brush/py.typed +0 -0
  431. bpy/ops/buttons/py.typed +0 -0
  432. bpy/ops/cachefile/py.typed +0 -0
  433. bpy/ops/camera/py.typed +0 -0
  434. bpy/ops/clip/py.typed +0 -0
  435. bpy/ops/cloth/py.typed +0 -0
  436. bpy/ops/collection/py.typed +0 -0
  437. bpy/ops/console/py.typed +0 -0
  438. bpy/ops/constraint/py.typed +0 -0
  439. bpy/ops/curve/py.typed +0 -0
  440. bpy/ops/curves/py.typed +0 -0
  441. bpy/ops/cycles/py.typed +0 -0
  442. bpy/ops/dpaint/py.typed +0 -0
  443. bpy/ops/ed/py.typed +0 -0
  444. bpy/ops/export_anim/py.typed +0 -0
  445. bpy/ops/export_scene/py.typed +0 -0
  446. bpy/ops/file/py.typed +0 -0
  447. bpy/ops/fluid/py.typed +0 -0
  448. bpy/ops/font/py.typed +0 -0
  449. bpy/ops/geometry/py.typed +0 -0
  450. bpy/ops/gizmogroup/py.typed +0 -0
  451. bpy/ops/gpencil/py.typed +0 -0
  452. bpy/ops/graph/py.typed +0 -0
  453. bpy/ops/grease_pencil/py.typed +0 -0
  454. bpy/ops/image/py.typed +0 -0
  455. bpy/ops/import_anim/py.typed +0 -0
  456. bpy/ops/import_curve/py.typed +0 -0
  457. bpy/ops/import_scene/py.typed +0 -0
  458. bpy/ops/info/py.typed +0 -0
  459. bpy/ops/lattice/py.typed +0 -0
  460. bpy/ops/marker/py.typed +0 -0
  461. bpy/ops/mask/py.typed +0 -0
  462. bpy/ops/material/py.typed +0 -0
  463. bpy/ops/mball/py.typed +0 -0
  464. bpy/ops/mesh/py.typed +0 -0
  465. bpy/ops/nla/py.typed +0 -0
  466. bpy/ops/node/py.typed +0 -0
  467. bpy/ops/object/py.typed +0 -0
  468. bpy/ops/outliner/py.typed +0 -0
  469. bpy/ops/paint/py.typed +0 -0
  470. bpy/ops/paintcurve/py.typed +0 -0
  471. bpy/ops/palette/py.typed +0 -0
  472. bpy/ops/particle/py.typed +0 -0
  473. bpy/ops/pose/py.typed +0 -0
  474. bpy/ops/poselib/py.typed +0 -0
  475. bpy/ops/preferences/py.typed +0 -0
  476. bpy/ops/ptcache/py.typed +0 -0
  477. bpy/ops/py.typed +0 -0
  478. bpy/ops/render/py.typed +0 -0
  479. bpy/ops/rigidbody/py.typed +0 -0
  480. bpy/ops/scene/py.typed +0 -0
  481. bpy/ops/screen/py.typed +0 -0
  482. bpy/ops/script/py.typed +0 -0
  483. bpy/ops/sculpt/py.typed +0 -0
  484. bpy/ops/sculpt_curves/py.typed +0 -0
  485. bpy/ops/sequencer/py.typed +0 -0
  486. bpy/ops/sound/py.typed +0 -0
  487. bpy/ops/spreadsheet/py.typed +0 -0
  488. bpy/ops/surface/py.typed +0 -0
  489. bpy/ops/text/py.typed +0 -0
  490. bpy/ops/text_editor/py.typed +0 -0
  491. bpy/ops/texture/py.typed +0 -0
  492. bpy/ops/transform/py.typed +0 -0
  493. bpy/ops/ui/py.typed +0 -0
  494. bpy/ops/uilist/py.typed +0 -0
  495. bpy/ops/uv/py.typed +0 -0
  496. bpy/ops/view2d/py.typed +0 -0
  497. bpy/ops/view3d/py.typed +0 -0
  498. bpy/ops/wm/py.typed +0 -0
  499. bpy/ops/workspace/py.typed +0 -0
  500. bpy/ops/world/py.typed +0 -0
  501. bpy/path/py.typed +0 -0
  502. bpy/props/py.typed +0 -0
  503. bpy/types/py.typed +0 -0
  504. bpy/utils/previews/py.typed +0 -0
  505. bpy/utils/py.typed +0 -0
  506. bpy/utils/units/py.typed +0 -0
  507. bpy_extras/anim_utils/py.typed +0 -0
  508. bpy_extras/asset_utils/py.typed +0 -0
  509. bpy_extras/bmesh_utils/py.typed +0 -0
  510. bpy_extras/extensions/junction_module/py.typed +0 -0
  511. bpy_extras/extensions/py.typed +0 -0
  512. bpy_extras/id_map_utils/py.typed +0 -0
  513. bpy_extras/image_utils/py.typed +0 -0
  514. bpy_extras/io_utils/py.typed +0 -0
  515. bpy_extras/keyconfig_utils/py.typed +0 -0
  516. bpy_extras/mesh_utils/py.typed +0 -0
  517. bpy_extras/node_shader_utils/py.typed +0 -0
  518. bpy_extras/node_utils/py.typed +0 -0
  519. bpy_extras/object_utils/py.typed +0 -0
  520. bpy_extras/view3d_utils/py.typed +0 -0
  521. bpy_extras/wm_utils/progress_report/py.typed +0 -0
  522. bpy_extras/wm_utils/py.typed +0 -0
  523. fake_bpy_module-20240516.dist-info/RECORD +0 -618
  524. freestyle/chainingiterators/py.typed +0 -0
  525. freestyle/functions/py.typed +0 -0
  526. freestyle/predicates/py.typed +0 -0
  527. freestyle/shaders/py.typed +0 -0
  528. freestyle/types/py.typed +0 -0
  529. freestyle/utils/ContextFunctions/py.typed +0 -0
  530. freestyle/utils/py.typed +0 -0
  531. gpu/capabilities/py.typed +0 -0
  532. gpu/matrix/py.typed +0 -0
  533. gpu/platform/py.typed +0 -0
  534. gpu/select/py.typed +0 -0
  535. gpu/shader/py.typed +0 -0
  536. gpu/state/py.typed +0 -0
  537. gpu/texture/py.typed +0 -0
  538. gpu/types/py.typed +0 -0
  539. gpu_extras/batch/py.typed +0 -0
  540. gpu_extras/presets/py.typed +0 -0
  541. idprop/types/py.typed +0 -0
  542. imbuf/types/py.typed +0 -0
  543. mathutils/bvhtree/py.typed +0 -0
  544. mathutils/geometry/py.typed +0 -0
  545. mathutils/interpolate/py.typed +0 -0
  546. mathutils/kdtree/py.typed +0 -0
  547. mathutils/noise/py.typed +0 -0
  548. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/WHEEL +0 -0
  549. {fake_bpy_module-20240516.dist-info → fake_bpy_module-20240518.dist-info}/top_level.txt +0 -0
@@ -1,63 +1,55 @@
1
1
  import typing
2
+ import bpy.types
2
3
  import bpy_types
3
4
 
4
5
  GenericType = typing.TypeVar("GenericType")
5
6
 
6
7
  class PHYSICS_PT_rigidbody_panel:
7
- """ """
8
-
9
8
  bl_context: typing.Any
10
- """ """
11
-
12
9
  bl_region_type: typing.Any
13
- """ """
14
-
15
10
  bl_space_type: typing.Any
16
- """ """
17
11
 
18
12
  class PHYSICS_PT_rigid_body(
19
13
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
20
14
  ):
21
- """ """
22
-
23
15
  COMPAT_ENGINES: typing.Any
24
- """ """
25
-
26
16
  bl_context: typing.Any
27
- """ """
28
-
29
17
  bl_label: typing.Any
30
- """ """
31
-
32
18
  bl_region_type: typing.Any
33
- """ """
34
-
35
19
  bl_rna: typing.Any
36
- """ """
37
-
38
20
  bl_space_type: typing.Any
39
- """ """
40
-
41
21
  id_data: typing.Any
42
- """ """
43
22
 
44
23
  def append(self, draw_func):
45
- """
24
+ """Append a draw function to this menu,
25
+ takes the same arguments as the menus draw function
46
26
 
47
- :param draw_func:
27
+ :param draw_func:
48
28
  """
49
29
  ...
50
30
 
51
- def as_pointer(self):
52
- """ """
31
+ def as_pointer(self) -> int:
32
+ """Returns the memory address which holds a pointer to Blender's internal data
33
+
34
+ :return: int (memory address).
35
+ :rtype: int
36
+ """
53
37
  ...
54
38
 
55
- def bl_rna_get_subclass(self):
56
- """ """
39
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
40
+ """
41
+
42
+ :return: The RNA type or default when not found.
43
+ :rtype: bpy.types.Struct
44
+ """
57
45
  ...
58
46
 
59
- def bl_rna_get_subclass_py(self):
60
- """ """
47
+ def bl_rna_get_subclass_py(self) -> typing.Any:
48
+ """
49
+
50
+ :return: The class or default when not found.
51
+ :rtype: typing.Any
52
+ """
61
53
  ...
62
54
 
63
55
  def draw(self, context):
@@ -67,72 +59,126 @@ class PHYSICS_PT_rigid_body(
67
59
  """
68
60
  ...
69
61
 
70
- def driver_add(self):
71
- """ """
62
+ def driver_add(self) -> bpy.types.FCurve:
63
+ """Adds driver(s) to the given property
64
+
65
+ :return: The driver(s) added.
66
+ :rtype: bpy.types.FCurve
67
+ """
72
68
  ...
73
69
 
74
- def driver_remove(self):
75
- """ """
70
+ def driver_remove(self) -> bool:
71
+ """Remove driver(s) from the given property
72
+
73
+ :return: Success of driver removal.
74
+ :rtype: bool
75
+ """
76
76
  ...
77
77
 
78
78
  def get(self):
79
- """ """
79
+ """Returns the value of the custom property assigned to key or default
80
+ when not found (matches Python's dictionary function of the same name).
81
+
82
+ """
80
83
  ...
81
84
 
82
85
  def id_properties_clear(self):
83
- """ """
86
+ """
87
+
88
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
89
+ """
84
90
  ...
85
91
 
86
92
  def id_properties_ensure(self):
87
- """ """
93
+ """
94
+
95
+ :return: the parent group for an RNA struct's custom IDProperties.
96
+ """
88
97
  ...
89
98
 
90
99
  def id_properties_ui(self):
91
- """ """
92
- ...
100
+ """
93
101
 
94
- def is_extended(self):
95
- """ """
102
+ :return: Return an object used to manage an IDProperty's UI data.
103
+ """
96
104
  ...
97
105
 
98
- def is_property_hidden(self):
99
- """ """
106
+ def is_extended(self): ...
107
+ def is_property_hidden(self) -> bool:
108
+ """Check if a property is hidden.
109
+
110
+ :return: True when the property is hidden.
111
+ :rtype: bool
112
+ """
100
113
  ...
101
114
 
102
- def is_property_overridable_library(self):
103
- """ """
115
+ def is_property_overridable_library(self) -> bool:
116
+ """Check if a property is overridable.
117
+
118
+ :return: True when the property is overridable.
119
+ :rtype: bool
120
+ """
104
121
  ...
105
122
 
106
- def is_property_readonly(self):
107
- """ """
123
+ def is_property_readonly(self) -> bool:
124
+ """Check if a property is readonly.
125
+
126
+ :return: True when the property is readonly (not writable).
127
+ :rtype: bool
128
+ """
108
129
  ...
109
130
 
110
- def is_property_set(self):
111
- """ """
131
+ def is_property_set(self) -> bool:
132
+ """Check if a property is set, use for testing operator properties.
133
+
134
+ :return: True when the property has been set.
135
+ :rtype: bool
136
+ """
112
137
  ...
113
138
 
114
139
  def items(self):
115
- """ """
140
+ """Returns the items of this objects custom properties (matches Python's
141
+ dictionary function of the same name).
142
+
143
+ :return: custom property key, value pairs.
144
+ """
116
145
  ...
117
146
 
118
- def keyframe_delete(self):
119
- """ """
147
+ def keyframe_delete(self) -> bool:
148
+ """Remove a keyframe from this properties fcurve.
149
+
150
+ :return: Success of keyframe deletion.
151
+ :rtype: bool
152
+ """
120
153
  ...
121
154
 
122
- def keyframe_insert(self):
123
- """ """
155
+ def keyframe_insert(self) -> bool:
156
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
157
+
158
+ :return: Success of keyframe insertion.
159
+ :rtype: bool
160
+ """
124
161
  ...
125
162
 
126
163
  def keys(self):
127
- """ """
164
+ """Returns the keys of this objects custom properties (matches Python's
165
+ dictionary function of the same name).
166
+
167
+ :return: custom property keys.
168
+ """
128
169
  ...
129
170
 
130
- def path_from_id(self):
131
- """ """
171
+ def path_from_id(self) -> str:
172
+ """Returns the data path from the ID to this object (string).
173
+
174
+ :return: The path from `bpy.types.bpy_struct.id_data`
175
+ to this struct and property (when given).
176
+ :rtype: str
177
+ """
132
178
  ...
133
179
 
134
180
  def path_resolve(self):
135
- """ """
181
+ """Returns the property from the path, raise an exception when not found."""
136
182
  ...
137
183
 
138
184
  def poll(self, context):
@@ -143,85 +189,97 @@ class PHYSICS_PT_rigid_body(
143
189
  ...
144
190
 
145
191
  def pop(self):
146
- """ """
192
+ """Remove and return the value of the custom property assigned to key or default
193
+ when not found (matches Python's dictionary function of the same name).
194
+
195
+ """
147
196
  ...
148
197
 
149
198
  def prepend(self, draw_func):
150
- """
199
+ """Prepend a draw function to this menu, takes the same arguments as
200
+ the menus draw function
151
201
 
152
- :param draw_func:
202
+ :param draw_func:
153
203
  """
154
204
  ...
155
205
 
156
- def property_overridable_library_set(self):
157
- """ """
206
+ def property_overridable_library_set(self) -> bool:
207
+ """Define a property as overridable or not (only for custom properties!).
208
+
209
+ :return: True when the overridable status of the property was successfully set.
210
+ :rtype: bool
211
+ """
158
212
  ...
159
213
 
160
214
  def property_unset(self):
161
- """ """
215
+ """Unset a property, will use default value afterward."""
162
216
  ...
163
217
 
164
218
  def remove(self, draw_func):
165
- """
219
+ """Remove a draw function that has been added to this menu
166
220
 
167
221
  :param draw_func:
168
222
  """
169
223
  ...
170
224
 
171
225
  def type_recast(self):
172
- """ """
226
+ """Return a new instance, this is needed because types
227
+ such as textures can be changed at runtime.
228
+
229
+ :return: a new instance of this object with the type initialized again.
230
+ """
173
231
  ...
174
232
 
175
233
  def values(self):
176
- """ """
234
+ """Returns the values of this objects custom properties (matches Python's
235
+ dictionary function of the same name).
236
+
237
+ :return: custom property values.
238
+ """
177
239
  ...
178
240
 
179
241
  class PHYSICS_PT_rigid_body_collisions(
180
242
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
181
243
  ):
182
- """ """
183
-
184
244
  COMPAT_ENGINES: typing.Any
185
- """ """
186
-
187
245
  bl_context: typing.Any
188
- """ """
189
-
190
246
  bl_label: typing.Any
191
- """ """
192
-
193
247
  bl_parent_id: typing.Any
194
- """ """
195
-
196
248
  bl_region_type: typing.Any
197
- """ """
198
-
199
249
  bl_rna: typing.Any
200
- """ """
201
-
202
250
  bl_space_type: typing.Any
203
- """ """
204
-
205
251
  id_data: typing.Any
206
- """ """
207
252
 
208
253
  def append(self, draw_func):
209
- """
254
+ """Append a draw function to this menu,
255
+ takes the same arguments as the menus draw function
210
256
 
211
- :param draw_func:
257
+ :param draw_func:
212
258
  """
213
259
  ...
214
260
 
215
- def as_pointer(self):
216
- """ """
261
+ def as_pointer(self) -> int:
262
+ """Returns the memory address which holds a pointer to Blender's internal data
263
+
264
+ :return: int (memory address).
265
+ :rtype: int
266
+ """
217
267
  ...
218
268
 
219
- def bl_rna_get_subclass(self):
220
- """ """
269
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
270
+ """
271
+
272
+ :return: The RNA type or default when not found.
273
+ :rtype: bpy.types.Struct
274
+ """
221
275
  ...
222
276
 
223
- def bl_rna_get_subclass_py(self):
224
- """ """
277
+ def bl_rna_get_subclass_py(self) -> typing.Any:
278
+ """
279
+
280
+ :return: The class or default when not found.
281
+ :rtype: typing.Any
282
+ """
225
283
  ...
226
284
 
227
285
  def draw(self, context):
@@ -231,72 +289,126 @@ class PHYSICS_PT_rigid_body_collisions(
231
289
  """
232
290
  ...
233
291
 
234
- def driver_add(self):
235
- """ """
292
+ def driver_add(self) -> bpy.types.FCurve:
293
+ """Adds driver(s) to the given property
294
+
295
+ :return: The driver(s) added.
296
+ :rtype: bpy.types.FCurve
297
+ """
236
298
  ...
237
299
 
238
- def driver_remove(self):
239
- """ """
300
+ def driver_remove(self) -> bool:
301
+ """Remove driver(s) from the given property
302
+
303
+ :return: Success of driver removal.
304
+ :rtype: bool
305
+ """
240
306
  ...
241
307
 
242
308
  def get(self):
243
- """ """
309
+ """Returns the value of the custom property assigned to key or default
310
+ when not found (matches Python's dictionary function of the same name).
311
+
312
+ """
244
313
  ...
245
314
 
246
315
  def id_properties_clear(self):
247
- """ """
316
+ """
317
+
318
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
319
+ """
248
320
  ...
249
321
 
250
322
  def id_properties_ensure(self):
251
- """ """
323
+ """
324
+
325
+ :return: the parent group for an RNA struct's custom IDProperties.
326
+ """
252
327
  ...
253
328
 
254
329
  def id_properties_ui(self):
255
- """ """
256
- ...
330
+ """
257
331
 
258
- def is_extended(self):
259
- """ """
332
+ :return: Return an object used to manage an IDProperty's UI data.
333
+ """
260
334
  ...
261
335
 
262
- def is_property_hidden(self):
263
- """ """
336
+ def is_extended(self): ...
337
+ def is_property_hidden(self) -> bool:
338
+ """Check if a property is hidden.
339
+
340
+ :return: True when the property is hidden.
341
+ :rtype: bool
342
+ """
264
343
  ...
265
344
 
266
- def is_property_overridable_library(self):
267
- """ """
345
+ def is_property_overridable_library(self) -> bool:
346
+ """Check if a property is overridable.
347
+
348
+ :return: True when the property is overridable.
349
+ :rtype: bool
350
+ """
268
351
  ...
269
352
 
270
- def is_property_readonly(self):
271
- """ """
353
+ def is_property_readonly(self) -> bool:
354
+ """Check if a property is readonly.
355
+
356
+ :return: True when the property is readonly (not writable).
357
+ :rtype: bool
358
+ """
272
359
  ...
273
360
 
274
- def is_property_set(self):
275
- """ """
361
+ def is_property_set(self) -> bool:
362
+ """Check if a property is set, use for testing operator properties.
363
+
364
+ :return: True when the property has been set.
365
+ :rtype: bool
366
+ """
276
367
  ...
277
368
 
278
369
  def items(self):
279
- """ """
370
+ """Returns the items of this objects custom properties (matches Python's
371
+ dictionary function of the same name).
372
+
373
+ :return: custom property key, value pairs.
374
+ """
280
375
  ...
281
376
 
282
- def keyframe_delete(self):
283
- """ """
377
+ def keyframe_delete(self) -> bool:
378
+ """Remove a keyframe from this properties fcurve.
379
+
380
+ :return: Success of keyframe deletion.
381
+ :rtype: bool
382
+ """
284
383
  ...
285
384
 
286
- def keyframe_insert(self):
287
- """ """
385
+ def keyframe_insert(self) -> bool:
386
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
387
+
388
+ :return: Success of keyframe insertion.
389
+ :rtype: bool
390
+ """
288
391
  ...
289
392
 
290
393
  def keys(self):
291
- """ """
394
+ """Returns the keys of this objects custom properties (matches Python's
395
+ dictionary function of the same name).
396
+
397
+ :return: custom property keys.
398
+ """
292
399
  ...
293
400
 
294
- def path_from_id(self):
295
- """ """
401
+ def path_from_id(self) -> str:
402
+ """Returns the data path from the ID to this object (string).
403
+
404
+ :return: The path from `bpy.types.bpy_struct.id_data`
405
+ to this struct and property (when given).
406
+ :rtype: str
407
+ """
296
408
  ...
297
409
 
298
410
  def path_resolve(self):
299
- """ """
411
+ """Returns the property from the path, raise an exception when not found."""
300
412
  ...
301
413
 
302
414
  def poll(self, context):
@@ -307,88 +419,98 @@ class PHYSICS_PT_rigid_body_collisions(
307
419
  ...
308
420
 
309
421
  def pop(self):
310
- """ """
422
+ """Remove and return the value of the custom property assigned to key or default
423
+ when not found (matches Python's dictionary function of the same name).
424
+
425
+ """
311
426
  ...
312
427
 
313
428
  def prepend(self, draw_func):
314
- """
429
+ """Prepend a draw function to this menu, takes the same arguments as
430
+ the menus draw function
315
431
 
316
- :param draw_func:
432
+ :param draw_func:
317
433
  """
318
434
  ...
319
435
 
320
- def property_overridable_library_set(self):
321
- """ """
436
+ def property_overridable_library_set(self) -> bool:
437
+ """Define a property as overridable or not (only for custom properties!).
438
+
439
+ :return: True when the overridable status of the property was successfully set.
440
+ :rtype: bool
441
+ """
322
442
  ...
323
443
 
324
444
  def property_unset(self):
325
- """ """
445
+ """Unset a property, will use default value afterward."""
326
446
  ...
327
447
 
328
448
  def remove(self, draw_func):
329
- """
449
+ """Remove a draw function that has been added to this menu
330
450
 
331
451
  :param draw_func:
332
452
  """
333
453
  ...
334
454
 
335
455
  def type_recast(self):
336
- """ """
456
+ """Return a new instance, this is needed because types
457
+ such as textures can be changed at runtime.
458
+
459
+ :return: a new instance of this object with the type initialized again.
460
+ """
337
461
  ...
338
462
 
339
463
  def values(self):
340
- """ """
464
+ """Returns the values of this objects custom properties (matches Python's
465
+ dictionary function of the same name).
466
+
467
+ :return: custom property values.
468
+ """
341
469
  ...
342
470
 
343
471
  class PHYSICS_PT_rigid_body_collisions_collections(
344
472
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
345
473
  ):
346
- """ """
347
-
348
474
  COMPAT_ENGINES: typing.Any
349
- """ """
350
-
351
475
  bl_context: typing.Any
352
- """ """
353
-
354
476
  bl_label: typing.Any
355
- """ """
356
-
357
477
  bl_options: typing.Any
358
- """ """
359
-
360
478
  bl_parent_id: typing.Any
361
- """ """
362
-
363
479
  bl_region_type: typing.Any
364
- """ """
365
-
366
480
  bl_rna: typing.Any
367
- """ """
368
-
369
481
  bl_space_type: typing.Any
370
- """ """
371
-
372
482
  id_data: typing.Any
373
- """ """
374
483
 
375
484
  def append(self, draw_func):
376
- """
485
+ """Append a draw function to this menu,
486
+ takes the same arguments as the menus draw function
377
487
 
378
- :param draw_func:
488
+ :param draw_func:
379
489
  """
380
490
  ...
381
491
 
382
- def as_pointer(self):
383
- """ """
492
+ def as_pointer(self) -> int:
493
+ """Returns the memory address which holds a pointer to Blender's internal data
494
+
495
+ :return: int (memory address).
496
+ :rtype: int
497
+ """
384
498
  ...
385
499
 
386
- def bl_rna_get_subclass(self):
387
- """ """
500
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
501
+ """
502
+
503
+ :return: The RNA type or default when not found.
504
+ :rtype: bpy.types.Struct
505
+ """
388
506
  ...
389
507
 
390
- def bl_rna_get_subclass_py(self):
391
- """ """
508
+ def bl_rna_get_subclass_py(self) -> typing.Any:
509
+ """
510
+
511
+ :return: The class or default when not found.
512
+ :rtype: typing.Any
513
+ """
392
514
  ...
393
515
 
394
516
  def draw(self, context):
@@ -398,72 +520,126 @@ class PHYSICS_PT_rigid_body_collisions_collections(
398
520
  """
399
521
  ...
400
522
 
401
- def driver_add(self):
402
- """ """
523
+ def driver_add(self) -> bpy.types.FCurve:
524
+ """Adds driver(s) to the given property
525
+
526
+ :return: The driver(s) added.
527
+ :rtype: bpy.types.FCurve
528
+ """
403
529
  ...
404
530
 
405
- def driver_remove(self):
406
- """ """
531
+ def driver_remove(self) -> bool:
532
+ """Remove driver(s) from the given property
533
+
534
+ :return: Success of driver removal.
535
+ :rtype: bool
536
+ """
407
537
  ...
408
538
 
409
539
  def get(self):
410
- """ """
540
+ """Returns the value of the custom property assigned to key or default
541
+ when not found (matches Python's dictionary function of the same name).
542
+
543
+ """
411
544
  ...
412
545
 
413
546
  def id_properties_clear(self):
414
- """ """
547
+ """
548
+
549
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
550
+ """
415
551
  ...
416
552
 
417
553
  def id_properties_ensure(self):
418
- """ """
554
+ """
555
+
556
+ :return: the parent group for an RNA struct's custom IDProperties.
557
+ """
419
558
  ...
420
559
 
421
560
  def id_properties_ui(self):
422
- """ """
423
- ...
561
+ """
424
562
 
425
- def is_extended(self):
426
- """ """
563
+ :return: Return an object used to manage an IDProperty's UI data.
564
+ """
427
565
  ...
428
566
 
429
- def is_property_hidden(self):
430
- """ """
567
+ def is_extended(self): ...
568
+ def is_property_hidden(self) -> bool:
569
+ """Check if a property is hidden.
570
+
571
+ :return: True when the property is hidden.
572
+ :rtype: bool
573
+ """
431
574
  ...
432
575
 
433
- def is_property_overridable_library(self):
434
- """ """
576
+ def is_property_overridable_library(self) -> bool:
577
+ """Check if a property is overridable.
578
+
579
+ :return: True when the property is overridable.
580
+ :rtype: bool
581
+ """
435
582
  ...
436
583
 
437
- def is_property_readonly(self):
438
- """ """
584
+ def is_property_readonly(self) -> bool:
585
+ """Check if a property is readonly.
586
+
587
+ :return: True when the property is readonly (not writable).
588
+ :rtype: bool
589
+ """
439
590
  ...
440
591
 
441
- def is_property_set(self):
442
- """ """
592
+ def is_property_set(self) -> bool:
593
+ """Check if a property is set, use for testing operator properties.
594
+
595
+ :return: True when the property has been set.
596
+ :rtype: bool
597
+ """
443
598
  ...
444
599
 
445
600
  def items(self):
446
- """ """
601
+ """Returns the items of this objects custom properties (matches Python's
602
+ dictionary function of the same name).
603
+
604
+ :return: custom property key, value pairs.
605
+ """
447
606
  ...
448
607
 
449
- def keyframe_delete(self):
450
- """ """
608
+ def keyframe_delete(self) -> bool:
609
+ """Remove a keyframe from this properties fcurve.
610
+
611
+ :return: Success of keyframe deletion.
612
+ :rtype: bool
613
+ """
451
614
  ...
452
615
 
453
- def keyframe_insert(self):
454
- """ """
616
+ def keyframe_insert(self) -> bool:
617
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
618
+
619
+ :return: Success of keyframe insertion.
620
+ :rtype: bool
621
+ """
455
622
  ...
456
623
 
457
624
  def keys(self):
458
- """ """
625
+ """Returns the keys of this objects custom properties (matches Python's
626
+ dictionary function of the same name).
627
+
628
+ :return: custom property keys.
629
+ """
459
630
  ...
460
631
 
461
- def path_from_id(self):
462
- """ """
632
+ def path_from_id(self) -> str:
633
+ """Returns the data path from the ID to this object (string).
634
+
635
+ :return: The path from `bpy.types.bpy_struct.id_data`
636
+ to this struct and property (when given).
637
+ :rtype: str
638
+ """
463
639
  ...
464
640
 
465
641
  def path_resolve(self):
466
- """ """
642
+ """Returns the property from the path, raise an exception when not found."""
467
643
  ...
468
644
 
469
645
  def poll(self, context):
@@ -474,88 +650,98 @@ class PHYSICS_PT_rigid_body_collisions_collections(
474
650
  ...
475
651
 
476
652
  def pop(self):
477
- """ """
653
+ """Remove and return the value of the custom property assigned to key or default
654
+ when not found (matches Python's dictionary function of the same name).
655
+
656
+ """
478
657
  ...
479
658
 
480
659
  def prepend(self, draw_func):
481
- """
660
+ """Prepend a draw function to this menu, takes the same arguments as
661
+ the menus draw function
482
662
 
483
- :param draw_func:
663
+ :param draw_func:
484
664
  """
485
665
  ...
486
666
 
487
- def property_overridable_library_set(self):
488
- """ """
667
+ def property_overridable_library_set(self) -> bool:
668
+ """Define a property as overridable or not (only for custom properties!).
669
+
670
+ :return: True when the overridable status of the property was successfully set.
671
+ :rtype: bool
672
+ """
489
673
  ...
490
674
 
491
675
  def property_unset(self):
492
- """ """
676
+ """Unset a property, will use default value afterward."""
493
677
  ...
494
678
 
495
679
  def remove(self, draw_func):
496
- """
680
+ """Remove a draw function that has been added to this menu
497
681
 
498
682
  :param draw_func:
499
683
  """
500
684
  ...
501
685
 
502
686
  def type_recast(self):
503
- """ """
687
+ """Return a new instance, this is needed because types
688
+ such as textures can be changed at runtime.
689
+
690
+ :return: a new instance of this object with the type initialized again.
691
+ """
504
692
  ...
505
693
 
506
694
  def values(self):
507
- """ """
695
+ """Returns the values of this objects custom properties (matches Python's
696
+ dictionary function of the same name).
697
+
698
+ :return: custom property values.
699
+ """
508
700
  ...
509
701
 
510
702
  class PHYSICS_PT_rigid_body_collisions_sensitivity(
511
703
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
512
704
  ):
513
- """ """
514
-
515
705
  COMPAT_ENGINES: typing.Any
516
- """ """
517
-
518
706
  bl_context: typing.Any
519
- """ """
520
-
521
707
  bl_label: typing.Any
522
- """ """
523
-
524
708
  bl_options: typing.Any
525
- """ """
526
-
527
709
  bl_parent_id: typing.Any
528
- """ """
529
-
530
710
  bl_region_type: typing.Any
531
- """ """
532
-
533
711
  bl_rna: typing.Any
534
- """ """
535
-
536
712
  bl_space_type: typing.Any
537
- """ """
538
-
539
713
  id_data: typing.Any
540
- """ """
541
714
 
542
715
  def append(self, draw_func):
543
- """
716
+ """Append a draw function to this menu,
717
+ takes the same arguments as the menus draw function
544
718
 
545
- :param draw_func:
719
+ :param draw_func:
546
720
  """
547
721
  ...
548
722
 
549
- def as_pointer(self):
550
- """ """
723
+ def as_pointer(self) -> int:
724
+ """Returns the memory address which holds a pointer to Blender's internal data
725
+
726
+ :return: int (memory address).
727
+ :rtype: int
728
+ """
551
729
  ...
552
730
 
553
- def bl_rna_get_subclass(self):
554
- """ """
731
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
732
+ """
733
+
734
+ :return: The RNA type or default when not found.
735
+ :rtype: bpy.types.Struct
736
+ """
555
737
  ...
556
738
 
557
- def bl_rna_get_subclass_py(self):
558
- """ """
739
+ def bl_rna_get_subclass_py(self) -> typing.Any:
740
+ """
741
+
742
+ :return: The class or default when not found.
743
+ :rtype: typing.Any
744
+ """
559
745
  ...
560
746
 
561
747
  def draw(self, context):
@@ -565,72 +751,126 @@ class PHYSICS_PT_rigid_body_collisions_sensitivity(
565
751
  """
566
752
  ...
567
753
 
568
- def driver_add(self):
569
- """ """
754
+ def driver_add(self) -> bpy.types.FCurve:
755
+ """Adds driver(s) to the given property
756
+
757
+ :return: The driver(s) added.
758
+ :rtype: bpy.types.FCurve
759
+ """
570
760
  ...
571
761
 
572
- def driver_remove(self):
573
- """ """
762
+ def driver_remove(self) -> bool:
763
+ """Remove driver(s) from the given property
764
+
765
+ :return: Success of driver removal.
766
+ :rtype: bool
767
+ """
574
768
  ...
575
769
 
576
770
  def get(self):
577
- """ """
771
+ """Returns the value of the custom property assigned to key or default
772
+ when not found (matches Python's dictionary function of the same name).
773
+
774
+ """
578
775
  ...
579
776
 
580
777
  def id_properties_clear(self):
581
- """ """
778
+ """
779
+
780
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
781
+ """
582
782
  ...
583
783
 
584
784
  def id_properties_ensure(self):
585
- """ """
785
+ """
786
+
787
+ :return: the parent group for an RNA struct's custom IDProperties.
788
+ """
586
789
  ...
587
790
 
588
791
  def id_properties_ui(self):
589
- """ """
590
- ...
792
+ """
591
793
 
592
- def is_extended(self):
593
- """ """
794
+ :return: Return an object used to manage an IDProperty's UI data.
795
+ """
594
796
  ...
595
797
 
596
- def is_property_hidden(self):
597
- """ """
798
+ def is_extended(self): ...
799
+ def is_property_hidden(self) -> bool:
800
+ """Check if a property is hidden.
801
+
802
+ :return: True when the property is hidden.
803
+ :rtype: bool
804
+ """
598
805
  ...
599
806
 
600
- def is_property_overridable_library(self):
601
- """ """
807
+ def is_property_overridable_library(self) -> bool:
808
+ """Check if a property is overridable.
809
+
810
+ :return: True when the property is overridable.
811
+ :rtype: bool
812
+ """
602
813
  ...
603
814
 
604
- def is_property_readonly(self):
605
- """ """
815
+ def is_property_readonly(self) -> bool:
816
+ """Check if a property is readonly.
817
+
818
+ :return: True when the property is readonly (not writable).
819
+ :rtype: bool
820
+ """
606
821
  ...
607
822
 
608
- def is_property_set(self):
609
- """ """
823
+ def is_property_set(self) -> bool:
824
+ """Check if a property is set, use for testing operator properties.
825
+
826
+ :return: True when the property has been set.
827
+ :rtype: bool
828
+ """
610
829
  ...
611
830
 
612
831
  def items(self):
613
- """ """
832
+ """Returns the items of this objects custom properties (matches Python's
833
+ dictionary function of the same name).
834
+
835
+ :return: custom property key, value pairs.
836
+ """
614
837
  ...
615
838
 
616
- def keyframe_delete(self):
617
- """ """
839
+ def keyframe_delete(self) -> bool:
840
+ """Remove a keyframe from this properties fcurve.
841
+
842
+ :return: Success of keyframe deletion.
843
+ :rtype: bool
844
+ """
618
845
  ...
619
846
 
620
- def keyframe_insert(self):
621
- """ """
847
+ def keyframe_insert(self) -> bool:
848
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
849
+
850
+ :return: Success of keyframe insertion.
851
+ :rtype: bool
852
+ """
622
853
  ...
623
854
 
624
855
  def keys(self):
625
- """ """
856
+ """Returns the keys of this objects custom properties (matches Python's
857
+ dictionary function of the same name).
858
+
859
+ :return: custom property keys.
860
+ """
626
861
  ...
627
862
 
628
- def path_from_id(self):
629
- """ """
863
+ def path_from_id(self) -> str:
864
+ """Returns the data path from the ID to this object (string).
865
+
866
+ :return: The path from `bpy.types.bpy_struct.id_data`
867
+ to this struct and property (when given).
868
+ :rtype: str
869
+ """
630
870
  ...
631
871
 
632
872
  def path_resolve(self):
633
- """ """
873
+ """Returns the property from the path, raise an exception when not found."""
634
874
  ...
635
875
 
636
876
  def poll(self, context):
@@ -641,88 +881,98 @@ class PHYSICS_PT_rigid_body_collisions_sensitivity(
641
881
  ...
642
882
 
643
883
  def pop(self):
644
- """ """
884
+ """Remove and return the value of the custom property assigned to key or default
885
+ when not found (matches Python's dictionary function of the same name).
886
+
887
+ """
645
888
  ...
646
889
 
647
890
  def prepend(self, draw_func):
648
- """
891
+ """Prepend a draw function to this menu, takes the same arguments as
892
+ the menus draw function
649
893
 
650
- :param draw_func:
894
+ :param draw_func:
651
895
  """
652
896
  ...
653
897
 
654
- def property_overridable_library_set(self):
655
- """ """
898
+ def property_overridable_library_set(self) -> bool:
899
+ """Define a property as overridable or not (only for custom properties!).
900
+
901
+ :return: True when the overridable status of the property was successfully set.
902
+ :rtype: bool
903
+ """
656
904
  ...
657
905
 
658
906
  def property_unset(self):
659
- """ """
907
+ """Unset a property, will use default value afterward."""
660
908
  ...
661
909
 
662
910
  def remove(self, draw_func):
663
- """
911
+ """Remove a draw function that has been added to this menu
664
912
 
665
913
  :param draw_func:
666
914
  """
667
915
  ...
668
916
 
669
917
  def type_recast(self):
670
- """ """
918
+ """Return a new instance, this is needed because types
919
+ such as textures can be changed at runtime.
920
+
921
+ :return: a new instance of this object with the type initialized again.
922
+ """
671
923
  ...
672
924
 
673
925
  def values(self):
674
- """ """
926
+ """Returns the values of this objects custom properties (matches Python's
927
+ dictionary function of the same name).
928
+
929
+ :return: custom property values.
930
+ """
675
931
  ...
676
932
 
677
933
  class PHYSICS_PT_rigid_body_collisions_surface(
678
934
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
679
935
  ):
680
- """ """
681
-
682
936
  COMPAT_ENGINES: typing.Any
683
- """ """
684
-
685
937
  bl_context: typing.Any
686
- """ """
687
-
688
938
  bl_label: typing.Any
689
- """ """
690
-
691
939
  bl_options: typing.Any
692
- """ """
693
-
694
940
  bl_parent_id: typing.Any
695
- """ """
696
-
697
941
  bl_region_type: typing.Any
698
- """ """
699
-
700
942
  bl_rna: typing.Any
701
- """ """
702
-
703
943
  bl_space_type: typing.Any
704
- """ """
705
-
706
944
  id_data: typing.Any
707
- """ """
708
945
 
709
946
  def append(self, draw_func):
710
- """
947
+ """Append a draw function to this menu,
948
+ takes the same arguments as the menus draw function
711
949
 
712
- :param draw_func:
950
+ :param draw_func:
713
951
  """
714
952
  ...
715
953
 
716
- def as_pointer(self):
717
- """ """
954
+ def as_pointer(self) -> int:
955
+ """Returns the memory address which holds a pointer to Blender's internal data
956
+
957
+ :return: int (memory address).
958
+ :rtype: int
959
+ """
718
960
  ...
719
961
 
720
- def bl_rna_get_subclass(self):
721
- """ """
962
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
963
+ """
964
+
965
+ :return: The RNA type or default when not found.
966
+ :rtype: bpy.types.Struct
967
+ """
722
968
  ...
723
969
 
724
- def bl_rna_get_subclass_py(self):
725
- """ """
970
+ def bl_rna_get_subclass_py(self) -> typing.Any:
971
+ """
972
+
973
+ :return: The class or default when not found.
974
+ :rtype: typing.Any
975
+ """
726
976
  ...
727
977
 
728
978
  def draw(self, context):
@@ -732,72 +982,126 @@ class PHYSICS_PT_rigid_body_collisions_surface(
732
982
  """
733
983
  ...
734
984
 
735
- def driver_add(self):
736
- """ """
985
+ def driver_add(self) -> bpy.types.FCurve:
986
+ """Adds driver(s) to the given property
987
+
988
+ :return: The driver(s) added.
989
+ :rtype: bpy.types.FCurve
990
+ """
737
991
  ...
738
992
 
739
- def driver_remove(self):
740
- """ """
993
+ def driver_remove(self) -> bool:
994
+ """Remove driver(s) from the given property
995
+
996
+ :return: Success of driver removal.
997
+ :rtype: bool
998
+ """
741
999
  ...
742
1000
 
743
1001
  def get(self):
744
- """ """
1002
+ """Returns the value of the custom property assigned to key or default
1003
+ when not found (matches Python's dictionary function of the same name).
1004
+
1005
+ """
745
1006
  ...
746
1007
 
747
1008
  def id_properties_clear(self):
748
- """ """
1009
+ """
1010
+
1011
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1012
+ """
749
1013
  ...
750
1014
 
751
1015
  def id_properties_ensure(self):
752
- """ """
1016
+ """
1017
+
1018
+ :return: the parent group for an RNA struct's custom IDProperties.
1019
+ """
753
1020
  ...
754
1021
 
755
1022
  def id_properties_ui(self):
756
- """ """
757
- ...
1023
+ """
758
1024
 
759
- def is_extended(self):
760
- """ """
1025
+ :return: Return an object used to manage an IDProperty's UI data.
1026
+ """
761
1027
  ...
762
1028
 
763
- def is_property_hidden(self):
764
- """ """
1029
+ def is_extended(self): ...
1030
+ def is_property_hidden(self) -> bool:
1031
+ """Check if a property is hidden.
1032
+
1033
+ :return: True when the property is hidden.
1034
+ :rtype: bool
1035
+ """
765
1036
  ...
766
1037
 
767
- def is_property_overridable_library(self):
768
- """ """
1038
+ def is_property_overridable_library(self) -> bool:
1039
+ """Check if a property is overridable.
1040
+
1041
+ :return: True when the property is overridable.
1042
+ :rtype: bool
1043
+ """
769
1044
  ...
770
1045
 
771
- def is_property_readonly(self):
772
- """ """
1046
+ def is_property_readonly(self) -> bool:
1047
+ """Check if a property is readonly.
1048
+
1049
+ :return: True when the property is readonly (not writable).
1050
+ :rtype: bool
1051
+ """
773
1052
  ...
774
1053
 
775
- def is_property_set(self):
776
- """ """
1054
+ def is_property_set(self) -> bool:
1055
+ """Check if a property is set, use for testing operator properties.
1056
+
1057
+ :return: True when the property has been set.
1058
+ :rtype: bool
1059
+ """
777
1060
  ...
778
1061
 
779
1062
  def items(self):
780
- """ """
1063
+ """Returns the items of this objects custom properties (matches Python's
1064
+ dictionary function of the same name).
1065
+
1066
+ :return: custom property key, value pairs.
1067
+ """
781
1068
  ...
782
1069
 
783
- def keyframe_delete(self):
784
- """ """
1070
+ def keyframe_delete(self) -> bool:
1071
+ """Remove a keyframe from this properties fcurve.
1072
+
1073
+ :return: Success of keyframe deletion.
1074
+ :rtype: bool
1075
+ """
785
1076
  ...
786
1077
 
787
- def keyframe_insert(self):
788
- """ """
1078
+ def keyframe_insert(self) -> bool:
1079
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1080
+
1081
+ :return: Success of keyframe insertion.
1082
+ :rtype: bool
1083
+ """
789
1084
  ...
790
1085
 
791
1086
  def keys(self):
792
- """ """
1087
+ """Returns the keys of this objects custom properties (matches Python's
1088
+ dictionary function of the same name).
1089
+
1090
+ :return: custom property keys.
1091
+ """
793
1092
  ...
794
1093
 
795
- def path_from_id(self):
796
- """ """
1094
+ def path_from_id(self) -> str:
1095
+ """Returns the data path from the ID to this object (string).
1096
+
1097
+ :return: The path from `bpy.types.bpy_struct.id_data`
1098
+ to this struct and property (when given).
1099
+ :rtype: str
1100
+ """
797
1101
  ...
798
1102
 
799
1103
  def path_resolve(self):
800
- """ """
1104
+ """Returns the property from the path, raise an exception when not found."""
801
1105
  ...
802
1106
 
803
1107
  def poll(self, context):
@@ -808,88 +1112,98 @@ class PHYSICS_PT_rigid_body_collisions_surface(
808
1112
  ...
809
1113
 
810
1114
  def pop(self):
811
- """ """
1115
+ """Remove and return the value of the custom property assigned to key or default
1116
+ when not found (matches Python's dictionary function of the same name).
1117
+
1118
+ """
812
1119
  ...
813
1120
 
814
1121
  def prepend(self, draw_func):
815
- """
1122
+ """Prepend a draw function to this menu, takes the same arguments as
1123
+ the menus draw function
816
1124
 
817
- :param draw_func:
1125
+ :param draw_func:
818
1126
  """
819
1127
  ...
820
1128
 
821
- def property_overridable_library_set(self):
822
- """ """
1129
+ def property_overridable_library_set(self) -> bool:
1130
+ """Define a property as overridable or not (only for custom properties!).
1131
+
1132
+ :return: True when the overridable status of the property was successfully set.
1133
+ :rtype: bool
1134
+ """
823
1135
  ...
824
1136
 
825
1137
  def property_unset(self):
826
- """ """
1138
+ """Unset a property, will use default value afterward."""
827
1139
  ...
828
1140
 
829
1141
  def remove(self, draw_func):
830
- """
1142
+ """Remove a draw function that has been added to this menu
831
1143
 
832
1144
  :param draw_func:
833
1145
  """
834
1146
  ...
835
1147
 
836
1148
  def type_recast(self):
837
- """ """
1149
+ """Return a new instance, this is needed because types
1150
+ such as textures can be changed at runtime.
1151
+
1152
+ :return: a new instance of this object with the type initialized again.
1153
+ """
838
1154
  ...
839
1155
 
840
1156
  def values(self):
841
- """ """
1157
+ """Returns the values of this objects custom properties (matches Python's
1158
+ dictionary function of the same name).
1159
+
1160
+ :return: custom property values.
1161
+ """
842
1162
  ...
843
1163
 
844
1164
  class PHYSICS_PT_rigid_body_dynamics(
845
1165
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
846
1166
  ):
847
- """ """
848
-
849
1167
  COMPAT_ENGINES: typing.Any
850
- """ """
851
-
852
1168
  bl_context: typing.Any
853
- """ """
854
-
855
1169
  bl_label: typing.Any
856
- """ """
857
-
858
1170
  bl_options: typing.Any
859
- """ """
860
-
861
1171
  bl_parent_id: typing.Any
862
- """ """
863
-
864
1172
  bl_region_type: typing.Any
865
- """ """
866
-
867
1173
  bl_rna: typing.Any
868
- """ """
869
-
870
1174
  bl_space_type: typing.Any
871
- """ """
872
-
873
1175
  id_data: typing.Any
874
- """ """
875
1176
 
876
1177
  def append(self, draw_func):
877
- """
1178
+ """Append a draw function to this menu,
1179
+ takes the same arguments as the menus draw function
878
1180
 
879
- :param draw_func:
1181
+ :param draw_func:
880
1182
  """
881
1183
  ...
882
1184
 
883
- def as_pointer(self):
884
- """ """
1185
+ def as_pointer(self) -> int:
1186
+ """Returns the memory address which holds a pointer to Blender's internal data
1187
+
1188
+ :return: int (memory address).
1189
+ :rtype: int
1190
+ """
885
1191
  ...
886
1192
 
887
- def bl_rna_get_subclass(self):
888
- """ """
1193
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1194
+ """
1195
+
1196
+ :return: The RNA type or default when not found.
1197
+ :rtype: bpy.types.Struct
1198
+ """
889
1199
  ...
890
1200
 
891
- def bl_rna_get_subclass_py(self):
892
- """ """
1201
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1202
+ """
1203
+
1204
+ :return: The class or default when not found.
1205
+ :rtype: typing.Any
1206
+ """
893
1207
  ...
894
1208
 
895
1209
  def draw(self, context):
@@ -899,72 +1213,126 @@ class PHYSICS_PT_rigid_body_dynamics(
899
1213
  """
900
1214
  ...
901
1215
 
902
- def driver_add(self):
903
- """ """
1216
+ def driver_add(self) -> bpy.types.FCurve:
1217
+ """Adds driver(s) to the given property
1218
+
1219
+ :return: The driver(s) added.
1220
+ :rtype: bpy.types.FCurve
1221
+ """
904
1222
  ...
905
1223
 
906
- def driver_remove(self):
907
- """ """
1224
+ def driver_remove(self) -> bool:
1225
+ """Remove driver(s) from the given property
1226
+
1227
+ :return: Success of driver removal.
1228
+ :rtype: bool
1229
+ """
908
1230
  ...
909
1231
 
910
1232
  def get(self):
911
- """ """
1233
+ """Returns the value of the custom property assigned to key or default
1234
+ when not found (matches Python's dictionary function of the same name).
1235
+
1236
+ """
912
1237
  ...
913
1238
 
914
1239
  def id_properties_clear(self):
915
- """ """
1240
+ """
1241
+
1242
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1243
+ """
916
1244
  ...
917
1245
 
918
1246
  def id_properties_ensure(self):
919
- """ """
1247
+ """
1248
+
1249
+ :return: the parent group for an RNA struct's custom IDProperties.
1250
+ """
920
1251
  ...
921
1252
 
922
1253
  def id_properties_ui(self):
923
- """ """
924
- ...
1254
+ """
925
1255
 
926
- def is_extended(self):
927
- """ """
1256
+ :return: Return an object used to manage an IDProperty's UI data.
1257
+ """
928
1258
  ...
929
1259
 
930
- def is_property_hidden(self):
931
- """ """
1260
+ def is_extended(self): ...
1261
+ def is_property_hidden(self) -> bool:
1262
+ """Check if a property is hidden.
1263
+
1264
+ :return: True when the property is hidden.
1265
+ :rtype: bool
1266
+ """
932
1267
  ...
933
1268
 
934
- def is_property_overridable_library(self):
935
- """ """
1269
+ def is_property_overridable_library(self) -> bool:
1270
+ """Check if a property is overridable.
1271
+
1272
+ :return: True when the property is overridable.
1273
+ :rtype: bool
1274
+ """
936
1275
  ...
937
1276
 
938
- def is_property_readonly(self):
939
- """ """
1277
+ def is_property_readonly(self) -> bool:
1278
+ """Check if a property is readonly.
1279
+
1280
+ :return: True when the property is readonly (not writable).
1281
+ :rtype: bool
1282
+ """
940
1283
  ...
941
1284
 
942
- def is_property_set(self):
943
- """ """
1285
+ def is_property_set(self) -> bool:
1286
+ """Check if a property is set, use for testing operator properties.
1287
+
1288
+ :return: True when the property has been set.
1289
+ :rtype: bool
1290
+ """
944
1291
  ...
945
1292
 
946
1293
  def items(self):
947
- """ """
1294
+ """Returns the items of this objects custom properties (matches Python's
1295
+ dictionary function of the same name).
1296
+
1297
+ :return: custom property key, value pairs.
1298
+ """
948
1299
  ...
949
1300
 
950
- def keyframe_delete(self):
951
- """ """
1301
+ def keyframe_delete(self) -> bool:
1302
+ """Remove a keyframe from this properties fcurve.
1303
+
1304
+ :return: Success of keyframe deletion.
1305
+ :rtype: bool
1306
+ """
952
1307
  ...
953
1308
 
954
- def keyframe_insert(self):
955
- """ """
1309
+ def keyframe_insert(self) -> bool:
1310
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1311
+
1312
+ :return: Success of keyframe insertion.
1313
+ :rtype: bool
1314
+ """
956
1315
  ...
957
1316
 
958
1317
  def keys(self):
959
- """ """
1318
+ """Returns the keys of this objects custom properties (matches Python's
1319
+ dictionary function of the same name).
1320
+
1321
+ :return: custom property keys.
1322
+ """
960
1323
  ...
961
1324
 
962
- def path_from_id(self):
963
- """ """
1325
+ def path_from_id(self) -> str:
1326
+ """Returns the data path from the ID to this object (string).
1327
+
1328
+ :return: The path from `bpy.types.bpy_struct.id_data`
1329
+ to this struct and property (when given).
1330
+ :rtype: str
1331
+ """
964
1332
  ...
965
1333
 
966
1334
  def path_resolve(self):
967
- """ """
1335
+ """Returns the property from the path, raise an exception when not found."""
968
1336
  ...
969
1337
 
970
1338
  def poll(self, context):
@@ -975,88 +1343,98 @@ class PHYSICS_PT_rigid_body_dynamics(
975
1343
  ...
976
1344
 
977
1345
  def pop(self):
978
- """ """
1346
+ """Remove and return the value of the custom property assigned to key or default
1347
+ when not found (matches Python's dictionary function of the same name).
1348
+
1349
+ """
979
1350
  ...
980
1351
 
981
1352
  def prepend(self, draw_func):
982
- """
1353
+ """Prepend a draw function to this menu, takes the same arguments as
1354
+ the menus draw function
983
1355
 
984
- :param draw_func:
1356
+ :param draw_func:
985
1357
  """
986
1358
  ...
987
1359
 
988
- def property_overridable_library_set(self):
989
- """ """
1360
+ def property_overridable_library_set(self) -> bool:
1361
+ """Define a property as overridable or not (only for custom properties!).
1362
+
1363
+ :return: True when the overridable status of the property was successfully set.
1364
+ :rtype: bool
1365
+ """
990
1366
  ...
991
1367
 
992
1368
  def property_unset(self):
993
- """ """
1369
+ """Unset a property, will use default value afterward."""
994
1370
  ...
995
1371
 
996
1372
  def remove(self, draw_func):
997
- """
1373
+ """Remove a draw function that has been added to this menu
998
1374
 
999
1375
  :param draw_func:
1000
1376
  """
1001
1377
  ...
1002
1378
 
1003
1379
  def type_recast(self):
1004
- """ """
1380
+ """Return a new instance, this is needed because types
1381
+ such as textures can be changed at runtime.
1382
+
1383
+ :return: a new instance of this object with the type initialized again.
1384
+ """
1005
1385
  ...
1006
1386
 
1007
1387
  def values(self):
1008
- """ """
1388
+ """Returns the values of this objects custom properties (matches Python's
1389
+ dictionary function of the same name).
1390
+
1391
+ :return: custom property values.
1392
+ """
1009
1393
  ...
1010
1394
 
1011
1395
  class PHYSICS_PT_rigid_body_dynamics_deactivation(
1012
1396
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
1013
1397
  ):
1014
- """ """
1015
-
1016
1398
  COMPAT_ENGINES: typing.Any
1017
- """ """
1018
-
1019
1399
  bl_context: typing.Any
1020
- """ """
1021
-
1022
1400
  bl_label: typing.Any
1023
- """ """
1024
-
1025
1401
  bl_options: typing.Any
1026
- """ """
1027
-
1028
1402
  bl_parent_id: typing.Any
1029
- """ """
1030
-
1031
1403
  bl_region_type: typing.Any
1032
- """ """
1033
-
1034
1404
  bl_rna: typing.Any
1035
- """ """
1036
-
1037
1405
  bl_space_type: typing.Any
1038
- """ """
1039
-
1040
1406
  id_data: typing.Any
1041
- """ """
1042
1407
 
1043
1408
  def append(self, draw_func):
1044
- """
1409
+ """Append a draw function to this menu,
1410
+ takes the same arguments as the menus draw function
1045
1411
 
1046
- :param draw_func:
1412
+ :param draw_func:
1047
1413
  """
1048
1414
  ...
1049
1415
 
1050
- def as_pointer(self):
1051
- """ """
1416
+ def as_pointer(self) -> int:
1417
+ """Returns the memory address which holds a pointer to Blender's internal data
1418
+
1419
+ :return: int (memory address).
1420
+ :rtype: int
1421
+ """
1052
1422
  ...
1053
1423
 
1054
- def bl_rna_get_subclass(self):
1055
- """ """
1424
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1425
+ """
1426
+
1427
+ :return: The RNA type or default when not found.
1428
+ :rtype: bpy.types.Struct
1429
+ """
1056
1430
  ...
1057
1431
 
1058
- def bl_rna_get_subclass_py(self):
1059
- """ """
1432
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1433
+ """
1434
+
1435
+ :return: The class or default when not found.
1436
+ :rtype: typing.Any
1437
+ """
1060
1438
  ...
1061
1439
 
1062
1440
  def draw(self, context):
@@ -1073,72 +1451,126 @@ class PHYSICS_PT_rigid_body_dynamics_deactivation(
1073
1451
  """
1074
1452
  ...
1075
1453
 
1076
- def driver_add(self):
1077
- """ """
1454
+ def driver_add(self) -> bpy.types.FCurve:
1455
+ """Adds driver(s) to the given property
1456
+
1457
+ :return: The driver(s) added.
1458
+ :rtype: bpy.types.FCurve
1459
+ """
1078
1460
  ...
1079
1461
 
1080
- def driver_remove(self):
1081
- """ """
1462
+ def driver_remove(self) -> bool:
1463
+ """Remove driver(s) from the given property
1464
+
1465
+ :return: Success of driver removal.
1466
+ :rtype: bool
1467
+ """
1082
1468
  ...
1083
1469
 
1084
1470
  def get(self):
1085
- """ """
1471
+ """Returns the value of the custom property assigned to key or default
1472
+ when not found (matches Python's dictionary function of the same name).
1473
+
1474
+ """
1086
1475
  ...
1087
1476
 
1088
1477
  def id_properties_clear(self):
1089
- """ """
1478
+ """
1479
+
1480
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1481
+ """
1090
1482
  ...
1091
1483
 
1092
1484
  def id_properties_ensure(self):
1093
- """ """
1485
+ """
1486
+
1487
+ :return: the parent group for an RNA struct's custom IDProperties.
1488
+ """
1094
1489
  ...
1095
1490
 
1096
1491
  def id_properties_ui(self):
1097
- """ """
1098
- ...
1492
+ """
1099
1493
 
1100
- def is_extended(self):
1101
- """ """
1494
+ :return: Return an object used to manage an IDProperty's UI data.
1495
+ """
1102
1496
  ...
1103
1497
 
1104
- def is_property_hidden(self):
1105
- """ """
1498
+ def is_extended(self): ...
1499
+ def is_property_hidden(self) -> bool:
1500
+ """Check if a property is hidden.
1501
+
1502
+ :return: True when the property is hidden.
1503
+ :rtype: bool
1504
+ """
1106
1505
  ...
1107
1506
 
1108
- def is_property_overridable_library(self):
1109
- """ """
1507
+ def is_property_overridable_library(self) -> bool:
1508
+ """Check if a property is overridable.
1509
+
1510
+ :return: True when the property is overridable.
1511
+ :rtype: bool
1512
+ """
1110
1513
  ...
1111
1514
 
1112
- def is_property_readonly(self):
1113
- """ """
1515
+ def is_property_readonly(self) -> bool:
1516
+ """Check if a property is readonly.
1517
+
1518
+ :return: True when the property is readonly (not writable).
1519
+ :rtype: bool
1520
+ """
1114
1521
  ...
1115
1522
 
1116
- def is_property_set(self):
1117
- """ """
1523
+ def is_property_set(self) -> bool:
1524
+ """Check if a property is set, use for testing operator properties.
1525
+
1526
+ :return: True when the property has been set.
1527
+ :rtype: bool
1528
+ """
1118
1529
  ...
1119
1530
 
1120
1531
  def items(self):
1121
- """ """
1532
+ """Returns the items of this objects custom properties (matches Python's
1533
+ dictionary function of the same name).
1534
+
1535
+ :return: custom property key, value pairs.
1536
+ """
1122
1537
  ...
1123
1538
 
1124
- def keyframe_delete(self):
1125
- """ """
1539
+ def keyframe_delete(self) -> bool:
1540
+ """Remove a keyframe from this properties fcurve.
1541
+
1542
+ :return: Success of keyframe deletion.
1543
+ :rtype: bool
1544
+ """
1126
1545
  ...
1127
1546
 
1128
- def keyframe_insert(self):
1129
- """ """
1547
+ def keyframe_insert(self) -> bool:
1548
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1549
+
1550
+ :return: Success of keyframe insertion.
1551
+ :rtype: bool
1552
+ """
1130
1553
  ...
1131
1554
 
1132
1555
  def keys(self):
1133
- """ """
1556
+ """Returns the keys of this objects custom properties (matches Python's
1557
+ dictionary function of the same name).
1558
+
1559
+ :return: custom property keys.
1560
+ """
1134
1561
  ...
1135
1562
 
1136
- def path_from_id(self):
1137
- """ """
1563
+ def path_from_id(self) -> str:
1564
+ """Returns the data path from the ID to this object (string).
1565
+
1566
+ :return: The path from `bpy.types.bpy_struct.id_data`
1567
+ to this struct and property (when given).
1568
+ :rtype: str
1569
+ """
1138
1570
  ...
1139
1571
 
1140
1572
  def path_resolve(self):
1141
- """ """
1573
+ """Returns the property from the path, raise an exception when not found."""
1142
1574
  ...
1143
1575
 
1144
1576
  def poll(self, context):
@@ -1149,85 +1581,97 @@ class PHYSICS_PT_rigid_body_dynamics_deactivation(
1149
1581
  ...
1150
1582
 
1151
1583
  def pop(self):
1152
- """ """
1584
+ """Remove and return the value of the custom property assigned to key or default
1585
+ when not found (matches Python's dictionary function of the same name).
1586
+
1587
+ """
1153
1588
  ...
1154
1589
 
1155
1590
  def prepend(self, draw_func):
1156
- """
1591
+ """Prepend a draw function to this menu, takes the same arguments as
1592
+ the menus draw function
1157
1593
 
1158
- :param draw_func:
1594
+ :param draw_func:
1159
1595
  """
1160
1596
  ...
1161
1597
 
1162
- def property_overridable_library_set(self):
1163
- """ """
1598
+ def property_overridable_library_set(self) -> bool:
1599
+ """Define a property as overridable or not (only for custom properties!).
1600
+
1601
+ :return: True when the overridable status of the property was successfully set.
1602
+ :rtype: bool
1603
+ """
1164
1604
  ...
1165
1605
 
1166
1606
  def property_unset(self):
1167
- """ """
1607
+ """Unset a property, will use default value afterward."""
1168
1608
  ...
1169
1609
 
1170
1610
  def remove(self, draw_func):
1171
- """
1611
+ """Remove a draw function that has been added to this menu
1172
1612
 
1173
1613
  :param draw_func:
1174
1614
  """
1175
1615
  ...
1176
1616
 
1177
1617
  def type_recast(self):
1178
- """ """
1618
+ """Return a new instance, this is needed because types
1619
+ such as textures can be changed at runtime.
1620
+
1621
+ :return: a new instance of this object with the type initialized again.
1622
+ """
1179
1623
  ...
1180
1624
 
1181
1625
  def values(self):
1182
- """ """
1626
+ """Returns the values of this objects custom properties (matches Python's
1627
+ dictionary function of the same name).
1628
+
1629
+ :return: custom property values.
1630
+ """
1183
1631
  ...
1184
1632
 
1185
1633
  class PHYSICS_PT_rigid_body_settings(
1186
1634
  bpy_types.Panel, PHYSICS_PT_rigidbody_panel, bpy_types._GenericUI
1187
1635
  ):
1188
- """ """
1189
-
1190
1636
  COMPAT_ENGINES: typing.Any
1191
- """ """
1192
-
1193
1637
  bl_context: typing.Any
1194
- """ """
1195
-
1196
1638
  bl_label: typing.Any
1197
- """ """
1198
-
1199
1639
  bl_parent_id: typing.Any
1200
- """ """
1201
-
1202
1640
  bl_region_type: typing.Any
1203
- """ """
1204
-
1205
1641
  bl_rna: typing.Any
1206
- """ """
1207
-
1208
1642
  bl_space_type: typing.Any
1209
- """ """
1210
-
1211
1643
  id_data: typing.Any
1212
- """ """
1213
1644
 
1214
1645
  def append(self, draw_func):
1215
- """
1646
+ """Append a draw function to this menu,
1647
+ takes the same arguments as the menus draw function
1216
1648
 
1217
- :param draw_func:
1649
+ :param draw_func:
1218
1650
  """
1219
1651
  ...
1220
1652
 
1221
- def as_pointer(self):
1222
- """ """
1653
+ def as_pointer(self) -> int:
1654
+ """Returns the memory address which holds a pointer to Blender's internal data
1655
+
1656
+ :return: int (memory address).
1657
+ :rtype: int
1658
+ """
1223
1659
  ...
1224
1660
 
1225
- def bl_rna_get_subclass(self):
1226
- """ """
1661
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1662
+ """
1663
+
1664
+ :return: The RNA type or default when not found.
1665
+ :rtype: bpy.types.Struct
1666
+ """
1227
1667
  ...
1228
1668
 
1229
- def bl_rna_get_subclass_py(self):
1230
- """ """
1669
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1670
+ """
1671
+
1672
+ :return: The class or default when not found.
1673
+ :rtype: typing.Any
1674
+ """
1231
1675
  ...
1232
1676
 
1233
1677
  def draw(self, context):
@@ -1237,72 +1681,126 @@ class PHYSICS_PT_rigid_body_settings(
1237
1681
  """
1238
1682
  ...
1239
1683
 
1240
- def driver_add(self):
1241
- """ """
1684
+ def driver_add(self) -> bpy.types.FCurve:
1685
+ """Adds driver(s) to the given property
1686
+
1687
+ :return: The driver(s) added.
1688
+ :rtype: bpy.types.FCurve
1689
+ """
1242
1690
  ...
1243
1691
 
1244
- def driver_remove(self):
1245
- """ """
1692
+ def driver_remove(self) -> bool:
1693
+ """Remove driver(s) from the given property
1694
+
1695
+ :return: Success of driver removal.
1696
+ :rtype: bool
1697
+ """
1246
1698
  ...
1247
1699
 
1248
1700
  def get(self):
1249
- """ """
1701
+ """Returns the value of the custom property assigned to key or default
1702
+ when not found (matches Python's dictionary function of the same name).
1703
+
1704
+ """
1250
1705
  ...
1251
1706
 
1252
1707
  def id_properties_clear(self):
1253
- """ """
1708
+ """
1709
+
1710
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1711
+ """
1254
1712
  ...
1255
1713
 
1256
1714
  def id_properties_ensure(self):
1257
- """ """
1715
+ """
1716
+
1717
+ :return: the parent group for an RNA struct's custom IDProperties.
1718
+ """
1258
1719
  ...
1259
1720
 
1260
1721
  def id_properties_ui(self):
1261
- """ """
1262
- ...
1722
+ """
1263
1723
 
1264
- def is_extended(self):
1265
- """ """
1724
+ :return: Return an object used to manage an IDProperty's UI data.
1725
+ """
1266
1726
  ...
1267
1727
 
1268
- def is_property_hidden(self):
1269
- """ """
1728
+ def is_extended(self): ...
1729
+ def is_property_hidden(self) -> bool:
1730
+ """Check if a property is hidden.
1731
+
1732
+ :return: True when the property is hidden.
1733
+ :rtype: bool
1734
+ """
1270
1735
  ...
1271
1736
 
1272
- def is_property_overridable_library(self):
1273
- """ """
1737
+ def is_property_overridable_library(self) -> bool:
1738
+ """Check if a property is overridable.
1739
+
1740
+ :return: True when the property is overridable.
1741
+ :rtype: bool
1742
+ """
1274
1743
  ...
1275
1744
 
1276
- def is_property_readonly(self):
1277
- """ """
1745
+ def is_property_readonly(self) -> bool:
1746
+ """Check if a property is readonly.
1747
+
1748
+ :return: True when the property is readonly (not writable).
1749
+ :rtype: bool
1750
+ """
1278
1751
  ...
1279
1752
 
1280
- def is_property_set(self):
1281
- """ """
1753
+ def is_property_set(self) -> bool:
1754
+ """Check if a property is set, use for testing operator properties.
1755
+
1756
+ :return: True when the property has been set.
1757
+ :rtype: bool
1758
+ """
1282
1759
  ...
1283
1760
 
1284
1761
  def items(self):
1285
- """ """
1762
+ """Returns the items of this objects custom properties (matches Python's
1763
+ dictionary function of the same name).
1764
+
1765
+ :return: custom property key, value pairs.
1766
+ """
1286
1767
  ...
1287
1768
 
1288
- def keyframe_delete(self):
1289
- """ """
1769
+ def keyframe_delete(self) -> bool:
1770
+ """Remove a keyframe from this properties fcurve.
1771
+
1772
+ :return: Success of keyframe deletion.
1773
+ :rtype: bool
1774
+ """
1290
1775
  ...
1291
1776
 
1292
- def keyframe_insert(self):
1293
- """ """
1777
+ def keyframe_insert(self) -> bool:
1778
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1779
+
1780
+ :return: Success of keyframe insertion.
1781
+ :rtype: bool
1782
+ """
1294
1783
  ...
1295
1784
 
1296
1785
  def keys(self):
1297
- """ """
1786
+ """Returns the keys of this objects custom properties (matches Python's
1787
+ dictionary function of the same name).
1788
+
1789
+ :return: custom property keys.
1790
+ """
1298
1791
  ...
1299
1792
 
1300
- def path_from_id(self):
1301
- """ """
1793
+ def path_from_id(self) -> str:
1794
+ """Returns the data path from the ID to this object (string).
1795
+
1796
+ :return: The path from `bpy.types.bpy_struct.id_data`
1797
+ to this struct and property (when given).
1798
+ :rtype: str
1799
+ """
1302
1800
  ...
1303
1801
 
1304
1802
  def path_resolve(self):
1305
- """ """
1803
+ """Returns the property from the path, raise an exception when not found."""
1306
1804
  ...
1307
1805
 
1308
1806
  def poll(self, context):
@@ -1313,40 +1811,53 @@ class PHYSICS_PT_rigid_body_settings(
1313
1811
  ...
1314
1812
 
1315
1813
  def pop(self):
1316
- """ """
1814
+ """Remove and return the value of the custom property assigned to key or default
1815
+ when not found (matches Python's dictionary function of the same name).
1816
+
1817
+ """
1317
1818
  ...
1318
1819
 
1319
1820
  def prepend(self, draw_func):
1320
- """
1821
+ """Prepend a draw function to this menu, takes the same arguments as
1822
+ the menus draw function
1321
1823
 
1322
- :param draw_func:
1824
+ :param draw_func:
1323
1825
  """
1324
1826
  ...
1325
1827
 
1326
- def property_overridable_library_set(self):
1327
- """ """
1828
+ def property_overridable_library_set(self) -> bool:
1829
+ """Define a property as overridable or not (only for custom properties!).
1830
+
1831
+ :return: True when the overridable status of the property was successfully set.
1832
+ :rtype: bool
1833
+ """
1328
1834
  ...
1329
1835
 
1330
1836
  def property_unset(self):
1331
- """ """
1837
+ """Unset a property, will use default value afterward."""
1332
1838
  ...
1333
1839
 
1334
1840
  def remove(self, draw_func):
1335
- """
1841
+ """Remove a draw function that has been added to this menu
1336
1842
 
1337
1843
  :param draw_func:
1338
1844
  """
1339
1845
  ...
1340
1846
 
1341
1847
  def type_recast(self):
1342
- """ """
1848
+ """Return a new instance, this is needed because types
1849
+ such as textures can be changed at runtime.
1850
+
1851
+ :return: a new instance of this object with the type initialized again.
1852
+ """
1343
1853
  ...
1344
1854
 
1345
1855
  def values(self):
1346
- """ """
1347
- ...
1856
+ """Returns the values of this objects custom properties (matches Python's
1857
+ dictionary function of the same name).
1348
1858
 
1349
- def rigid_body_warning(layout, text):
1350
- """ """
1859
+ :return: custom property values.
1860
+ """
1861
+ ...
1351
1862
 
1352
- ...
1863
+ def rigid_body_warning(layout, text): ...