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

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

Potentially problematic release.


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

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