From 882d2a85bcfe031914d2f59c144b5a241afa4534 Mon Sep 17 00:00:00 2001
From: kit <kitbdev@gmail.com>
Date: Mon, 18 Mar 2024 19:36:59 -0400
Subject: [PATCH] Add intellisense configuration for VSCode

(cherry picked from commit cf54259ff05e47f0edd5e329d32584f230a36880)
---
 .../img/vscode_edit_configurations.webp       | Bin 0 -> 3544 bytes
 .../configuring_an_ide/visual_studio_code.rst |  54 ++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 contributing/development/configuring_an_ide/img/vscode_edit_configurations.webp

diff --git a/contributing/development/configuring_an_ide/img/vscode_edit_configurations.webp b/contributing/development/configuring_an_ide/img/vscode_edit_configurations.webp
new file mode 100644
index 0000000000000000000000000000000000000000..ba64ba19970ba7a2576962a7ae8db7b0f28a9152
GIT binary patch
literal 3544
zcmV;}4JYzaNk&G{4FCXFMM6+kP&iD)4FCWy^nx4!^;m!YUzOwL&nUcXm>F*I6~AI;
z=7yQe+=iLiQkj`yrE&RHq?P=t%$9<dMtgqW-|wEeGu!o?@^!pg*`d*0vNhM1!m*=?
zWz~u|?8pk7GIwuQR_K)ONYijS8`pAW+cs^hU)#2A^COg6v2EMdvu)d0!L{{lTpN;Y
zZ9DendSm>E?c_sj+qP}hc025UA|2@jGOX=UY}-!%Wzn`3w9$DD$xDd6K^{CX)A{$H
zdrepa-0H9ztO_$%ft6uwB|uvdrk%C|O!MumX{e2&jg9?p=FD@f>z-hbAjnQI+XlY{
z9!yNQbLbJhwmc|X4$QStP|-{DK;6Ubgyj({AXY>eaf@U6q37rpFNatPu{dHegaNm+
z@AxPE&~xfGd`HQc+a1Gajnch(tZoMVCqB#4efZCkQMZ4_^g7&|^*iu~&o=9vJ$#Px
zZyGKcb{n2)>^b4b<)L@}U0}^$`WGI_+^VG3WZSGxU1mL6_}>#uwpC~8a&Bt2?Ocho
zeu@+s_?iC{0lWpGG<`LE1~!ABcsRTd!l-@DpkXE;k;WLX!B4=`A&~oh0GuClruI%~
z7jR)14l2t1VHknaUyi~s<PQeJFzl_RwO*z#iX4b)pF=|0``c5Ha1iu5^I4Spc`Ui!
z8Y~FP{f+_;5eqk`J*`czmHT1g;1r=tYrPRG6!?ZHG@1B6D1R8*F`II|HLBuIxqpzy
zBzs@fTLWzpQ3Oer5ryUps2`F=Y2;Ep+D}6Pk>e_&DD|V(J7`deLMH~38K>MI4*H}`
zm@U<M190?+K%g_JZ;L3bb_H4m%T?O@+cm2UraGj9p&_l}^PAw66jl{3Vx*C9AQy(A
z!=2PQ?Wq>Ho4OsCOs9~oW)fKf7KcS)5x5&n6~I(u*cpVZD@qMJ?Q?KBV&a`NP1B#M
zjXD1l;Xau2{|v$hbN=7{{LFuTDl5w@YF3@}^hAIsB!g||pKv?pMX)72Uu9L`c5A%t
zc3vz_?DG#+1x_&EoS@~LZ@xL7@jT6W5o^GW@uDUE@^tkDlgt4z@rQ4j94=vUxWvT)
zRzrbs?z6wyt}nB(h%JT~Pb9tZt^HG!&+Md=A<fEb@7{1|p4Bv34qH#;>@cPCeoKLH
z-#Hf}%#06S4b5(Hl<d|4hD(#5`Ng*Jtojv$xh)40zBOZ?<>Z5wbC>1H$R;xDi`wz)
z0%x15I}OFP4aLdch-8P|-gR-_fE2J+cdR#HXh^DcYn|T+j;6=n&C1hWuv8qfZCXxt
zaerHvAHh;-GMn_deO~Y6>tnWAXpu60tL+>6*6^4lnXI|=k@2AH=867~{5E~svWp~1
zf*rXnyEyM9O7!^>W$&<hnKO^R__QIT){&hk;fZT|r+28Ter%g}%{iwZfx}L*R?j`>
zwmB>p6rM0-CyCkFfg?4ZRTtc_ZCcL4@uHH$Zu%^^q4(Xl!@kSvT4oz|t&aSrdDB^T
zgQm)s&&J<XpT8lGRI<!pZEaVx*uEMx#1wn6we}q$k#S)77D~^8e@oJGq3aeB<OxGS
zMOU-X!~vceU+moK)x`tU2l9-4#FfsY#?3x%J#3kIqI~i*&n#On@f^1K0y?BLKxZfS
z`)t(1hU6eP(a-T!K!HTky0$IN(P!J9a0^xd$nEA21!^(L22cFHeBU?A%36LKcE(;$
z)X)Dj-An%HGP`elQg)L`rsI!Tw9Fe6TVmj02bDkSxW9z9>eT{5?sV)nb$5ueJJuVx
zb_>oaEN?nd&Y>ELiy!^K4AqvMo5yCKGf@3n9ru)|wNCbtg1ODg(>Fj<s59~oMc;+h
zt0BP~$Gnf_OLJKY*!KTzUBY{kBxXwRgph21pdnkobp5W;a_4u+xQ%)!Jr_EMprcZ6
zOA^+Ls#h!26Bv4Igv4$F{R?^uX7!-EF7mp}td`%#NsH9^*JZb-ygKP(Nb<iVzHIdC
z^O}|&<K!sWt=HNA&J#XaN7wJhVL%QJ=P<;`eBpVMFq>cwM(kZ&2MT059LVxvAw*Q8
z;;^-Iv+Va#WAN}9>w`p439DWWn&`wuO&gP}X=1AZxvgQw`e59K1s`;duBQ3D8w4Gd
zBv#VuQX%vs8PZL1p|{WyFzSgZ@Hk3wc5!7hFYRU4dg5uzi17z4f7=f>heBW4;7MKf
z!+u}hSa5@^fnLfLYpoBFb@Nm-F}lHFK8K>|L=3(uV7+<FAuuY-zKly#pa9H=k}%RE
z#uBxe1~84chN)wI0%sYL7Ey<-urW_?pnpXt_xV5_MApGlgGvr~B5AYt6(fCxP*h?o
z7hS(gz+zE?&eI)`E^SkF#}}W1X&Hvlgs}5LMdcalbI1;Bcs!0s+wp9jPr?9dk~l}A
zlUv2ae6ukb>x0fA=}^?IFVV^Hk`E-b&ih)D)G=SMvUAioGjKk2B}h5Fmp$Uj<-?~;
zlB7jyH&2c*{)$Jg2Uwg4fuxTuD@9B}jzm_U%2=N&as*S(xJV!t`>&`&2hda*w?2UW
zq%O$T!P-Y$iJo*(IqLwYAv<G-Ys$O->vxdcz09uFQJ?+5myM=3_+b%b6}=fzng%I9
z510<;&QK|o799?LqP=tDx+O=q;0`+*3jv5aeMbh?$PBjF0nM#zCzj5>1qXHHKwI<f
zv=?m1PR?I#xlGpmQC-wC&LG`gzmwUZsqVtbhBKbBWSM>Zc<52Gs~b2h<?%pK&w?A^
z`T&l^v}75F>jME*ac8i_u|Nl05fHYDK!sFA52jB6Yo@N>C2}lPl5sj+QWZE05_2)A
zq%kS#spFYyT~~=MyRZ~pWO)^)LxSoux|)Si<B|&tBDUtH<6Z*l@Pbw2S(iTBw$QhV
z^+e5A-nzC(t#9D5WDhtO*|c%;62oD;O<DTa=QWL*OP;pW^}8m$$-n05O0bmk#cV0f
zlR3Q}stHAnn<qH9bJ{IkA;3$$Wei76Q0k+vJ_QAHlVogLmvD4g3%tWh(=$#2@IbhY
zR<~9}xQvazg)MyQ*0!z>6!Q){*2g+W%yo#^3LeP9s3{HiNfK8S3t4xsB#E%9h<%)Q
z^h9PiPd;LHGWnfLl6=teoBeN+G%IgU`s<tBq|tK1+mQk!hXxzBQ?KzgNkLv&hl^rG
zh~;kxobm3{Vcp--+SpQEfBs=MqxQ?!<*yjbZ8?zIJgZR$u=!>x&ptX%v=;VI3*Zw}
z>U!;23{XHr;EWxnbl#3++YVPap1f^w_>yI8JyEmQg2`nzP=5FrUKGpoy);AnpTlC|
zi*9;DU?KeDm1zL<xQMo>XRNSy^347}NWUxG1?~)Yf)0cJr$=NA`X8B+G3b9zP{y49
z;n<(~&yP8>$;Ah*p*U(W38Cuk*$@=8RyVR3&l?JB-P2#b4URXCdVg4DY_T9=V0aSf
z^VAnfnRPM{hS-sZGV7CzMF{HEp|Te_zQ~ye&OU1>s)a8ik4h{?_nx&~s;VEa?YTwL
zM)Yrrr$2k(+$LA`1;t{tWInK){U@q7z#1>Z<Pd0qW(5Txr1YW_LGy+dBjv+$+Bcg0
zFM@diTyok|VPnvylX~EBAD&wq0u3?6UQ8V_4h+A7^h~KLNy~-#5eW*aIPMQ|VDVTj
zAs9?=9KBHN_F4@g^fK%}HSj%zU6nx*S^V-6SQgfRE#SeR%Y-;?*D@dWZ<Bgq5RCdc
zehMIvNZS0@_9p4`+CyF?umV7CH-x52K79`G=2h&bY1BP{KzkRxyc|4u5NryofF6Fa
zHBt5Ngq;Ka5+>#i2?)8<$R?K_D3pMa`4P-1JZ~D6bEt;m{0GjDp<1Q0%x0gfP<^UI
zJ^e*DDL8q`hi1W&S>Jz=p<8Ah^#MC6zr(z5H~UXGeVmLrk`ngRK<~^4lo+O@3Xp6>
zh%pq4V(59*Y5)npt!M{2o;Z*Xz+fI6&S8j==`cSMj)Q8P8zuIvuK@)zsRLO)WY&R*
z+D-G5YMAM_VPgOj({F=BPzh7@PM&@n1WoOY2mebY%nF6^V<L=&xrqrNRJw(bTLe4T
zz6kssVNjMe&`UYMpZ39))O;~NVxYr(fz-KC2tEbYD>H|{sJzsd0ci>pfC!O<ksfih
zU~PutXj+O<3J*lCmw@$2(aYoElGE0PUj|Tg#$q2N2_aZ4O3-;aRq2unF+Y3?uH`}q
zO$a+5R8(H2K8NhEqz8{9!Iub~F$n{xNn$-pFiZItFhgQncg98Wfu0Xq2r0FA<Z6J$
zC<Kx|rAw6}rXWXbNfWl$Q**fjn?bP#Oo03}qMj<M>CgiDo?N>``FX(54!=sFv`BHy
z{GUDRf<#BR;0{~bb^{PK`i=}N`WfQ*0kTL0f18kRU6EOz1gDs%RCCl*kDD=s`;2@;
z{p2{9D(W@1I2K5qb0gAL5vh=>Xu|Xnwaf<~Pm*J)GaR70QWdy5CUNqBwA0lYv$#@A
zZyYy#uMZ4h!?G&H{nsBlVU++&X_kZIMN|#b1R|--9kz2?;#UYj8i~Ph)C8rXf|J8=
z`uXUv7I=~4g;NZ5^8-!b#;Aa>cgo(YLiI)`wjGmDEtMFgmL13deCG##<<x7!nk3H_
zTmT7yS!|=deKhrwj+Sr_wE(QM8Wi9gzOOXnMX`YH1Nov`a9^mXmW&`HhW;O~{PYNx
S!`Q>@KA0PAyJfoBFNOh<^5PNz

literal 0
HcmV?d00001

diff --git a/contributing/development/configuring_an_ide/visual_studio_code.rst b/contributing/development/configuring_an_ide/visual_studio_code.rst
index 77d1cd52b..102363e37 100644
--- a/contributing/development/configuring_an_ide/visual_studio_code.rst
+++ b/contributing/development/configuring_an_ide/visual_studio_code.rst
@@ -156,6 +156,60 @@ The name under ``program`` depends on your build configuration,
 e.g. ``godot.linuxbsd.editor.dev.x86_64`` for 64-bit LinuxBSD platform with
 ``target=editor`` and ``dev_build=yes``.
 
+Configuring Intellisense
+------------------------
+
+For the C/C++ extension:
+
+To fix include errors you may be having, you need to configure some settings in the ``c_cpp_properties.json`` file.
+
+- First, make sure to build the project since some files need to be generated.
+
+- Edit the C/C++ Configuration file either with the UI or with text:
+
+.. figure:: img/vscode_edit_configurations.webp
+   :align: center
+
+- Add an include path for your platform, for example, ``${workspaceFolder}/platform/windows``.
+
+- Add defines for the editor ``TOOLS_ENABLED``, debug builds ``DEBUG_ENABLED``, and tests ``TESTS_ENABLED``.
+
+- Make sure the compiler path is configured correctly to the compiler you are using. See :ref:`doc_introduction_to_the_buildsystem` for further information on your platform.
+
+- The ``c_cpp_properties.json`` file should look similar to this for Windows:
+
+  .. code-block:: js
+
+    {
+      "configurations": [
+        {
+          "name": "Win32",
+          "includePath": [
+            "${workspaceFolder}/**",
+            "${workspaceFolder}/platform/windows"
+          ],
+          "defines": [
+            "_DEBUG",
+            "UNICODE",
+            "_UNICODE",
+            "TOOLS_ENABLED",
+            "DEBUG_ENABLED",
+            "TESTS_ENABLED"
+          ],
+          "windowsSdkVersion": "10.0.22621.0",
+          "compilerPath": "C:/Program Files/Microsoft Visual Studio/2022/Community/VC/Tools/MSVC/14.39.33519/bin/Hostx64/x64/cl.exe",
+          "cStandard": "c17",
+          "cppStandard": "c++17",
+          "intelliSenseMode": "windows-msvc-x64"
+        }
+      ],
+      "version": 4
+    }
+
+- Alternatively, you can use the scons argument ``compiledb=yes`` and set the compile commands setting ``compileCommands`` to ``compile_commands.json``, found in the advanced section of the C/C++ Configuration UI.
+
+  - This argument can be added to your build task in ``tasks.json`` since it will need to be run whenever files are added or moved.
+
 If you run into any issues, ask for help in one of
 `Godot's community channels <https://godotengine.org/community>`__.