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_constraint_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_constraint(
19
13
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_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_constraint(
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_constraint(
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_constraint_limits(
180
242
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_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_constraint_limits(
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,85 +419,97 @@ class PHYSICS_PT_rigid_body_constraint_limits(
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_constraint_limits_angular(
344
472
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_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_parent_id: typing.Any
358
- """ """
359
-
360
478
  bl_region_type: typing.Any
361
- """ """
362
-
363
479
  bl_rna: typing.Any
364
- """ """
365
-
366
480
  bl_space_type: typing.Any
367
- """ """
368
-
369
481
  id_data: typing.Any
370
- """ """
371
482
 
372
483
  def append(self, draw_func):
373
- """
484
+ """Append a draw function to this menu,
485
+ takes the same arguments as the menus draw function
374
486
 
375
- :param draw_func:
487
+ :param draw_func:
376
488
  """
377
489
  ...
378
490
 
379
- def as_pointer(self):
380
- """ """
491
+ def as_pointer(self) -> int:
492
+ """Returns the memory address which holds a pointer to Blender's internal data
493
+
494
+ :return: int (memory address).
495
+ :rtype: int
496
+ """
381
497
  ...
382
498
 
383
- def bl_rna_get_subclass(self):
384
- """ """
499
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
500
+ """
501
+
502
+ :return: The RNA type or default when not found.
503
+ :rtype: bpy.types.Struct
504
+ """
385
505
  ...
386
506
 
387
- def bl_rna_get_subclass_py(self):
388
- """ """
507
+ def bl_rna_get_subclass_py(self) -> typing.Any:
508
+ """
509
+
510
+ :return: The class or default when not found.
511
+ :rtype: typing.Any
512
+ """
389
513
  ...
390
514
 
391
515
  def draw(self, context):
@@ -395,72 +519,126 @@ class PHYSICS_PT_rigid_body_constraint_limits_angular(
395
519
  """
396
520
  ...
397
521
 
398
- def driver_add(self):
399
- """ """
522
+ def driver_add(self) -> bpy.types.FCurve:
523
+ """Adds driver(s) to the given property
524
+
525
+ :return: The driver(s) added.
526
+ :rtype: bpy.types.FCurve
527
+ """
400
528
  ...
401
529
 
402
- def driver_remove(self):
403
- """ """
530
+ def driver_remove(self) -> bool:
531
+ """Remove driver(s) from the given property
532
+
533
+ :return: Success of driver removal.
534
+ :rtype: bool
535
+ """
404
536
  ...
405
537
 
406
538
  def get(self):
407
- """ """
539
+ """Returns the value of the custom property assigned to key or default
540
+ when not found (matches Python's dictionary function of the same name).
541
+
542
+ """
408
543
  ...
409
544
 
410
545
  def id_properties_clear(self):
411
- """ """
546
+ """
547
+
548
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
549
+ """
412
550
  ...
413
551
 
414
552
  def id_properties_ensure(self):
415
- """ """
553
+ """
554
+
555
+ :return: the parent group for an RNA struct's custom IDProperties.
556
+ """
416
557
  ...
417
558
 
418
559
  def id_properties_ui(self):
419
- """ """
420
- ...
560
+ """
421
561
 
422
- def is_extended(self):
423
- """ """
562
+ :return: Return an object used to manage an IDProperty's UI data.
563
+ """
424
564
  ...
425
565
 
426
- def is_property_hidden(self):
427
- """ """
566
+ def is_extended(self): ...
567
+ def is_property_hidden(self) -> bool:
568
+ """Check if a property is hidden.
569
+
570
+ :return: True when the property is hidden.
571
+ :rtype: bool
572
+ """
428
573
  ...
429
574
 
430
- def is_property_overridable_library(self):
431
- """ """
575
+ def is_property_overridable_library(self) -> bool:
576
+ """Check if a property is overridable.
577
+
578
+ :return: True when the property is overridable.
579
+ :rtype: bool
580
+ """
432
581
  ...
433
582
 
434
- def is_property_readonly(self):
435
- """ """
583
+ def is_property_readonly(self) -> bool:
584
+ """Check if a property is readonly.
585
+
586
+ :return: True when the property is readonly (not writable).
587
+ :rtype: bool
588
+ """
436
589
  ...
437
590
 
438
- def is_property_set(self):
439
- """ """
591
+ def is_property_set(self) -> bool:
592
+ """Check if a property is set, use for testing operator properties.
593
+
594
+ :return: True when the property has been set.
595
+ :rtype: bool
596
+ """
440
597
  ...
441
598
 
442
599
  def items(self):
443
- """ """
600
+ """Returns the items of this objects custom properties (matches Python's
601
+ dictionary function of the same name).
602
+
603
+ :return: custom property key, value pairs.
604
+ """
444
605
  ...
445
606
 
446
- def keyframe_delete(self):
447
- """ """
607
+ def keyframe_delete(self) -> bool:
608
+ """Remove a keyframe from this properties fcurve.
609
+
610
+ :return: Success of keyframe deletion.
611
+ :rtype: bool
612
+ """
448
613
  ...
449
614
 
450
- def keyframe_insert(self):
451
- """ """
615
+ def keyframe_insert(self) -> bool:
616
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
617
+
618
+ :return: Success of keyframe insertion.
619
+ :rtype: bool
620
+ """
452
621
  ...
453
622
 
454
623
  def keys(self):
455
- """ """
624
+ """Returns the keys of this objects custom properties (matches Python's
625
+ dictionary function of the same name).
626
+
627
+ :return: custom property keys.
628
+ """
456
629
  ...
457
630
 
458
- def path_from_id(self):
459
- """ """
631
+ def path_from_id(self) -> str:
632
+ """Returns the data path from the ID to this object (string).
633
+
634
+ :return: The path from `bpy.types.bpy_struct.id_data`
635
+ to this struct and property (when given).
636
+ :rtype: str
637
+ """
460
638
  ...
461
639
 
462
640
  def path_resolve(self):
463
- """ """
641
+ """Returns the property from the path, raise an exception when not found."""
464
642
  ...
465
643
 
466
644
  def poll(self, context):
@@ -471,85 +649,97 @@ class PHYSICS_PT_rigid_body_constraint_limits_angular(
471
649
  ...
472
650
 
473
651
  def pop(self):
474
- """ """
652
+ """Remove and return the value of the custom property assigned to key or default
653
+ when not found (matches Python's dictionary function of the same name).
654
+
655
+ """
475
656
  ...
476
657
 
477
658
  def prepend(self, draw_func):
478
- """
659
+ """Prepend a draw function to this menu, takes the same arguments as
660
+ the menus draw function
479
661
 
480
- :param draw_func:
662
+ :param draw_func:
481
663
  """
482
664
  ...
483
665
 
484
- def property_overridable_library_set(self):
485
- """ """
666
+ def property_overridable_library_set(self) -> bool:
667
+ """Define a property as overridable or not (only for custom properties!).
668
+
669
+ :return: True when the overridable status of the property was successfully set.
670
+ :rtype: bool
671
+ """
486
672
  ...
487
673
 
488
674
  def property_unset(self):
489
- """ """
675
+ """Unset a property, will use default value afterward."""
490
676
  ...
491
677
 
492
678
  def remove(self, draw_func):
493
- """
679
+ """Remove a draw function that has been added to this menu
494
680
 
495
681
  :param draw_func:
496
682
  """
497
683
  ...
498
684
 
499
685
  def type_recast(self):
500
- """ """
686
+ """Return a new instance, this is needed because types
687
+ such as textures can be changed at runtime.
688
+
689
+ :return: a new instance of this object with the type initialized again.
690
+ """
501
691
  ...
502
692
 
503
693
  def values(self):
504
- """ """
694
+ """Returns the values of this objects custom properties (matches Python's
695
+ dictionary function of the same name).
696
+
697
+ :return: custom property values.
698
+ """
505
699
  ...
506
700
 
507
701
  class PHYSICS_PT_rigid_body_constraint_limits_linear(
508
702
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
509
703
  ):
510
- """ """
511
-
512
704
  COMPAT_ENGINES: typing.Any
513
- """ """
514
-
515
705
  bl_context: typing.Any
516
- """ """
517
-
518
706
  bl_label: typing.Any
519
- """ """
520
-
521
707
  bl_parent_id: typing.Any
522
- """ """
523
-
524
708
  bl_region_type: typing.Any
525
- """ """
526
-
527
709
  bl_rna: typing.Any
528
- """ """
529
-
530
710
  bl_space_type: typing.Any
531
- """ """
532
-
533
711
  id_data: typing.Any
534
- """ """
535
712
 
536
713
  def append(self, draw_func):
537
- """
714
+ """Append a draw function to this menu,
715
+ takes the same arguments as the menus draw function
538
716
 
539
- :param draw_func:
717
+ :param draw_func:
540
718
  """
541
719
  ...
542
720
 
543
- def as_pointer(self):
544
- """ """
721
+ def as_pointer(self) -> int:
722
+ """Returns the memory address which holds a pointer to Blender's internal data
723
+
724
+ :return: int (memory address).
725
+ :rtype: int
726
+ """
545
727
  ...
546
728
 
547
- def bl_rna_get_subclass(self):
548
- """ """
729
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
730
+ """
731
+
732
+ :return: The RNA type or default when not found.
733
+ :rtype: bpy.types.Struct
734
+ """
549
735
  ...
550
736
 
551
- def bl_rna_get_subclass_py(self):
552
- """ """
737
+ def bl_rna_get_subclass_py(self) -> typing.Any:
738
+ """
739
+
740
+ :return: The class or default when not found.
741
+ :rtype: typing.Any
742
+ """
553
743
  ...
554
744
 
555
745
  def draw(self, context):
@@ -559,72 +749,126 @@ class PHYSICS_PT_rigid_body_constraint_limits_linear(
559
749
  """
560
750
  ...
561
751
 
562
- def driver_add(self):
563
- """ """
752
+ def driver_add(self) -> bpy.types.FCurve:
753
+ """Adds driver(s) to the given property
754
+
755
+ :return: The driver(s) added.
756
+ :rtype: bpy.types.FCurve
757
+ """
564
758
  ...
565
759
 
566
- def driver_remove(self):
567
- """ """
760
+ def driver_remove(self) -> bool:
761
+ """Remove driver(s) from the given property
762
+
763
+ :return: Success of driver removal.
764
+ :rtype: bool
765
+ """
568
766
  ...
569
767
 
570
768
  def get(self):
571
- """ """
769
+ """Returns the value of the custom property assigned to key or default
770
+ when not found (matches Python's dictionary function of the same name).
771
+
772
+ """
572
773
  ...
573
774
 
574
775
  def id_properties_clear(self):
575
- """ """
776
+ """
777
+
778
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
779
+ """
576
780
  ...
577
781
 
578
782
  def id_properties_ensure(self):
579
- """ """
783
+ """
784
+
785
+ :return: the parent group for an RNA struct's custom IDProperties.
786
+ """
580
787
  ...
581
788
 
582
789
  def id_properties_ui(self):
583
- """ """
584
- ...
790
+ """
585
791
 
586
- def is_extended(self):
587
- """ """
792
+ :return: Return an object used to manage an IDProperty's UI data.
793
+ """
588
794
  ...
589
795
 
590
- def is_property_hidden(self):
591
- """ """
796
+ def is_extended(self): ...
797
+ def is_property_hidden(self) -> bool:
798
+ """Check if a property is hidden.
799
+
800
+ :return: True when the property is hidden.
801
+ :rtype: bool
802
+ """
592
803
  ...
593
804
 
594
- def is_property_overridable_library(self):
595
- """ """
805
+ def is_property_overridable_library(self) -> bool:
806
+ """Check if a property is overridable.
807
+
808
+ :return: True when the property is overridable.
809
+ :rtype: bool
810
+ """
596
811
  ...
597
812
 
598
- def is_property_readonly(self):
599
- """ """
813
+ def is_property_readonly(self) -> bool:
814
+ """Check if a property is readonly.
815
+
816
+ :return: True when the property is readonly (not writable).
817
+ :rtype: bool
818
+ """
600
819
  ...
601
820
 
602
- def is_property_set(self):
603
- """ """
821
+ def is_property_set(self) -> bool:
822
+ """Check if a property is set, use for testing operator properties.
823
+
824
+ :return: True when the property has been set.
825
+ :rtype: bool
826
+ """
604
827
  ...
605
828
 
606
829
  def items(self):
607
- """ """
830
+ """Returns the items of this objects custom properties (matches Python's
831
+ dictionary function of the same name).
832
+
833
+ :return: custom property key, value pairs.
834
+ """
608
835
  ...
609
836
 
610
- def keyframe_delete(self):
611
- """ """
837
+ def keyframe_delete(self) -> bool:
838
+ """Remove a keyframe from this properties fcurve.
839
+
840
+ :return: Success of keyframe deletion.
841
+ :rtype: bool
842
+ """
612
843
  ...
613
844
 
614
- def keyframe_insert(self):
615
- """ """
845
+ def keyframe_insert(self) -> bool:
846
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
847
+
848
+ :return: Success of keyframe insertion.
849
+ :rtype: bool
850
+ """
616
851
  ...
617
852
 
618
853
  def keys(self):
619
- """ """
854
+ """Returns the keys of this objects custom properties (matches Python's
855
+ dictionary function of the same name).
856
+
857
+ :return: custom property keys.
858
+ """
620
859
  ...
621
860
 
622
- def path_from_id(self):
623
- """ """
861
+ def path_from_id(self) -> str:
862
+ """Returns the data path from the ID to this object (string).
863
+
864
+ :return: The path from `bpy.types.bpy_struct.id_data`
865
+ to this struct and property (when given).
866
+ :rtype: str
867
+ """
624
868
  ...
625
869
 
626
870
  def path_resolve(self):
627
- """ """
871
+ """Returns the property from the path, raise an exception when not found."""
628
872
  ...
629
873
 
630
874
  def poll(self, context):
@@ -635,85 +879,97 @@ class PHYSICS_PT_rigid_body_constraint_limits_linear(
635
879
  ...
636
880
 
637
881
  def pop(self):
638
- """ """
882
+ """Remove and return the value of the custom property assigned to key or default
883
+ when not found (matches Python's dictionary function of the same name).
884
+
885
+ """
639
886
  ...
640
887
 
641
888
  def prepend(self, draw_func):
642
- """
889
+ """Prepend a draw function to this menu, takes the same arguments as
890
+ the menus draw function
643
891
 
644
- :param draw_func:
892
+ :param draw_func:
645
893
  """
646
894
  ...
647
895
 
648
- def property_overridable_library_set(self):
649
- """ """
896
+ def property_overridable_library_set(self) -> bool:
897
+ """Define a property as overridable or not (only for custom properties!).
898
+
899
+ :return: True when the overridable status of the property was successfully set.
900
+ :rtype: bool
901
+ """
650
902
  ...
651
903
 
652
904
  def property_unset(self):
653
- """ """
905
+ """Unset a property, will use default value afterward."""
654
906
  ...
655
907
 
656
908
  def remove(self, draw_func):
657
- """
909
+ """Remove a draw function that has been added to this menu
658
910
 
659
911
  :param draw_func:
660
912
  """
661
913
  ...
662
914
 
663
915
  def type_recast(self):
664
- """ """
916
+ """Return a new instance, this is needed because types
917
+ such as textures can be changed at runtime.
918
+
919
+ :return: a new instance of this object with the type initialized again.
920
+ """
665
921
  ...
666
922
 
667
923
  def values(self):
668
- """ """
924
+ """Returns the values of this objects custom properties (matches Python's
925
+ dictionary function of the same name).
926
+
927
+ :return: custom property values.
928
+ """
669
929
  ...
670
930
 
671
931
  class PHYSICS_PT_rigid_body_constraint_motor(
672
932
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
673
933
  ):
674
- """ """
675
-
676
934
  COMPAT_ENGINES: typing.Any
677
- """ """
678
-
679
935
  bl_context: typing.Any
680
- """ """
681
-
682
936
  bl_label: typing.Any
683
- """ """
684
-
685
937
  bl_parent_id: typing.Any
686
- """ """
687
-
688
938
  bl_region_type: typing.Any
689
- """ """
690
-
691
939
  bl_rna: typing.Any
692
- """ """
693
-
694
940
  bl_space_type: typing.Any
695
- """ """
696
-
697
941
  id_data: typing.Any
698
- """ """
699
942
 
700
943
  def append(self, draw_func):
701
- """
944
+ """Append a draw function to this menu,
945
+ takes the same arguments as the menus draw function
702
946
 
703
- :param draw_func:
947
+ :param draw_func:
704
948
  """
705
949
  ...
706
950
 
707
- def as_pointer(self):
708
- """ """
951
+ def as_pointer(self) -> int:
952
+ """Returns the memory address which holds a pointer to Blender's internal data
953
+
954
+ :return: int (memory address).
955
+ :rtype: int
956
+ """
709
957
  ...
710
958
 
711
- def bl_rna_get_subclass(self):
712
- """ """
959
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
960
+ """
961
+
962
+ :return: The RNA type or default when not found.
963
+ :rtype: bpy.types.Struct
964
+ """
713
965
  ...
714
966
 
715
- def bl_rna_get_subclass_py(self):
716
- """ """
967
+ def bl_rna_get_subclass_py(self) -> typing.Any:
968
+ """
969
+
970
+ :return: The class or default when not found.
971
+ :rtype: typing.Any
972
+ """
717
973
  ...
718
974
 
719
975
  def draw(self, _context):
@@ -723,72 +979,126 @@ class PHYSICS_PT_rigid_body_constraint_motor(
723
979
  """
724
980
  ...
725
981
 
726
- def driver_add(self):
727
- """ """
982
+ def driver_add(self) -> bpy.types.FCurve:
983
+ """Adds driver(s) to the given property
984
+
985
+ :return: The driver(s) added.
986
+ :rtype: bpy.types.FCurve
987
+ """
728
988
  ...
729
989
 
730
- def driver_remove(self):
731
- """ """
990
+ def driver_remove(self) -> bool:
991
+ """Remove driver(s) from the given property
992
+
993
+ :return: Success of driver removal.
994
+ :rtype: bool
995
+ """
732
996
  ...
733
997
 
734
998
  def get(self):
735
- """ """
999
+ """Returns the value of the custom property assigned to key or default
1000
+ when not found (matches Python's dictionary function of the same name).
1001
+
1002
+ """
736
1003
  ...
737
1004
 
738
1005
  def id_properties_clear(self):
739
- """ """
1006
+ """
1007
+
1008
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1009
+ """
740
1010
  ...
741
1011
 
742
1012
  def id_properties_ensure(self):
743
- """ """
1013
+ """
1014
+
1015
+ :return: the parent group for an RNA struct's custom IDProperties.
1016
+ """
744
1017
  ...
745
1018
 
746
1019
  def id_properties_ui(self):
747
- """ """
748
- ...
1020
+ """
749
1021
 
750
- def is_extended(self):
751
- """ """
1022
+ :return: Return an object used to manage an IDProperty's UI data.
1023
+ """
752
1024
  ...
753
1025
 
754
- def is_property_hidden(self):
755
- """ """
1026
+ def is_extended(self): ...
1027
+ def is_property_hidden(self) -> bool:
1028
+ """Check if a property is hidden.
1029
+
1030
+ :return: True when the property is hidden.
1031
+ :rtype: bool
1032
+ """
756
1033
  ...
757
1034
 
758
- def is_property_overridable_library(self):
759
- """ """
1035
+ def is_property_overridable_library(self) -> bool:
1036
+ """Check if a property is overridable.
1037
+
1038
+ :return: True when the property is overridable.
1039
+ :rtype: bool
1040
+ """
760
1041
  ...
761
1042
 
762
- def is_property_readonly(self):
763
- """ """
1043
+ def is_property_readonly(self) -> bool:
1044
+ """Check if a property is readonly.
1045
+
1046
+ :return: True when the property is readonly (not writable).
1047
+ :rtype: bool
1048
+ """
764
1049
  ...
765
1050
 
766
- def is_property_set(self):
767
- """ """
1051
+ def is_property_set(self) -> bool:
1052
+ """Check if a property is set, use for testing operator properties.
1053
+
1054
+ :return: True when the property has been set.
1055
+ :rtype: bool
1056
+ """
768
1057
  ...
769
1058
 
770
1059
  def items(self):
771
- """ """
1060
+ """Returns the items of this objects custom properties (matches Python's
1061
+ dictionary function of the same name).
1062
+
1063
+ :return: custom property key, value pairs.
1064
+ """
772
1065
  ...
773
1066
 
774
- def keyframe_delete(self):
775
- """ """
1067
+ def keyframe_delete(self) -> bool:
1068
+ """Remove a keyframe from this properties fcurve.
1069
+
1070
+ :return: Success of keyframe deletion.
1071
+ :rtype: bool
1072
+ """
776
1073
  ...
777
1074
 
778
- def keyframe_insert(self):
779
- """ """
1075
+ def keyframe_insert(self) -> bool:
1076
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1077
+
1078
+ :return: Success of keyframe insertion.
1079
+ :rtype: bool
1080
+ """
780
1081
  ...
781
1082
 
782
1083
  def keys(self):
783
- """ """
1084
+ """Returns the keys of this objects custom properties (matches Python's
1085
+ dictionary function of the same name).
1086
+
1087
+ :return: custom property keys.
1088
+ """
784
1089
  ...
785
1090
 
786
- def path_from_id(self):
787
- """ """
1091
+ def path_from_id(self) -> str:
1092
+ """Returns the data path from the ID to this object (string).
1093
+
1094
+ :return: The path from `bpy.types.bpy_struct.id_data`
1095
+ to this struct and property (when given).
1096
+ :rtype: str
1097
+ """
788
1098
  ...
789
1099
 
790
1100
  def path_resolve(self):
791
- """ """
1101
+ """Returns the property from the path, raise an exception when not found."""
792
1102
  ...
793
1103
 
794
1104
  def poll(self, context):
@@ -799,85 +1109,97 @@ class PHYSICS_PT_rigid_body_constraint_motor(
799
1109
  ...
800
1110
 
801
1111
  def pop(self):
802
- """ """
1112
+ """Remove and return the value of the custom property assigned to key or default
1113
+ when not found (matches Python's dictionary function of the same name).
1114
+
1115
+ """
803
1116
  ...
804
1117
 
805
1118
  def prepend(self, draw_func):
806
- """
1119
+ """Prepend a draw function to this menu, takes the same arguments as
1120
+ the menus draw function
807
1121
 
808
- :param draw_func:
1122
+ :param draw_func:
809
1123
  """
810
1124
  ...
811
1125
 
812
- def property_overridable_library_set(self):
813
- """ """
1126
+ def property_overridable_library_set(self) -> bool:
1127
+ """Define a property as overridable or not (only for custom properties!).
1128
+
1129
+ :return: True when the overridable status of the property was successfully set.
1130
+ :rtype: bool
1131
+ """
814
1132
  ...
815
1133
 
816
1134
  def property_unset(self):
817
- """ """
1135
+ """Unset a property, will use default value afterward."""
818
1136
  ...
819
1137
 
820
1138
  def remove(self, draw_func):
821
- """
1139
+ """Remove a draw function that has been added to this menu
822
1140
 
823
1141
  :param draw_func:
824
1142
  """
825
1143
  ...
826
1144
 
827
1145
  def type_recast(self):
828
- """ """
1146
+ """Return a new instance, this is needed because types
1147
+ such as textures can be changed at runtime.
1148
+
1149
+ :return: a new instance of this object with the type initialized again.
1150
+ """
829
1151
  ...
830
1152
 
831
1153
  def values(self):
832
- """ """
1154
+ """Returns the values of this objects custom properties (matches Python's
1155
+ dictionary function of the same name).
1156
+
1157
+ :return: custom property values.
1158
+ """
833
1159
  ...
834
1160
 
835
1161
  class PHYSICS_PT_rigid_body_constraint_motor_angular(
836
1162
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
837
1163
  ):
838
- """ """
839
-
840
1164
  COMPAT_ENGINES: typing.Any
841
- """ """
842
-
843
1165
  bl_context: typing.Any
844
- """ """
845
-
846
1166
  bl_label: typing.Any
847
- """ """
848
-
849
1167
  bl_parent_id: typing.Any
850
- """ """
851
-
852
1168
  bl_region_type: typing.Any
853
- """ """
854
-
855
1169
  bl_rna: typing.Any
856
- """ """
857
-
858
1170
  bl_space_type: typing.Any
859
- """ """
860
-
861
1171
  id_data: typing.Any
862
- """ """
863
1172
 
864
1173
  def append(self, draw_func):
865
- """
1174
+ """Append a draw function to this menu,
1175
+ takes the same arguments as the menus draw function
866
1176
 
867
- :param draw_func:
1177
+ :param draw_func:
868
1178
  """
869
1179
  ...
870
1180
 
871
- def as_pointer(self):
872
- """ """
1181
+ def as_pointer(self) -> int:
1182
+ """Returns the memory address which holds a pointer to Blender's internal data
1183
+
1184
+ :return: int (memory address).
1185
+ :rtype: int
1186
+ """
873
1187
  ...
874
1188
 
875
- def bl_rna_get_subclass(self):
876
- """ """
1189
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1190
+ """
1191
+
1192
+ :return: The RNA type or default when not found.
1193
+ :rtype: bpy.types.Struct
1194
+ """
877
1195
  ...
878
1196
 
879
- def bl_rna_get_subclass_py(self):
880
- """ """
1197
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1198
+ """
1199
+
1200
+ :return: The class or default when not found.
1201
+ :rtype: typing.Any
1202
+ """
881
1203
  ...
882
1204
 
883
1205
  def draw(self, context):
@@ -894,72 +1216,126 @@ class PHYSICS_PT_rigid_body_constraint_motor_angular(
894
1216
  """
895
1217
  ...
896
1218
 
897
- def driver_add(self):
898
- """ """
1219
+ def driver_add(self) -> bpy.types.FCurve:
1220
+ """Adds driver(s) to the given property
1221
+
1222
+ :return: The driver(s) added.
1223
+ :rtype: bpy.types.FCurve
1224
+ """
899
1225
  ...
900
1226
 
901
- def driver_remove(self):
902
- """ """
1227
+ def driver_remove(self) -> bool:
1228
+ """Remove driver(s) from the given property
1229
+
1230
+ :return: Success of driver removal.
1231
+ :rtype: bool
1232
+ """
903
1233
  ...
904
1234
 
905
1235
  def get(self):
906
- """ """
1236
+ """Returns the value of the custom property assigned to key or default
1237
+ when not found (matches Python's dictionary function of the same name).
1238
+
1239
+ """
907
1240
  ...
908
1241
 
909
1242
  def id_properties_clear(self):
910
- """ """
1243
+ """
1244
+
1245
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1246
+ """
911
1247
  ...
912
1248
 
913
1249
  def id_properties_ensure(self):
914
- """ """
1250
+ """
1251
+
1252
+ :return: the parent group for an RNA struct's custom IDProperties.
1253
+ """
915
1254
  ...
916
1255
 
917
1256
  def id_properties_ui(self):
918
- """ """
919
- ...
1257
+ """
920
1258
 
921
- def is_extended(self):
922
- """ """
1259
+ :return: Return an object used to manage an IDProperty's UI data.
1260
+ """
923
1261
  ...
924
1262
 
925
- def is_property_hidden(self):
926
- """ """
1263
+ def is_extended(self): ...
1264
+ def is_property_hidden(self) -> bool:
1265
+ """Check if a property is hidden.
1266
+
1267
+ :return: True when the property is hidden.
1268
+ :rtype: bool
1269
+ """
927
1270
  ...
928
1271
 
929
- def is_property_overridable_library(self):
930
- """ """
1272
+ def is_property_overridable_library(self) -> bool:
1273
+ """Check if a property is overridable.
1274
+
1275
+ :return: True when the property is overridable.
1276
+ :rtype: bool
1277
+ """
931
1278
  ...
932
1279
 
933
- def is_property_readonly(self):
934
- """ """
1280
+ def is_property_readonly(self) -> bool:
1281
+ """Check if a property is readonly.
1282
+
1283
+ :return: True when the property is readonly (not writable).
1284
+ :rtype: bool
1285
+ """
935
1286
  ...
936
1287
 
937
- def is_property_set(self):
938
- """ """
1288
+ def is_property_set(self) -> bool:
1289
+ """Check if a property is set, use for testing operator properties.
1290
+
1291
+ :return: True when the property has been set.
1292
+ :rtype: bool
1293
+ """
939
1294
  ...
940
1295
 
941
1296
  def items(self):
942
- """ """
1297
+ """Returns the items of this objects custom properties (matches Python's
1298
+ dictionary function of the same name).
1299
+
1300
+ :return: custom property key, value pairs.
1301
+ """
943
1302
  ...
944
1303
 
945
- def keyframe_delete(self):
946
- """ """
1304
+ def keyframe_delete(self) -> bool:
1305
+ """Remove a keyframe from this properties fcurve.
1306
+
1307
+ :return: Success of keyframe deletion.
1308
+ :rtype: bool
1309
+ """
947
1310
  ...
948
1311
 
949
- def keyframe_insert(self):
950
- """ """
1312
+ def keyframe_insert(self) -> bool:
1313
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1314
+
1315
+ :return: Success of keyframe insertion.
1316
+ :rtype: bool
1317
+ """
951
1318
  ...
952
1319
 
953
1320
  def keys(self):
954
- """ """
1321
+ """Returns the keys of this objects custom properties (matches Python's
1322
+ dictionary function of the same name).
1323
+
1324
+ :return: custom property keys.
1325
+ """
955
1326
  ...
956
1327
 
957
- def path_from_id(self):
958
- """ """
1328
+ def path_from_id(self) -> str:
1329
+ """Returns the data path from the ID to this object (string).
1330
+
1331
+ :return: The path from `bpy.types.bpy_struct.id_data`
1332
+ to this struct and property (when given).
1333
+ :rtype: str
1334
+ """
959
1335
  ...
960
1336
 
961
1337
  def path_resolve(self):
962
- """ """
1338
+ """Returns the property from the path, raise an exception when not found."""
963
1339
  ...
964
1340
 
965
1341
  def poll(self, context):
@@ -970,85 +1346,97 @@ class PHYSICS_PT_rigid_body_constraint_motor_angular(
970
1346
  ...
971
1347
 
972
1348
  def pop(self):
973
- """ """
1349
+ """Remove and return the value of the custom property assigned to key or default
1350
+ when not found (matches Python's dictionary function of the same name).
1351
+
1352
+ """
974
1353
  ...
975
1354
 
976
1355
  def prepend(self, draw_func):
977
- """
1356
+ """Prepend a draw function to this menu, takes the same arguments as
1357
+ the menus draw function
978
1358
 
979
- :param draw_func:
1359
+ :param draw_func:
980
1360
  """
981
1361
  ...
982
1362
 
983
- def property_overridable_library_set(self):
984
- """ """
1363
+ def property_overridable_library_set(self) -> bool:
1364
+ """Define a property as overridable or not (only for custom properties!).
1365
+
1366
+ :return: True when the overridable status of the property was successfully set.
1367
+ :rtype: bool
1368
+ """
985
1369
  ...
986
1370
 
987
1371
  def property_unset(self):
988
- """ """
1372
+ """Unset a property, will use default value afterward."""
989
1373
  ...
990
1374
 
991
1375
  def remove(self, draw_func):
992
- """
1376
+ """Remove a draw function that has been added to this menu
993
1377
 
994
1378
  :param draw_func:
995
1379
  """
996
1380
  ...
997
1381
 
998
1382
  def type_recast(self):
999
- """ """
1383
+ """Return a new instance, this is needed because types
1384
+ such as textures can be changed at runtime.
1385
+
1386
+ :return: a new instance of this object with the type initialized again.
1387
+ """
1000
1388
  ...
1001
1389
 
1002
1390
  def values(self):
1003
- """ """
1391
+ """Returns the values of this objects custom properties (matches Python's
1392
+ dictionary function of the same name).
1393
+
1394
+ :return: custom property values.
1395
+ """
1004
1396
  ...
1005
1397
 
1006
1398
  class PHYSICS_PT_rigid_body_constraint_motor_linear(
1007
1399
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
1008
1400
  ):
1009
- """ """
1010
-
1011
1401
  COMPAT_ENGINES: typing.Any
1012
- """ """
1013
-
1014
1402
  bl_context: typing.Any
1015
- """ """
1016
-
1017
1403
  bl_label: typing.Any
1018
- """ """
1019
-
1020
1404
  bl_parent_id: typing.Any
1021
- """ """
1022
-
1023
1405
  bl_region_type: typing.Any
1024
- """ """
1025
-
1026
1406
  bl_rna: typing.Any
1027
- """ """
1028
-
1029
1407
  bl_space_type: typing.Any
1030
- """ """
1031
-
1032
1408
  id_data: typing.Any
1033
- """ """
1034
1409
 
1035
1410
  def append(self, draw_func):
1036
- """
1411
+ """Append a draw function to this menu,
1412
+ takes the same arguments as the menus draw function
1037
1413
 
1038
- :param draw_func:
1414
+ :param draw_func:
1039
1415
  """
1040
1416
  ...
1041
1417
 
1042
- def as_pointer(self):
1043
- """ """
1418
+ def as_pointer(self) -> int:
1419
+ """Returns the memory address which holds a pointer to Blender's internal data
1420
+
1421
+ :return: int (memory address).
1422
+ :rtype: int
1423
+ """
1044
1424
  ...
1045
1425
 
1046
- def bl_rna_get_subclass(self):
1047
- """ """
1426
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1427
+ """
1428
+
1429
+ :return: The RNA type or default when not found.
1430
+ :rtype: bpy.types.Struct
1431
+ """
1048
1432
  ...
1049
1433
 
1050
- def bl_rna_get_subclass_py(self):
1051
- """ """
1434
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1435
+ """
1436
+
1437
+ :return: The class or default when not found.
1438
+ :rtype: typing.Any
1439
+ """
1052
1440
  ...
1053
1441
 
1054
1442
  def draw(self, context):
@@ -1065,72 +1453,126 @@ class PHYSICS_PT_rigid_body_constraint_motor_linear(
1065
1453
  """
1066
1454
  ...
1067
1455
 
1068
- def driver_add(self):
1069
- """ """
1456
+ def driver_add(self) -> bpy.types.FCurve:
1457
+ """Adds driver(s) to the given property
1458
+
1459
+ :return: The driver(s) added.
1460
+ :rtype: bpy.types.FCurve
1461
+ """
1070
1462
  ...
1071
1463
 
1072
- def driver_remove(self):
1073
- """ """
1464
+ def driver_remove(self) -> bool:
1465
+ """Remove driver(s) from the given property
1466
+
1467
+ :return: Success of driver removal.
1468
+ :rtype: bool
1469
+ """
1074
1470
  ...
1075
1471
 
1076
1472
  def get(self):
1077
- """ """
1473
+ """Returns the value of the custom property assigned to key or default
1474
+ when not found (matches Python's dictionary function of the same name).
1475
+
1476
+ """
1078
1477
  ...
1079
1478
 
1080
1479
  def id_properties_clear(self):
1081
- """ """
1480
+ """
1481
+
1482
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1483
+ """
1082
1484
  ...
1083
1485
 
1084
1486
  def id_properties_ensure(self):
1085
- """ """
1487
+ """
1488
+
1489
+ :return: the parent group for an RNA struct's custom IDProperties.
1490
+ """
1086
1491
  ...
1087
1492
 
1088
1493
  def id_properties_ui(self):
1089
- """ """
1090
- ...
1494
+ """
1091
1495
 
1092
- def is_extended(self):
1093
- """ """
1496
+ :return: Return an object used to manage an IDProperty's UI data.
1497
+ """
1094
1498
  ...
1095
1499
 
1096
- def is_property_hidden(self):
1097
- """ """
1500
+ def is_extended(self): ...
1501
+ def is_property_hidden(self) -> bool:
1502
+ """Check if a property is hidden.
1503
+
1504
+ :return: True when the property is hidden.
1505
+ :rtype: bool
1506
+ """
1098
1507
  ...
1099
1508
 
1100
- def is_property_overridable_library(self):
1101
- """ """
1509
+ def is_property_overridable_library(self) -> bool:
1510
+ """Check if a property is overridable.
1511
+
1512
+ :return: True when the property is overridable.
1513
+ :rtype: bool
1514
+ """
1102
1515
  ...
1103
1516
 
1104
- def is_property_readonly(self):
1105
- """ """
1517
+ def is_property_readonly(self) -> bool:
1518
+ """Check if a property is readonly.
1519
+
1520
+ :return: True when the property is readonly (not writable).
1521
+ :rtype: bool
1522
+ """
1106
1523
  ...
1107
1524
 
1108
- def is_property_set(self):
1109
- """ """
1525
+ def is_property_set(self) -> bool:
1526
+ """Check if a property is set, use for testing operator properties.
1527
+
1528
+ :return: True when the property has been set.
1529
+ :rtype: bool
1530
+ """
1110
1531
  ...
1111
1532
 
1112
1533
  def items(self):
1113
- """ """
1534
+ """Returns the items of this objects custom properties (matches Python's
1535
+ dictionary function of the same name).
1536
+
1537
+ :return: custom property key, value pairs.
1538
+ """
1114
1539
  ...
1115
1540
 
1116
- def keyframe_delete(self):
1117
- """ """
1541
+ def keyframe_delete(self) -> bool:
1542
+ """Remove a keyframe from this properties fcurve.
1543
+
1544
+ :return: Success of keyframe deletion.
1545
+ :rtype: bool
1546
+ """
1118
1547
  ...
1119
1548
 
1120
- def keyframe_insert(self):
1121
- """ """
1549
+ def keyframe_insert(self) -> bool:
1550
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1551
+
1552
+ :return: Success of keyframe insertion.
1553
+ :rtype: bool
1554
+ """
1122
1555
  ...
1123
1556
 
1124
1557
  def keys(self):
1125
- """ """
1558
+ """Returns the keys of this objects custom properties (matches Python's
1559
+ dictionary function of the same name).
1560
+
1561
+ :return: custom property keys.
1562
+ """
1126
1563
  ...
1127
1564
 
1128
- def path_from_id(self):
1129
- """ """
1565
+ def path_from_id(self) -> str:
1566
+ """Returns the data path from the ID to this object (string).
1567
+
1568
+ :return: The path from `bpy.types.bpy_struct.id_data`
1569
+ to this struct and property (when given).
1570
+ :rtype: str
1571
+ """
1130
1572
  ...
1131
1573
 
1132
1574
  def path_resolve(self):
1133
- """ """
1575
+ """Returns the property from the path, raise an exception when not found."""
1134
1576
  ...
1135
1577
 
1136
1578
  def poll(self, context):
@@ -1141,85 +1583,97 @@ class PHYSICS_PT_rigid_body_constraint_motor_linear(
1141
1583
  ...
1142
1584
 
1143
1585
  def pop(self):
1144
- """ """
1586
+ """Remove and return the value of the custom property assigned to key or default
1587
+ when not found (matches Python's dictionary function of the same name).
1588
+
1589
+ """
1145
1590
  ...
1146
1591
 
1147
1592
  def prepend(self, draw_func):
1148
- """
1593
+ """Prepend a draw function to this menu, takes the same arguments as
1594
+ the menus draw function
1149
1595
 
1150
- :param draw_func:
1596
+ :param draw_func:
1151
1597
  """
1152
1598
  ...
1153
1599
 
1154
- def property_overridable_library_set(self):
1155
- """ """
1600
+ def property_overridable_library_set(self) -> bool:
1601
+ """Define a property as overridable or not (only for custom properties!).
1602
+
1603
+ :return: True when the overridable status of the property was successfully set.
1604
+ :rtype: bool
1605
+ """
1156
1606
  ...
1157
1607
 
1158
1608
  def property_unset(self):
1159
- """ """
1609
+ """Unset a property, will use default value afterward."""
1160
1610
  ...
1161
1611
 
1162
1612
  def remove(self, draw_func):
1163
- """
1613
+ """Remove a draw function that has been added to this menu
1164
1614
 
1165
1615
  :param draw_func:
1166
1616
  """
1167
1617
  ...
1168
1618
 
1169
1619
  def type_recast(self):
1170
- """ """
1620
+ """Return a new instance, this is needed because types
1621
+ such as textures can be changed at runtime.
1622
+
1623
+ :return: a new instance of this object with the type initialized again.
1624
+ """
1171
1625
  ...
1172
1626
 
1173
1627
  def values(self):
1174
- """ """
1628
+ """Returns the values of this objects custom properties (matches Python's
1629
+ dictionary function of the same name).
1630
+
1631
+ :return: custom property values.
1632
+ """
1175
1633
  ...
1176
1634
 
1177
1635
  class PHYSICS_PT_rigid_body_constraint_objects(
1178
1636
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
1179
1637
  ):
1180
- """ """
1181
-
1182
1638
  COMPAT_ENGINES: typing.Any
1183
- """ """
1184
-
1185
1639
  bl_context: typing.Any
1186
- """ """
1187
-
1188
1640
  bl_label: typing.Any
1189
- """ """
1190
-
1191
1641
  bl_parent_id: typing.Any
1192
- """ """
1193
-
1194
1642
  bl_region_type: typing.Any
1195
- """ """
1196
-
1197
1643
  bl_rna: typing.Any
1198
- """ """
1199
-
1200
1644
  bl_space_type: typing.Any
1201
- """ """
1202
-
1203
1645
  id_data: typing.Any
1204
- """ """
1205
1646
 
1206
1647
  def append(self, draw_func):
1207
- """
1648
+ """Append a draw function to this menu,
1649
+ takes the same arguments as the menus draw function
1208
1650
 
1209
- :param draw_func:
1651
+ :param draw_func:
1210
1652
  """
1211
1653
  ...
1212
1654
 
1213
- def as_pointer(self):
1214
- """ """
1655
+ def as_pointer(self) -> int:
1656
+ """Returns the memory address which holds a pointer to Blender's internal data
1657
+
1658
+ :return: int (memory address).
1659
+ :rtype: int
1660
+ """
1215
1661
  ...
1216
1662
 
1217
- def bl_rna_get_subclass(self):
1218
- """ """
1663
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1664
+ """
1665
+
1666
+ :return: The RNA type or default when not found.
1667
+ :rtype: bpy.types.Struct
1668
+ """
1219
1669
  ...
1220
1670
 
1221
- def bl_rna_get_subclass_py(self):
1222
- """ """
1671
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1672
+ """
1673
+
1674
+ :return: The class or default when not found.
1675
+ :rtype: typing.Any
1676
+ """
1223
1677
  ...
1224
1678
 
1225
1679
  def draw(self, context):
@@ -1229,72 +1683,126 @@ class PHYSICS_PT_rigid_body_constraint_objects(
1229
1683
  """
1230
1684
  ...
1231
1685
 
1232
- def driver_add(self):
1233
- """ """
1686
+ def driver_add(self) -> bpy.types.FCurve:
1687
+ """Adds driver(s) to the given property
1688
+
1689
+ :return: The driver(s) added.
1690
+ :rtype: bpy.types.FCurve
1691
+ """
1234
1692
  ...
1235
1693
 
1236
- def driver_remove(self):
1237
- """ """
1694
+ def driver_remove(self) -> bool:
1695
+ """Remove driver(s) from the given property
1696
+
1697
+ :return: Success of driver removal.
1698
+ :rtype: bool
1699
+ """
1238
1700
  ...
1239
1701
 
1240
1702
  def get(self):
1241
- """ """
1703
+ """Returns the value of the custom property assigned to key or default
1704
+ when not found (matches Python's dictionary function of the same name).
1705
+
1706
+ """
1242
1707
  ...
1243
1708
 
1244
1709
  def id_properties_clear(self):
1245
- """ """
1710
+ """
1711
+
1712
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1713
+ """
1246
1714
  ...
1247
1715
 
1248
1716
  def id_properties_ensure(self):
1249
- """ """
1717
+ """
1718
+
1719
+ :return: the parent group for an RNA struct's custom IDProperties.
1720
+ """
1250
1721
  ...
1251
1722
 
1252
1723
  def id_properties_ui(self):
1253
- """ """
1254
- ...
1724
+ """
1255
1725
 
1256
- def is_extended(self):
1257
- """ """
1726
+ :return: Return an object used to manage an IDProperty's UI data.
1727
+ """
1258
1728
  ...
1259
1729
 
1260
- def is_property_hidden(self):
1261
- """ """
1730
+ def is_extended(self): ...
1731
+ def is_property_hidden(self) -> bool:
1732
+ """Check if a property is hidden.
1733
+
1734
+ :return: True when the property is hidden.
1735
+ :rtype: bool
1736
+ """
1262
1737
  ...
1263
1738
 
1264
- def is_property_overridable_library(self):
1265
- """ """
1739
+ def is_property_overridable_library(self) -> bool:
1740
+ """Check if a property is overridable.
1741
+
1742
+ :return: True when the property is overridable.
1743
+ :rtype: bool
1744
+ """
1266
1745
  ...
1267
1746
 
1268
- def is_property_readonly(self):
1269
- """ """
1747
+ def is_property_readonly(self) -> bool:
1748
+ """Check if a property is readonly.
1749
+
1750
+ :return: True when the property is readonly (not writable).
1751
+ :rtype: bool
1752
+ """
1270
1753
  ...
1271
1754
 
1272
- def is_property_set(self):
1273
- """ """
1755
+ def is_property_set(self) -> bool:
1756
+ """Check if a property is set, use for testing operator properties.
1757
+
1758
+ :return: True when the property has been set.
1759
+ :rtype: bool
1760
+ """
1274
1761
  ...
1275
1762
 
1276
1763
  def items(self):
1277
- """ """
1764
+ """Returns the items of this objects custom properties (matches Python's
1765
+ dictionary function of the same name).
1766
+
1767
+ :return: custom property key, value pairs.
1768
+ """
1278
1769
  ...
1279
1770
 
1280
- def keyframe_delete(self):
1281
- """ """
1771
+ def keyframe_delete(self) -> bool:
1772
+ """Remove a keyframe from this properties fcurve.
1773
+
1774
+ :return: Success of keyframe deletion.
1775
+ :rtype: bool
1776
+ """
1282
1777
  ...
1283
1778
 
1284
- def keyframe_insert(self):
1285
- """ """
1779
+ def keyframe_insert(self) -> bool:
1780
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
1781
+
1782
+ :return: Success of keyframe insertion.
1783
+ :rtype: bool
1784
+ """
1286
1785
  ...
1287
1786
 
1288
1787
  def keys(self):
1289
- """ """
1788
+ """Returns the keys of this objects custom properties (matches Python's
1789
+ dictionary function of the same name).
1790
+
1791
+ :return: custom property keys.
1792
+ """
1290
1793
  ...
1291
1794
 
1292
- def path_from_id(self):
1293
- """ """
1795
+ def path_from_id(self) -> str:
1796
+ """Returns the data path from the ID to this object (string).
1797
+
1798
+ :return: The path from `bpy.types.bpy_struct.id_data`
1799
+ to this struct and property (when given).
1800
+ :rtype: str
1801
+ """
1294
1802
  ...
1295
1803
 
1296
1804
  def path_resolve(self):
1297
- """ """
1805
+ """Returns the property from the path, raise an exception when not found."""
1298
1806
  ...
1299
1807
 
1300
1808
  def poll(self, context):
@@ -1305,85 +1813,97 @@ class PHYSICS_PT_rigid_body_constraint_objects(
1305
1813
  ...
1306
1814
 
1307
1815
  def pop(self):
1308
- """ """
1816
+ """Remove and return the value of the custom property assigned to key or default
1817
+ when not found (matches Python's dictionary function of the same name).
1818
+
1819
+ """
1309
1820
  ...
1310
1821
 
1311
1822
  def prepend(self, draw_func):
1312
- """
1823
+ """Prepend a draw function to this menu, takes the same arguments as
1824
+ the menus draw function
1313
1825
 
1314
- :param draw_func:
1826
+ :param draw_func:
1315
1827
  """
1316
1828
  ...
1317
1829
 
1318
- def property_overridable_library_set(self):
1319
- """ """
1830
+ def property_overridable_library_set(self) -> bool:
1831
+ """Define a property as overridable or not (only for custom properties!).
1832
+
1833
+ :return: True when the overridable status of the property was successfully set.
1834
+ :rtype: bool
1835
+ """
1320
1836
  ...
1321
1837
 
1322
1838
  def property_unset(self):
1323
- """ """
1839
+ """Unset a property, will use default value afterward."""
1324
1840
  ...
1325
1841
 
1326
1842
  def remove(self, draw_func):
1327
- """
1843
+ """Remove a draw function that has been added to this menu
1328
1844
 
1329
1845
  :param draw_func:
1330
1846
  """
1331
1847
  ...
1332
1848
 
1333
1849
  def type_recast(self):
1334
- """ """
1850
+ """Return a new instance, this is needed because types
1851
+ such as textures can be changed at runtime.
1852
+
1853
+ :return: a new instance of this object with the type initialized again.
1854
+ """
1335
1855
  ...
1336
1856
 
1337
1857
  def values(self):
1338
- """ """
1858
+ """Returns the values of this objects custom properties (matches Python's
1859
+ dictionary function of the same name).
1860
+
1861
+ :return: custom property values.
1862
+ """
1339
1863
  ...
1340
1864
 
1341
1865
  class PHYSICS_PT_rigid_body_constraint_override_iterations(
1342
1866
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
1343
1867
  ):
1344
- """ """
1345
-
1346
1868
  COMPAT_ENGINES: typing.Any
1347
- """ """
1348
-
1349
1869
  bl_context: typing.Any
1350
- """ """
1351
-
1352
1870
  bl_label: typing.Any
1353
- """ """
1354
-
1355
1871
  bl_parent_id: typing.Any
1356
- """ """
1357
-
1358
1872
  bl_region_type: typing.Any
1359
- """ """
1360
-
1361
1873
  bl_rna: typing.Any
1362
- """ """
1363
-
1364
1874
  bl_space_type: typing.Any
1365
- """ """
1366
-
1367
1875
  id_data: typing.Any
1368
- """ """
1369
1876
 
1370
1877
  def append(self, draw_func):
1371
- """
1878
+ """Append a draw function to this menu,
1879
+ takes the same arguments as the menus draw function
1372
1880
 
1373
- :param draw_func:
1881
+ :param draw_func:
1374
1882
  """
1375
1883
  ...
1376
1884
 
1377
- def as_pointer(self):
1378
- """ """
1885
+ def as_pointer(self) -> int:
1886
+ """Returns the memory address which holds a pointer to Blender's internal data
1887
+
1888
+ :return: int (memory address).
1889
+ :rtype: int
1890
+ """
1379
1891
  ...
1380
1892
 
1381
- def bl_rna_get_subclass(self):
1382
- """ """
1893
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
1894
+ """
1895
+
1896
+ :return: The RNA type or default when not found.
1897
+ :rtype: bpy.types.Struct
1898
+ """
1383
1899
  ...
1384
1900
 
1385
- def bl_rna_get_subclass_py(self):
1386
- """ """
1901
+ def bl_rna_get_subclass_py(self) -> typing.Any:
1902
+ """
1903
+
1904
+ :return: The class or default when not found.
1905
+ :rtype: typing.Any
1906
+ """
1387
1907
  ...
1388
1908
 
1389
1909
  def draw(self, context):
@@ -1400,72 +1920,126 @@ class PHYSICS_PT_rigid_body_constraint_override_iterations(
1400
1920
  """
1401
1921
  ...
1402
1922
 
1403
- def driver_add(self):
1404
- """ """
1923
+ def driver_add(self) -> bpy.types.FCurve:
1924
+ """Adds driver(s) to the given property
1925
+
1926
+ :return: The driver(s) added.
1927
+ :rtype: bpy.types.FCurve
1928
+ """
1405
1929
  ...
1406
1930
 
1407
- def driver_remove(self):
1408
- """ """
1931
+ def driver_remove(self) -> bool:
1932
+ """Remove driver(s) from the given property
1933
+
1934
+ :return: Success of driver removal.
1935
+ :rtype: bool
1936
+ """
1409
1937
  ...
1410
1938
 
1411
1939
  def get(self):
1412
- """ """
1940
+ """Returns the value of the custom property assigned to key or default
1941
+ when not found (matches Python's dictionary function of the same name).
1942
+
1943
+ """
1413
1944
  ...
1414
1945
 
1415
1946
  def id_properties_clear(self):
1416
- """ """
1947
+ """
1948
+
1949
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
1950
+ """
1417
1951
  ...
1418
1952
 
1419
1953
  def id_properties_ensure(self):
1420
- """ """
1954
+ """
1955
+
1956
+ :return: the parent group for an RNA struct's custom IDProperties.
1957
+ """
1421
1958
  ...
1422
1959
 
1423
1960
  def id_properties_ui(self):
1424
- """ """
1425
- ...
1961
+ """
1426
1962
 
1427
- def is_extended(self):
1428
- """ """
1963
+ :return: Return an object used to manage an IDProperty's UI data.
1964
+ """
1429
1965
  ...
1430
1966
 
1431
- def is_property_hidden(self):
1432
- """ """
1967
+ def is_extended(self): ...
1968
+ def is_property_hidden(self) -> bool:
1969
+ """Check if a property is hidden.
1970
+
1971
+ :return: True when the property is hidden.
1972
+ :rtype: bool
1973
+ """
1433
1974
  ...
1434
1975
 
1435
- def is_property_overridable_library(self):
1436
- """ """
1976
+ def is_property_overridable_library(self) -> bool:
1977
+ """Check if a property is overridable.
1978
+
1979
+ :return: True when the property is overridable.
1980
+ :rtype: bool
1981
+ """
1437
1982
  ...
1438
1983
 
1439
- def is_property_readonly(self):
1440
- """ """
1984
+ def is_property_readonly(self) -> bool:
1985
+ """Check if a property is readonly.
1986
+
1987
+ :return: True when the property is readonly (not writable).
1988
+ :rtype: bool
1989
+ """
1441
1990
  ...
1442
1991
 
1443
- def is_property_set(self):
1444
- """ """
1992
+ def is_property_set(self) -> bool:
1993
+ """Check if a property is set, use for testing operator properties.
1994
+
1995
+ :return: True when the property has been set.
1996
+ :rtype: bool
1997
+ """
1445
1998
  ...
1446
1999
 
1447
2000
  def items(self):
1448
- """ """
2001
+ """Returns the items of this objects custom properties (matches Python's
2002
+ dictionary function of the same name).
2003
+
2004
+ :return: custom property key, value pairs.
2005
+ """
1449
2006
  ...
1450
2007
 
1451
- def keyframe_delete(self):
1452
- """ """
2008
+ def keyframe_delete(self) -> bool:
2009
+ """Remove a keyframe from this properties fcurve.
2010
+
2011
+ :return: Success of keyframe deletion.
2012
+ :rtype: bool
2013
+ """
1453
2014
  ...
1454
2015
 
1455
- def keyframe_insert(self):
1456
- """ """
2016
+ def keyframe_insert(self) -> bool:
2017
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2018
+
2019
+ :return: Success of keyframe insertion.
2020
+ :rtype: bool
2021
+ """
1457
2022
  ...
1458
2023
 
1459
2024
  def keys(self):
1460
- """ """
2025
+ """Returns the keys of this objects custom properties (matches Python's
2026
+ dictionary function of the same name).
2027
+
2028
+ :return: custom property keys.
2029
+ """
1461
2030
  ...
1462
2031
 
1463
- def path_from_id(self):
1464
- """ """
2032
+ def path_from_id(self) -> str:
2033
+ """Returns the data path from the ID to this object (string).
2034
+
2035
+ :return: The path from `bpy.types.bpy_struct.id_data`
2036
+ to this struct and property (when given).
2037
+ :rtype: str
2038
+ """
1465
2039
  ...
1466
2040
 
1467
2041
  def path_resolve(self):
1468
- """ """
2042
+ """Returns the property from the path, raise an exception when not found."""
1469
2043
  ...
1470
2044
 
1471
2045
  def poll(self, context):
@@ -1476,85 +2050,97 @@ class PHYSICS_PT_rigid_body_constraint_override_iterations(
1476
2050
  ...
1477
2051
 
1478
2052
  def pop(self):
1479
- """ """
2053
+ """Remove and return the value of the custom property assigned to key or default
2054
+ when not found (matches Python's dictionary function of the same name).
2055
+
2056
+ """
1480
2057
  ...
1481
2058
 
1482
2059
  def prepend(self, draw_func):
1483
- """
2060
+ """Prepend a draw function to this menu, takes the same arguments as
2061
+ the menus draw function
1484
2062
 
1485
- :param draw_func:
2063
+ :param draw_func:
1486
2064
  """
1487
2065
  ...
1488
2066
 
1489
- def property_overridable_library_set(self):
1490
- """ """
2067
+ def property_overridable_library_set(self) -> bool:
2068
+ """Define a property as overridable or not (only for custom properties!).
2069
+
2070
+ :return: True when the overridable status of the property was successfully set.
2071
+ :rtype: bool
2072
+ """
1491
2073
  ...
1492
2074
 
1493
2075
  def property_unset(self):
1494
- """ """
2076
+ """Unset a property, will use default value afterward."""
1495
2077
  ...
1496
2078
 
1497
2079
  def remove(self, draw_func):
1498
- """
2080
+ """Remove a draw function that has been added to this menu
1499
2081
 
1500
2082
  :param draw_func:
1501
2083
  """
1502
2084
  ...
1503
2085
 
1504
2086
  def type_recast(self):
1505
- """ """
2087
+ """Return a new instance, this is needed because types
2088
+ such as textures can be changed at runtime.
2089
+
2090
+ :return: a new instance of this object with the type initialized again.
2091
+ """
1506
2092
  ...
1507
2093
 
1508
2094
  def values(self):
1509
- """ """
2095
+ """Returns the values of this objects custom properties (matches Python's
2096
+ dictionary function of the same name).
2097
+
2098
+ :return: custom property values.
2099
+ """
1510
2100
  ...
1511
2101
 
1512
2102
  class PHYSICS_PT_rigid_body_constraint_settings(
1513
2103
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
1514
2104
  ):
1515
- """ """
1516
-
1517
2105
  COMPAT_ENGINES: typing.Any
1518
- """ """
1519
-
1520
2106
  bl_context: typing.Any
1521
- """ """
1522
-
1523
2107
  bl_label: typing.Any
1524
- """ """
1525
-
1526
2108
  bl_parent_id: typing.Any
1527
- """ """
1528
-
1529
2109
  bl_region_type: typing.Any
1530
- """ """
1531
-
1532
2110
  bl_rna: typing.Any
1533
- """ """
1534
-
1535
2111
  bl_space_type: typing.Any
1536
- """ """
1537
-
1538
2112
  id_data: typing.Any
1539
- """ """
1540
2113
 
1541
2114
  def append(self, draw_func):
1542
- """
2115
+ """Append a draw function to this menu,
2116
+ takes the same arguments as the menus draw function
1543
2117
 
1544
- :param draw_func:
2118
+ :param draw_func:
1545
2119
  """
1546
2120
  ...
1547
2121
 
1548
- def as_pointer(self):
1549
- """ """
2122
+ def as_pointer(self) -> int:
2123
+ """Returns the memory address which holds a pointer to Blender's internal data
2124
+
2125
+ :return: int (memory address).
2126
+ :rtype: int
2127
+ """
1550
2128
  ...
1551
2129
 
1552
- def bl_rna_get_subclass(self):
1553
- """ """
2130
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2131
+ """
2132
+
2133
+ :return: The RNA type or default when not found.
2134
+ :rtype: bpy.types.Struct
2135
+ """
1554
2136
  ...
1555
2137
 
1556
- def bl_rna_get_subclass_py(self):
1557
- """ """
2138
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2139
+ """
2140
+
2141
+ :return: The class or default when not found.
2142
+ :rtype: typing.Any
2143
+ """
1558
2144
  ...
1559
2145
 
1560
2146
  def draw(self, context):
@@ -1564,72 +2150,126 @@ class PHYSICS_PT_rigid_body_constraint_settings(
1564
2150
  """
1565
2151
  ...
1566
2152
 
1567
- def driver_add(self):
1568
- """ """
2153
+ def driver_add(self) -> bpy.types.FCurve:
2154
+ """Adds driver(s) to the given property
2155
+
2156
+ :return: The driver(s) added.
2157
+ :rtype: bpy.types.FCurve
2158
+ """
1569
2159
  ...
1570
2160
 
1571
- def driver_remove(self):
1572
- """ """
2161
+ def driver_remove(self) -> bool:
2162
+ """Remove driver(s) from the given property
2163
+
2164
+ :return: Success of driver removal.
2165
+ :rtype: bool
2166
+ """
1573
2167
  ...
1574
2168
 
1575
2169
  def get(self):
1576
- """ """
2170
+ """Returns the value of the custom property assigned to key or default
2171
+ when not found (matches Python's dictionary function of the same name).
2172
+
2173
+ """
1577
2174
  ...
1578
2175
 
1579
2176
  def id_properties_clear(self):
1580
- """ """
2177
+ """
2178
+
2179
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2180
+ """
1581
2181
  ...
1582
2182
 
1583
2183
  def id_properties_ensure(self):
1584
- """ """
2184
+ """
2185
+
2186
+ :return: the parent group for an RNA struct's custom IDProperties.
2187
+ """
1585
2188
  ...
1586
2189
 
1587
2190
  def id_properties_ui(self):
1588
- """ """
1589
- ...
2191
+ """
1590
2192
 
1591
- def is_extended(self):
1592
- """ """
2193
+ :return: Return an object used to manage an IDProperty's UI data.
2194
+ """
1593
2195
  ...
1594
2196
 
1595
- def is_property_hidden(self):
1596
- """ """
2197
+ def is_extended(self): ...
2198
+ def is_property_hidden(self) -> bool:
2199
+ """Check if a property is hidden.
2200
+
2201
+ :return: True when the property is hidden.
2202
+ :rtype: bool
2203
+ """
1597
2204
  ...
1598
2205
 
1599
- def is_property_overridable_library(self):
1600
- """ """
2206
+ def is_property_overridable_library(self) -> bool:
2207
+ """Check if a property is overridable.
2208
+
2209
+ :return: True when the property is overridable.
2210
+ :rtype: bool
2211
+ """
1601
2212
  ...
1602
2213
 
1603
- def is_property_readonly(self):
1604
- """ """
2214
+ def is_property_readonly(self) -> bool:
2215
+ """Check if a property is readonly.
2216
+
2217
+ :return: True when the property is readonly (not writable).
2218
+ :rtype: bool
2219
+ """
1605
2220
  ...
1606
2221
 
1607
- def is_property_set(self):
1608
- """ """
2222
+ def is_property_set(self) -> bool:
2223
+ """Check if a property is set, use for testing operator properties.
2224
+
2225
+ :return: True when the property has been set.
2226
+ :rtype: bool
2227
+ """
1609
2228
  ...
1610
2229
 
1611
2230
  def items(self):
1612
- """ """
2231
+ """Returns the items of this objects custom properties (matches Python's
2232
+ dictionary function of the same name).
2233
+
2234
+ :return: custom property key, value pairs.
2235
+ """
1613
2236
  ...
1614
2237
 
1615
- def keyframe_delete(self):
1616
- """ """
2238
+ def keyframe_delete(self) -> bool:
2239
+ """Remove a keyframe from this properties fcurve.
2240
+
2241
+ :return: Success of keyframe deletion.
2242
+ :rtype: bool
2243
+ """
1617
2244
  ...
1618
2245
 
1619
- def keyframe_insert(self):
1620
- """ """
2246
+ def keyframe_insert(self) -> bool:
2247
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2248
+
2249
+ :return: Success of keyframe insertion.
2250
+ :rtype: bool
2251
+ """
1621
2252
  ...
1622
2253
 
1623
2254
  def keys(self):
1624
- """ """
2255
+ """Returns the keys of this objects custom properties (matches Python's
2256
+ dictionary function of the same name).
2257
+
2258
+ :return: custom property keys.
2259
+ """
1625
2260
  ...
1626
2261
 
1627
- def path_from_id(self):
1628
- """ """
2262
+ def path_from_id(self) -> str:
2263
+ """Returns the data path from the ID to this object (string).
2264
+
2265
+ :return: The path from `bpy.types.bpy_struct.id_data`
2266
+ to this struct and property (when given).
2267
+ :rtype: str
2268
+ """
1629
2269
  ...
1630
2270
 
1631
2271
  def path_resolve(self):
1632
- """ """
2272
+ """Returns the property from the path, raise an exception when not found."""
1633
2273
  ...
1634
2274
 
1635
2275
  def poll(self, context):
@@ -1640,85 +2280,97 @@ class PHYSICS_PT_rigid_body_constraint_settings(
1640
2280
  ...
1641
2281
 
1642
2282
  def pop(self):
1643
- """ """
2283
+ """Remove and return the value of the custom property assigned to key or default
2284
+ when not found (matches Python's dictionary function of the same name).
2285
+
2286
+ """
1644
2287
  ...
1645
2288
 
1646
2289
  def prepend(self, draw_func):
1647
- """
2290
+ """Prepend a draw function to this menu, takes the same arguments as
2291
+ the menus draw function
1648
2292
 
1649
- :param draw_func:
2293
+ :param draw_func:
1650
2294
  """
1651
2295
  ...
1652
2296
 
1653
- def property_overridable_library_set(self):
1654
- """ """
2297
+ def property_overridable_library_set(self) -> bool:
2298
+ """Define a property as overridable or not (only for custom properties!).
2299
+
2300
+ :return: True when the overridable status of the property was successfully set.
2301
+ :rtype: bool
2302
+ """
1655
2303
  ...
1656
2304
 
1657
2305
  def property_unset(self):
1658
- """ """
2306
+ """Unset a property, will use default value afterward."""
1659
2307
  ...
1660
2308
 
1661
2309
  def remove(self, draw_func):
1662
- """
2310
+ """Remove a draw function that has been added to this menu
1663
2311
 
1664
2312
  :param draw_func:
1665
2313
  """
1666
2314
  ...
1667
2315
 
1668
2316
  def type_recast(self):
1669
- """ """
2317
+ """Return a new instance, this is needed because types
2318
+ such as textures can be changed at runtime.
2319
+
2320
+ :return: a new instance of this object with the type initialized again.
2321
+ """
1670
2322
  ...
1671
2323
 
1672
2324
  def values(self):
1673
- """ """
2325
+ """Returns the values of this objects custom properties (matches Python's
2326
+ dictionary function of the same name).
2327
+
2328
+ :return: custom property values.
2329
+ """
1674
2330
  ...
1675
2331
 
1676
2332
  class PHYSICS_PT_rigid_body_constraint_springs(
1677
2333
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
1678
2334
  ):
1679
- """ """
1680
-
1681
2335
  COMPAT_ENGINES: typing.Any
1682
- """ """
1683
-
1684
2336
  bl_context: typing.Any
1685
- """ """
1686
-
1687
2337
  bl_label: typing.Any
1688
- """ """
1689
-
1690
2338
  bl_parent_id: typing.Any
1691
- """ """
1692
-
1693
2339
  bl_region_type: typing.Any
1694
- """ """
1695
-
1696
2340
  bl_rna: typing.Any
1697
- """ """
1698
-
1699
2341
  bl_space_type: typing.Any
1700
- """ """
1701
-
1702
2342
  id_data: typing.Any
1703
- """ """
1704
2343
 
1705
2344
  def append(self, draw_func):
1706
- """
2345
+ """Append a draw function to this menu,
2346
+ takes the same arguments as the menus draw function
1707
2347
 
1708
- :param draw_func:
2348
+ :param draw_func:
1709
2349
  """
1710
2350
  ...
1711
2351
 
1712
- def as_pointer(self):
1713
- """ """
2352
+ def as_pointer(self) -> int:
2353
+ """Returns the memory address which holds a pointer to Blender's internal data
2354
+
2355
+ :return: int (memory address).
2356
+ :rtype: int
2357
+ """
1714
2358
  ...
1715
2359
 
1716
- def bl_rna_get_subclass(self):
1717
- """ """
2360
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2361
+ """
2362
+
2363
+ :return: The RNA type or default when not found.
2364
+ :rtype: bpy.types.Struct
2365
+ """
1718
2366
  ...
1719
2367
 
1720
- def bl_rna_get_subclass_py(self):
1721
- """ """
2368
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2369
+ """
2370
+
2371
+ :return: The class or default when not found.
2372
+ :rtype: typing.Any
2373
+ """
1722
2374
  ...
1723
2375
 
1724
2376
  def draw(self, context):
@@ -1728,72 +2380,126 @@ class PHYSICS_PT_rigid_body_constraint_springs(
1728
2380
  """
1729
2381
  ...
1730
2382
 
1731
- def driver_add(self):
1732
- """ """
2383
+ def driver_add(self) -> bpy.types.FCurve:
2384
+ """Adds driver(s) to the given property
2385
+
2386
+ :return: The driver(s) added.
2387
+ :rtype: bpy.types.FCurve
2388
+ """
1733
2389
  ...
1734
2390
 
1735
- def driver_remove(self):
1736
- """ """
2391
+ def driver_remove(self) -> bool:
2392
+ """Remove driver(s) from the given property
2393
+
2394
+ :return: Success of driver removal.
2395
+ :rtype: bool
2396
+ """
1737
2397
  ...
1738
2398
 
1739
2399
  def get(self):
1740
- """ """
2400
+ """Returns the value of the custom property assigned to key or default
2401
+ when not found (matches Python's dictionary function of the same name).
2402
+
2403
+ """
1741
2404
  ...
1742
2405
 
1743
2406
  def id_properties_clear(self):
1744
- """ """
2407
+ """
2408
+
2409
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2410
+ """
1745
2411
  ...
1746
2412
 
1747
2413
  def id_properties_ensure(self):
1748
- """ """
2414
+ """
2415
+
2416
+ :return: the parent group for an RNA struct's custom IDProperties.
2417
+ """
1749
2418
  ...
1750
2419
 
1751
2420
  def id_properties_ui(self):
1752
- """ """
1753
- ...
2421
+ """
1754
2422
 
1755
- def is_extended(self):
1756
- """ """
2423
+ :return: Return an object used to manage an IDProperty's UI data.
2424
+ """
1757
2425
  ...
1758
2426
 
1759
- def is_property_hidden(self):
1760
- """ """
2427
+ def is_extended(self): ...
2428
+ def is_property_hidden(self) -> bool:
2429
+ """Check if a property is hidden.
2430
+
2431
+ :return: True when the property is hidden.
2432
+ :rtype: bool
2433
+ """
1761
2434
  ...
1762
2435
 
1763
- def is_property_overridable_library(self):
1764
- """ """
2436
+ def is_property_overridable_library(self) -> bool:
2437
+ """Check if a property is overridable.
2438
+
2439
+ :return: True when the property is overridable.
2440
+ :rtype: bool
2441
+ """
1765
2442
  ...
1766
2443
 
1767
- def is_property_readonly(self):
1768
- """ """
2444
+ def is_property_readonly(self) -> bool:
2445
+ """Check if a property is readonly.
2446
+
2447
+ :return: True when the property is readonly (not writable).
2448
+ :rtype: bool
2449
+ """
1769
2450
  ...
1770
2451
 
1771
- def is_property_set(self):
1772
- """ """
2452
+ def is_property_set(self) -> bool:
2453
+ """Check if a property is set, use for testing operator properties.
2454
+
2455
+ :return: True when the property has been set.
2456
+ :rtype: bool
2457
+ """
1773
2458
  ...
1774
2459
 
1775
2460
  def items(self):
1776
- """ """
2461
+ """Returns the items of this objects custom properties (matches Python's
2462
+ dictionary function of the same name).
2463
+
2464
+ :return: custom property key, value pairs.
2465
+ """
1777
2466
  ...
1778
2467
 
1779
- def keyframe_delete(self):
1780
- """ """
2468
+ def keyframe_delete(self) -> bool:
2469
+ """Remove a keyframe from this properties fcurve.
2470
+
2471
+ :return: Success of keyframe deletion.
2472
+ :rtype: bool
2473
+ """
1781
2474
  ...
1782
2475
 
1783
- def keyframe_insert(self):
1784
- """ """
2476
+ def keyframe_insert(self) -> bool:
2477
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2478
+
2479
+ :return: Success of keyframe insertion.
2480
+ :rtype: bool
2481
+ """
1785
2482
  ...
1786
2483
 
1787
2484
  def keys(self):
1788
- """ """
2485
+ """Returns the keys of this objects custom properties (matches Python's
2486
+ dictionary function of the same name).
2487
+
2488
+ :return: custom property keys.
2489
+ """
1789
2490
  ...
1790
2491
 
1791
- def path_from_id(self):
1792
- """ """
2492
+ def path_from_id(self) -> str:
2493
+ """Returns the data path from the ID to this object (string).
2494
+
2495
+ :return: The path from `bpy.types.bpy_struct.id_data`
2496
+ to this struct and property (when given).
2497
+ :rtype: str
2498
+ """
1793
2499
  ...
1794
2500
 
1795
2501
  def path_resolve(self):
1796
- """ """
2502
+ """Returns the property from the path, raise an exception when not found."""
1797
2503
  ...
1798
2504
 
1799
2505
  def poll(self, context):
@@ -1804,85 +2510,97 @@ class PHYSICS_PT_rigid_body_constraint_springs(
1804
2510
  ...
1805
2511
 
1806
2512
  def pop(self):
1807
- """ """
2513
+ """Remove and return the value of the custom property assigned to key or default
2514
+ when not found (matches Python's dictionary function of the same name).
2515
+
2516
+ """
1808
2517
  ...
1809
2518
 
1810
2519
  def prepend(self, draw_func):
1811
- """
2520
+ """Prepend a draw function to this menu, takes the same arguments as
2521
+ the menus draw function
1812
2522
 
1813
- :param draw_func:
2523
+ :param draw_func:
1814
2524
  """
1815
2525
  ...
1816
2526
 
1817
- def property_overridable_library_set(self):
1818
- """ """
2527
+ def property_overridable_library_set(self) -> bool:
2528
+ """Define a property as overridable or not (only for custom properties!).
2529
+
2530
+ :return: True when the overridable status of the property was successfully set.
2531
+ :rtype: bool
2532
+ """
1819
2533
  ...
1820
2534
 
1821
2535
  def property_unset(self):
1822
- """ """
2536
+ """Unset a property, will use default value afterward."""
1823
2537
  ...
1824
2538
 
1825
2539
  def remove(self, draw_func):
1826
- """
2540
+ """Remove a draw function that has been added to this menu
1827
2541
 
1828
2542
  :param draw_func:
1829
2543
  """
1830
2544
  ...
1831
2545
 
1832
2546
  def type_recast(self):
1833
- """ """
2547
+ """Return a new instance, this is needed because types
2548
+ such as textures can be changed at runtime.
2549
+
2550
+ :return: a new instance of this object with the type initialized again.
2551
+ """
1834
2552
  ...
1835
2553
 
1836
2554
  def values(self):
1837
- """ """
2555
+ """Returns the values of this objects custom properties (matches Python's
2556
+ dictionary function of the same name).
2557
+
2558
+ :return: custom property values.
2559
+ """
1838
2560
  ...
1839
2561
 
1840
2562
  class PHYSICS_PT_rigid_body_constraint_springs_angular(
1841
2563
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
1842
2564
  ):
1843
- """ """
1844
-
1845
2565
  COMPAT_ENGINES: typing.Any
1846
- """ """
1847
-
1848
2566
  bl_context: typing.Any
1849
- """ """
1850
-
1851
2567
  bl_label: typing.Any
1852
- """ """
1853
-
1854
2568
  bl_parent_id: typing.Any
1855
- """ """
1856
-
1857
2569
  bl_region_type: typing.Any
1858
- """ """
1859
-
1860
2570
  bl_rna: typing.Any
1861
- """ """
1862
-
1863
2571
  bl_space_type: typing.Any
1864
- """ """
1865
-
1866
2572
  id_data: typing.Any
1867
- """ """
1868
2573
 
1869
2574
  def append(self, draw_func):
1870
- """
2575
+ """Append a draw function to this menu,
2576
+ takes the same arguments as the menus draw function
1871
2577
 
1872
- :param draw_func:
2578
+ :param draw_func:
1873
2579
  """
1874
2580
  ...
1875
2581
 
1876
- def as_pointer(self):
1877
- """ """
2582
+ def as_pointer(self) -> int:
2583
+ """Returns the memory address which holds a pointer to Blender's internal data
2584
+
2585
+ :return: int (memory address).
2586
+ :rtype: int
2587
+ """
1878
2588
  ...
1879
2589
 
1880
- def bl_rna_get_subclass(self):
1881
- """ """
2590
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2591
+ """
2592
+
2593
+ :return: The RNA type or default when not found.
2594
+ :rtype: bpy.types.Struct
2595
+ """
1882
2596
  ...
1883
2597
 
1884
- def bl_rna_get_subclass_py(self):
1885
- """ """
2598
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2599
+ """
2600
+
2601
+ :return: The class or default when not found.
2602
+ :rtype: typing.Any
2603
+ """
1886
2604
  ...
1887
2605
 
1888
2606
  def draw(self, context):
@@ -1892,72 +2610,126 @@ class PHYSICS_PT_rigid_body_constraint_springs_angular(
1892
2610
  """
1893
2611
  ...
1894
2612
 
1895
- def driver_add(self):
1896
- """ """
2613
+ def driver_add(self) -> bpy.types.FCurve:
2614
+ """Adds driver(s) to the given property
2615
+
2616
+ :return: The driver(s) added.
2617
+ :rtype: bpy.types.FCurve
2618
+ """
1897
2619
  ...
1898
2620
 
1899
- def driver_remove(self):
1900
- """ """
2621
+ def driver_remove(self) -> bool:
2622
+ """Remove driver(s) from the given property
2623
+
2624
+ :return: Success of driver removal.
2625
+ :rtype: bool
2626
+ """
1901
2627
  ...
1902
2628
 
1903
2629
  def get(self):
1904
- """ """
2630
+ """Returns the value of the custom property assigned to key or default
2631
+ when not found (matches Python's dictionary function of the same name).
2632
+
2633
+ """
1905
2634
  ...
1906
2635
 
1907
2636
  def id_properties_clear(self):
1908
- """ """
2637
+ """
2638
+
2639
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2640
+ """
1909
2641
  ...
1910
2642
 
1911
2643
  def id_properties_ensure(self):
1912
- """ """
2644
+ """
2645
+
2646
+ :return: the parent group for an RNA struct's custom IDProperties.
2647
+ """
1913
2648
  ...
1914
2649
 
1915
2650
  def id_properties_ui(self):
1916
- """ """
1917
- ...
2651
+ """
1918
2652
 
1919
- def is_extended(self):
1920
- """ """
2653
+ :return: Return an object used to manage an IDProperty's UI data.
2654
+ """
1921
2655
  ...
1922
2656
 
1923
- def is_property_hidden(self):
1924
- """ """
2657
+ def is_extended(self): ...
2658
+ def is_property_hidden(self) -> bool:
2659
+ """Check if a property is hidden.
2660
+
2661
+ :return: True when the property is hidden.
2662
+ :rtype: bool
2663
+ """
1925
2664
  ...
1926
2665
 
1927
- def is_property_overridable_library(self):
1928
- """ """
2666
+ def is_property_overridable_library(self) -> bool:
2667
+ """Check if a property is overridable.
2668
+
2669
+ :return: True when the property is overridable.
2670
+ :rtype: bool
2671
+ """
1929
2672
  ...
1930
2673
 
1931
- def is_property_readonly(self):
1932
- """ """
2674
+ def is_property_readonly(self) -> bool:
2675
+ """Check if a property is readonly.
2676
+
2677
+ :return: True when the property is readonly (not writable).
2678
+ :rtype: bool
2679
+ """
1933
2680
  ...
1934
2681
 
1935
- def is_property_set(self):
1936
- """ """
2682
+ def is_property_set(self) -> bool:
2683
+ """Check if a property is set, use for testing operator properties.
2684
+
2685
+ :return: True when the property has been set.
2686
+ :rtype: bool
2687
+ """
1937
2688
  ...
1938
2689
 
1939
2690
  def items(self):
1940
- """ """
2691
+ """Returns the items of this objects custom properties (matches Python's
2692
+ dictionary function of the same name).
2693
+
2694
+ :return: custom property key, value pairs.
2695
+ """
1941
2696
  ...
1942
2697
 
1943
- def keyframe_delete(self):
1944
- """ """
2698
+ def keyframe_delete(self) -> bool:
2699
+ """Remove a keyframe from this properties fcurve.
2700
+
2701
+ :return: Success of keyframe deletion.
2702
+ :rtype: bool
2703
+ """
1945
2704
  ...
1946
2705
 
1947
- def keyframe_insert(self):
1948
- """ """
2706
+ def keyframe_insert(self) -> bool:
2707
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2708
+
2709
+ :return: Success of keyframe insertion.
2710
+ :rtype: bool
2711
+ """
1949
2712
  ...
1950
2713
 
1951
2714
  def keys(self):
1952
- """ """
2715
+ """Returns the keys of this objects custom properties (matches Python's
2716
+ dictionary function of the same name).
2717
+
2718
+ :return: custom property keys.
2719
+ """
1953
2720
  ...
1954
2721
 
1955
- def path_from_id(self):
1956
- """ """
2722
+ def path_from_id(self) -> str:
2723
+ """Returns the data path from the ID to this object (string).
2724
+
2725
+ :return: The path from `bpy.types.bpy_struct.id_data`
2726
+ to this struct and property (when given).
2727
+ :rtype: str
2728
+ """
1957
2729
  ...
1958
2730
 
1959
2731
  def path_resolve(self):
1960
- """ """
2732
+ """Returns the property from the path, raise an exception when not found."""
1961
2733
  ...
1962
2734
 
1963
2735
  def poll(self, context):
@@ -1968,85 +2740,97 @@ class PHYSICS_PT_rigid_body_constraint_springs_angular(
1968
2740
  ...
1969
2741
 
1970
2742
  def pop(self):
1971
- """ """
2743
+ """Remove and return the value of the custom property assigned to key or default
2744
+ when not found (matches Python's dictionary function of the same name).
2745
+
2746
+ """
1972
2747
  ...
1973
2748
 
1974
2749
  def prepend(self, draw_func):
1975
- """
2750
+ """Prepend a draw function to this menu, takes the same arguments as
2751
+ the menus draw function
1976
2752
 
1977
- :param draw_func:
2753
+ :param draw_func:
1978
2754
  """
1979
2755
  ...
1980
2756
 
1981
- def property_overridable_library_set(self):
1982
- """ """
2757
+ def property_overridable_library_set(self) -> bool:
2758
+ """Define a property as overridable or not (only for custom properties!).
2759
+
2760
+ :return: True when the overridable status of the property was successfully set.
2761
+ :rtype: bool
2762
+ """
1983
2763
  ...
1984
2764
 
1985
2765
  def property_unset(self):
1986
- """ """
2766
+ """Unset a property, will use default value afterward."""
1987
2767
  ...
1988
2768
 
1989
2769
  def remove(self, draw_func):
1990
- """
2770
+ """Remove a draw function that has been added to this menu
1991
2771
 
1992
2772
  :param draw_func:
1993
2773
  """
1994
2774
  ...
1995
2775
 
1996
2776
  def type_recast(self):
1997
- """ """
2777
+ """Return a new instance, this is needed because types
2778
+ such as textures can be changed at runtime.
2779
+
2780
+ :return: a new instance of this object with the type initialized again.
2781
+ """
1998
2782
  ...
1999
2783
 
2000
2784
  def values(self):
2001
- """ """
2785
+ """Returns the values of this objects custom properties (matches Python's
2786
+ dictionary function of the same name).
2787
+
2788
+ :return: custom property values.
2789
+ """
2002
2790
  ...
2003
2791
 
2004
2792
  class PHYSICS_PT_rigid_body_constraint_springs_linear(
2005
2793
  bpy_types.Panel, PHYSICS_PT_rigidbody_constraint_panel, bpy_types._GenericUI
2006
2794
  ):
2007
- """ """
2008
-
2009
2795
  COMPAT_ENGINES: typing.Any
2010
- """ """
2011
-
2012
2796
  bl_context: typing.Any
2013
- """ """
2014
-
2015
2797
  bl_label: typing.Any
2016
- """ """
2017
-
2018
2798
  bl_parent_id: typing.Any
2019
- """ """
2020
-
2021
2799
  bl_region_type: typing.Any
2022
- """ """
2023
-
2024
2800
  bl_rna: typing.Any
2025
- """ """
2026
-
2027
2801
  bl_space_type: typing.Any
2028
- """ """
2029
-
2030
2802
  id_data: typing.Any
2031
- """ """
2032
2803
 
2033
2804
  def append(self, draw_func):
2034
- """
2805
+ """Append a draw function to this menu,
2806
+ takes the same arguments as the menus draw function
2035
2807
 
2036
- :param draw_func:
2808
+ :param draw_func:
2037
2809
  """
2038
2810
  ...
2039
2811
 
2040
- def as_pointer(self):
2041
- """ """
2812
+ def as_pointer(self) -> int:
2813
+ """Returns the memory address which holds a pointer to Blender's internal data
2814
+
2815
+ :return: int (memory address).
2816
+ :rtype: int
2817
+ """
2042
2818
  ...
2043
2819
 
2044
- def bl_rna_get_subclass(self):
2045
- """ """
2820
+ def bl_rna_get_subclass(self) -> bpy.types.Struct:
2821
+ """
2822
+
2823
+ :return: The RNA type or default when not found.
2824
+ :rtype: bpy.types.Struct
2825
+ """
2046
2826
  ...
2047
2827
 
2048
- def bl_rna_get_subclass_py(self):
2049
- """ """
2828
+ def bl_rna_get_subclass_py(self) -> typing.Any:
2829
+ """
2830
+
2831
+ :return: The class or default when not found.
2832
+ :rtype: typing.Any
2833
+ """
2050
2834
  ...
2051
2835
 
2052
2836
  def draw(self, context):
@@ -2056,72 +2840,126 @@ class PHYSICS_PT_rigid_body_constraint_springs_linear(
2056
2840
  """
2057
2841
  ...
2058
2842
 
2059
- def driver_add(self):
2060
- """ """
2843
+ def driver_add(self) -> bpy.types.FCurve:
2844
+ """Adds driver(s) to the given property
2845
+
2846
+ :return: The driver(s) added.
2847
+ :rtype: bpy.types.FCurve
2848
+ """
2061
2849
  ...
2062
2850
 
2063
- def driver_remove(self):
2064
- """ """
2851
+ def driver_remove(self) -> bool:
2852
+ """Remove driver(s) from the given property
2853
+
2854
+ :return: Success of driver removal.
2855
+ :rtype: bool
2856
+ """
2065
2857
  ...
2066
2858
 
2067
2859
  def get(self):
2068
- """ """
2860
+ """Returns the value of the custom property assigned to key or default
2861
+ when not found (matches Python's dictionary function of the same name).
2862
+
2863
+ """
2069
2864
  ...
2070
2865
 
2071
2866
  def id_properties_clear(self):
2072
- """ """
2867
+ """
2868
+
2869
+ :return: Remove the parent group for an RNA struct's custom IDProperties.
2870
+ """
2073
2871
  ...
2074
2872
 
2075
2873
  def id_properties_ensure(self):
2076
- """ """
2874
+ """
2875
+
2876
+ :return: the parent group for an RNA struct's custom IDProperties.
2877
+ """
2077
2878
  ...
2078
2879
 
2079
2880
  def id_properties_ui(self):
2080
- """ """
2081
- ...
2881
+ """
2082
2882
 
2083
- def is_extended(self):
2084
- """ """
2883
+ :return: Return an object used to manage an IDProperty's UI data.
2884
+ """
2085
2885
  ...
2086
2886
 
2087
- def is_property_hidden(self):
2088
- """ """
2887
+ def is_extended(self): ...
2888
+ def is_property_hidden(self) -> bool:
2889
+ """Check if a property is hidden.
2890
+
2891
+ :return: True when the property is hidden.
2892
+ :rtype: bool
2893
+ """
2089
2894
  ...
2090
2895
 
2091
- def is_property_overridable_library(self):
2092
- """ """
2896
+ def is_property_overridable_library(self) -> bool:
2897
+ """Check if a property is overridable.
2898
+
2899
+ :return: True when the property is overridable.
2900
+ :rtype: bool
2901
+ """
2093
2902
  ...
2094
2903
 
2095
- def is_property_readonly(self):
2096
- """ """
2904
+ def is_property_readonly(self) -> bool:
2905
+ """Check if a property is readonly.
2906
+
2907
+ :return: True when the property is readonly (not writable).
2908
+ :rtype: bool
2909
+ """
2097
2910
  ...
2098
2911
 
2099
- def is_property_set(self):
2100
- """ """
2912
+ def is_property_set(self) -> bool:
2913
+ """Check if a property is set, use for testing operator properties.
2914
+
2915
+ :return: True when the property has been set.
2916
+ :rtype: bool
2917
+ """
2101
2918
  ...
2102
2919
 
2103
2920
  def items(self):
2104
- """ """
2921
+ """Returns the items of this objects custom properties (matches Python's
2922
+ dictionary function of the same name).
2923
+
2924
+ :return: custom property key, value pairs.
2925
+ """
2105
2926
  ...
2106
2927
 
2107
- def keyframe_delete(self):
2108
- """ """
2928
+ def keyframe_delete(self) -> bool:
2929
+ """Remove a keyframe from this properties fcurve.
2930
+
2931
+ :return: Success of keyframe deletion.
2932
+ :rtype: bool
2933
+ """
2109
2934
  ...
2110
2935
 
2111
- def keyframe_insert(self):
2112
- """ """
2936
+ def keyframe_insert(self) -> bool:
2937
+ """Insert a keyframe on the property given, adding fcurves and animation data when necessary.
2938
+
2939
+ :return: Success of keyframe insertion.
2940
+ :rtype: bool
2941
+ """
2113
2942
  ...
2114
2943
 
2115
2944
  def keys(self):
2116
- """ """
2945
+ """Returns the keys of this objects custom properties (matches Python's
2946
+ dictionary function of the same name).
2947
+
2948
+ :return: custom property keys.
2949
+ """
2117
2950
  ...
2118
2951
 
2119
- def path_from_id(self):
2120
- """ """
2952
+ def path_from_id(self) -> str:
2953
+ """Returns the data path from the ID to this object (string).
2954
+
2955
+ :return: The path from `bpy.types.bpy_struct.id_data`
2956
+ to this struct and property (when given).
2957
+ :rtype: str
2958
+ """
2121
2959
  ...
2122
2960
 
2123
2961
  def path_resolve(self):
2124
- """ """
2962
+ """Returns the property from the path, raise an exception when not found."""
2125
2963
  ...
2126
2964
 
2127
2965
  def poll(self, context):
@@ -2132,35 +2970,51 @@ class PHYSICS_PT_rigid_body_constraint_springs_linear(
2132
2970
  ...
2133
2971
 
2134
2972
  def pop(self):
2135
- """ """
2973
+ """Remove and return the value of the custom property assigned to key or default
2974
+ when not found (matches Python's dictionary function of the same name).
2975
+
2976
+ """
2136
2977
  ...
2137
2978
 
2138
2979
  def prepend(self, draw_func):
2139
- """
2980
+ """Prepend a draw function to this menu, takes the same arguments as
2981
+ the menus draw function
2140
2982
 
2141
- :param draw_func:
2983
+ :param draw_func:
2142
2984
  """
2143
2985
  ...
2144
2986
 
2145
- def property_overridable_library_set(self):
2146
- """ """
2987
+ def property_overridable_library_set(self) -> bool:
2988
+ """Define a property as overridable or not (only for custom properties!).
2989
+
2990
+ :return: True when the overridable status of the property was successfully set.
2991
+ :rtype: bool
2992
+ """
2147
2993
  ...
2148
2994
 
2149
2995
  def property_unset(self):
2150
- """ """
2996
+ """Unset a property, will use default value afterward."""
2151
2997
  ...
2152
2998
 
2153
2999
  def remove(self, draw_func):
2154
- """
3000
+ """Remove a draw function that has been added to this menu
2155
3001
 
2156
3002
  :param draw_func:
2157
3003
  """
2158
3004
  ...
2159
3005
 
2160
3006
  def type_recast(self):
2161
- """ """
3007
+ """Return a new instance, this is needed because types
3008
+ such as textures can be changed at runtime.
3009
+
3010
+ :return: a new instance of this object with the type initialized again.
3011
+ """
2162
3012
  ...
2163
3013
 
2164
3014
  def values(self):
2165
- """ """
3015
+ """Returns the values of this objects custom properties (matches Python's
3016
+ dictionary function of the same name).
3017
+
3018
+ :return: custom property values.
3019
+ """
2166
3020
  ...