From 480bc61aeb110cff4c80e665929a64676a09f0dc Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Fri, 29 Nov 2024 01:51:44 +0100 Subject: [PATCH] Add a page on the Output bottom panel --- .../scripting/debug/img/overview_output.webp | Bin 0 -> 13636 bytes tutorials/scripting/debug/index.rst | 1 + tutorials/scripting/debug/output_panel.rst | 93 ++++++++++++++++++ .../debug/overview_of_debugging_tools.rst | 8 +- .../gdscript_documentation_comments.rst | 2 + tutorials/ui/bbcode_in_richtextlabel.rst | 7 +- 6 files changed, 108 insertions(+), 3 deletions(-) create mode 100644 tutorials/scripting/debug/img/overview_output.webp create mode 100644 tutorials/scripting/debug/output_panel.rst diff --git a/tutorials/scripting/debug/img/overview_output.webp b/tutorials/scripting/debug/img/overview_output.webp new file mode 100644 index 0000000000000000000000000000000000000000..eb1d50880734dabaae3adebff8af00a0f436f634 GIT binary patch literal 13636 zcmYj!V{|55to2jdwr$(CZQGriQ)_BX`P81;wr$&;+Pd?8-;aCqCs`|JopZ92mF%d> zNJ{c^003GNqRN`e-11ESY^KJa!T=4pkmfjYioF@1ybe5qpvVls;RQg}y>~nH&qlGi z(nsyV)I~)^)Vi_dtyUj#8NN>Q)?=OJ(DJoj`Q6eqo{B&ifwm*t5;nu%lkb%)hx?w` zq}95C$^V2UG;`wr8IzOzmL>0B{zA{!ZB8RsZt?g?3`7W|JOoY_j$j8E`p(z4zs4sw z+hxbDGSxES5|N_-VlQa4yS!-v(N(?YKsM@@r&GcX0yb`or#Y{CZmC3l37_GcGO4*ySeC$1f ze8=7oEcOHO@>yjUEXoDx4a;%nluG6q-kqT2Xg$T)cpw~GO*0(ZLW+svcy+9UU{D*p zr_06iyyhPEz@&4(IV_tSYq5?y**_GhR+7LOU8CfR?mS@<)wRtgdAP0s_8Zb^45$DR z)oPoxBCPH=q^LM@i6pynD;m2@BqR4i2R(N#jHt~2l{!dGvA3u9=S!sbnM*3| zqv>6g$gQSrV~HWLnLV6kKBqd5mmzk_8~6dRV_&C@Z~iVI;0HMIh3-2u>x8B{Q3p zJ=X3j5HEk0pcRn5i-=zd+dww*6Bge)la}I^4CVwq8u`&M!D;xndt09D!Y~8D$CXAoF&0(fE?gUccaft(Qhz?v^c%c6X;H z>0*khHyNB#Q9w{X1MR&SsasY_1rw&KcM<7-S3vtgc0A-LECL$)PBRQq6Ez@73KdID z_4-A3k0l(Uk$o4|%C(-VjMm%Jz#c2)6MPUV-V0 zV41N2tHJWVWncRs(gODyv$C{?7iB{hD$)jsw`D(*c?%e7>icD_4b8C0zK0OYHgEkv z%^i!$n?-59Xsk98YaET54NHoU7W=wpAM#a#+@a2LUfNkjUoj>K2wl|FX8*Am=~;u|oOIL6Ssk%0QMgaQwVo*$doRY@`(f{J(gkm&F%eG^{+2CfwPgjE8J?#^wVSY=+kBbq z%45t$jw*`2PsV_7a+invf$e83_`M%fX!@Sb4OR#llNwcf7Nt$rg6@S6FoL<_c;p_P z=8ZQA)=GKgUf~Pogy1m;Ge+>0x%8D z$}K7R^}FkyKYgp6--hWcs4zERxrG?B49S1?sq{n1XC3CmIS!KbBQ|=DFBDjAP4h!7 z2WMcmN%F(?cFZ2ZI?reO1 ztp<@4aNmt)4fs;269D?KB#R?va#|Izn(t@2oI1g}eClhyIA3^E1G@X%Mz2CEb9vas z1C^HfCg!GYmnl%c6(`DuoWG!Eo4#(L`J-@%LL;$66&c?YdKXXCSSt)Hfe1|}c5)h2qlF~A>-?6?AB?(9rvDuq1oR<-1m0vLASD)R6_ zI#TTX;806Cib`*{P^4$)_?8qX@X-M7iBnDhKp(JDrB~Wfy`pv2`@BUU`KJdgIb0|H znL{d%W)4nZholi5dbC74oev5GkRTvJFQ;GXyc{*#VVm+9y2ZEr9=I@qT4>55U{ZG` z@z;Rr6!fJ|GNUT}{#0Cm%vcGrB+RACO%S*1e(U(m|3ju8-G;!>O*|efbX}xnbX_ZB z%T%>QXx^|Z)t~+D>GNCL-XlWfC8S_gi*I9o%stm$Dbf%;6EY&cF!|4TLYx((X)#*N zZs7NnR1Yi|z{n5~x~VCI^hU6@3P9G6h6jZPrq=$tkohPYGzrpZ{1sW+P>ZYwJ9(G` zqPRGRb_);}*t%wSp)lQ~P75OQ^JlPllJ$kA4UM0QC*ozSFyO1<;9KpeXV1g?R_TYWx!X zw9!^EQyjIIHklRb6%XDvXg4jNls-T`mC%6#t5kOktGq%rwdUirk*1YVZFwbad!NKx zurP!?a&?wZ`vYh7ub3OXnr;L$_CXVmz)13sgQjgz3|H3 z7Kss4U+R$E&oh{{m~heWrl}c*rxj_~uqT0y;p2MA;xIg5Wgs zn&b1WbQvp^C@<79LvW+y0U76(%#~?_TjnqKE^c~yW+>`Cq*(g%i}!MHz!sWEn8J)A zIEew*+Z#b`-!v~ud3G?!s2w%wA0$8$reDf|vXRlwR2g%ZV&0JWmNSkkU(OZG1{@}y z(z>==8-LbJBE6JVe%Q?n(O*8)c6>Z`|IN|tnV-%AQ90(PLBAr5Ve1RXj*c*~wS@rp zeuvKiH8;{9?&CZFVK!1b9{iN3k%)%QT!>Lax?ed6$g+G}G3-~i#)49PSGA!MjSc?0 z5la1CO52k=_o9x?gZ9(XkbpxQfyQZGBtSjCrcEek%ZlJ`hVX;A7agD=1HCFoVMeTH z0{}>>g9{&=>cqT;D!3EC*+476!gFt>$yqLkKl5szAMjSwsoy;<)!e?Z{OesSah9-f z*CT-GR?OozHA&D-`NsEl8}GS&L3*m|lr!C6X&x5|wS~XTp$xE?QX9GJq-n=h;FPdy z4x56%{QIN-3~Qm;f+iGGw1HulKOh$)`)&Hi+9C)SA&uPBi-u9jTxKrOJ#`<81I4Qi zdpr2O1pe6Fx-8fY_7y=JrJQMPFaOS3HKiP<03KYc@4rFJM^G|gZk2O=BK_Mw9BehS zY2*F{KG0d*VcGhQFYTClcEOsk^#?A&v?CS)c7tAks@TK+-wsM*w+o>Atd6)6V@n_jSCuyC- z8hwzz;`OYlv;%nlNh9=M#}Np?tz);_r!_0#n@d?UXszXl=ZaHuZzq2u*4^f7r2V1X zz*J@#9__pE*cHf%2oi^W5MF#EtKwz6B*h!qI5pn-i>q?^DAXXSl4*hCC94vES1Bdk zHh<7KIQQ>F60O01I0c1$tRg1o{P=nvxSd*aU?Y3-uR25Nu$b;#-HUMx`p7@%jI8+- zfeG46*=l?)z%BnbOJej1np@C#=?kbX9?#aElb@p6CmQusBvce(E^EtjwFyJ<(qGT& z&%9^5rY`-g+{p=VSPP%&*W*A-4NhWRbirtF{d&`}X2QI|yX`T^?)0^5DPT&dP<>no zm%JmrgjFQ`GBfLIDMSDOe#}SRl;wl5#&$utwGt1T0>?f6F@|1Hvm+#XO1z{SD&uT<-6<%B`B<;jOIutetV$AAhyVq;@faBh> z!76h^<^x*dEJ7&k@e43km0z|yhOj}I(eJk=H2akkuHT)RJ;`sRx0Y2FMJi>Q`OSY~ zsXVmyGJV2-XUGN})!oa26Ly%!Nn`UO`b(0m;m%AvwNa&$cDj55aLyGBCiU!Ujs#5b%Jg53)Mxc7czwv z)V!Bu(hlnyd=9_lNahh4Hqm9m+wJmXw5T7bZz{s3e`gl)k1l2(uUpJ#0@~CCHSN+K zv}7fRo+msFHI0t6F#z!0FP7@vWk!2{usf530{hD)v+xYw>NbBD-9>}bUa>EdXKFRL zJBr2hEYm$ZW&9-&*3P}M@vcWzG7gG9Y1NHV1w1K$uZUes$I%5EIaagj43zA1w7(Rp z>hP2*+A~>jRo`j&-+ebq;afpjtT1F9;?}fz7KKB_KCpUVvC=+PVC zkOrCB{#FftOzL~NA%Y~>OCAn#K%qm|r$~pSv$R8pUBQQ8&og8&*a*%i0M_wby=u9_ zLUvhWv+E&hHUMVpKaN?tujBDQ&n57K_XNG}4|DzH3whs#9!I~8B3tycRr|R#uNT94 z)cOK2my-8KV7z`zmSD+HZZ`QVEyJkjx><>y&y~C#e@o5;#^g}JzfE>bZ>tES*PgV< z-kw7qe$(@TIhXKR?r=x0MO?HWCS@7E)>oZV#u!2L)+j)(u0R2pXfOf4a?-nMW0hePwPG<;;O$8$ak_wwH*7{31$nb=K{h% zmFr%H`RU7XmYAZ&Wh}1gkZrU08%I|lD{wpi0{&LpqnP-3q;v$58nQ3DlSl?RUy(~A z%%#5_ebcJ$)hLPczo@CR8B!j%moNRfTcm4^I&ymCb}<}6*`ym+P6H|ff*cvtg# zxlfII+fPZ6UQhGWpij{kDEidVN6wvGND`d2HzU~+mQlt0i#B^oCOnGYwW2_(Ot>K? zZB6P}08a=7%UQWLM$F&gV?j)3<(#7j@;K`QMDdSSX3$G}R-hulJGn04#eV zthT!S@u9fV#XTlue$4TA*zYqe!15WAxX1~A1${;W5c~erEos;yi_bnlfLDG?Xfnjq z9JsYN`~M_(c%PKitxczCMrneU)wi?8pRAWGb#M}`CCp-qr>Mg76Zq#_Fp|-;5)+#5 z-T81@${As$K4W9`qc9fUejz-ewu=SJ&m;7hwIY%F*$liD`n`c1lFz|OqM(0XADK#~ zW0P=-d+3xFfW|asA?9cPnF`pwivUa>wJ1M|dlzR*3XjT|CksPr&bA#d3vz&h8@3yh z=El5Q20g%mbF1{EMMCAD-`)wLX^~2Wtn>%BX_IK_+gr;3X6MLE^sO|IZ!ZNvb_d1| zK{B*>Edr$u=}`+NAYr%QI!ICcx9V(Bxdhr!!#K1eBl6j6*LeVdEuBBVg7en9rDcR^ z6Vv8`)%*nHNLuKdFI48ERcTX;ZfEk$v>e#u22q2W=ge&bDrRAU4S%3lI`%g@}bR$j3Ajod7S=Sz{+3MEpE76ckp}V z>#^tm=@Jd`(qyM+Lujalu-YJ3-x5s-5+p~b9k3_P@5ml>qx56u(`ovzj@DF{JHES2 zJ=6rnmD%52V!nwpnZxByDip0=ZQA7|8(&@S!KWXVXY~3Yh6HL|t;Yyloi8ylJe>EOU$YIJnM$ zv76+M$1T*539I$au?|RDkS0ZZf`BrxPofc+8I>1iyE;W&6(P59H(J2Sa?_BBmjPbtXJnZbMWy>Cgo$ktKBMKX!H@qBjW)*F|atX};Vg$w&% zuwlOa3ig3`Xn|W0fS2-vbl@oppZ2ZWIA{*7&tQp_8OU;{fC#UA#MrdY)c_~DAQwEm z&tJvB%Gsg;gGI|Q(h+zJ$)H&^>Umo2L`26mH5AyepKA~YsG}Oa*!KY)?cIi{6Qgz3=6D21=V>$|m9p{Mv1?Q8f_z>#{iE1D5 zjElQ*`H8Jc>GimDo|xpE zA0NR~YKxaxeO~e`)FL^_I`xtmX8QB{wQ7O1-bz=V3=)FruL)e-`OUAJDVF1dM&e$E zck1YZ1F#AkDkj6Q>6veRT?-xt{zI!Z1b^)xb$&c|9N^^cm?CT0XMGU4)I`2FjgXrL zaSb(_28k9=Bw#pvDO8b0Sc(CzE55(*bQq%uM6GJmJ^-UPHs{Kq*2cLXEz(|*LM&AT zU_#d^;l^mBp6z`Iqg8S-x3>v5z4t}-+oljl*Py=khyeIkFA^>fA63aG7AS>$U$+D& zBJi4jWb4jZt1a_5ek1{eFTYS)jQ3qilbbkPTwWr|R|*;ll}e60%IXzzlDS-9SV#4S z+m6TS;#MF4LDF_6n6!W3W=*T2dC(H{Tfyd;0;9*Cou>h{@I3|(fE0`O72@Rc!~!Cm zr*e*6q;qm28z$tBs^5F#Rpv{~Y;;r>ZBT5mMS}Ot>4YMjAJo-p-RL}5r4u!X(ad3D zL7=2yQ1r5nz2AW=HbC>C4Cjyh{CuxyWp2m>O&MQwkf;hmpkRs#92gBMUJ0vaZFUd? z0|t}IPuxFAYQa&gjIz*@87iV?8pAOA_oKwZ8{(k<+y3LFbGNF0|((dDIRPFKJM)%bR%9 zB%D_OD04ZDl8PSsu^eN^YkQfMD=&b=9%>7)s@QmCEF=P=n&+EC@VGVgP}=7Mp^WmQ zR?j9O2&mwk+QlHn6@w44k>|-a#Ls{x^2-!9*kA25;H0prlpaKo=lNk_E@evqOJ*?1 zpn_23P?>>WSneW=S|t3;>pECr#Gwrp_;u&v`EQ{oBj&VX_Edb@rU_9&=b|rhjJ}to z8D8stTOg8KihvtBOkVXujqY>zdQgM9U~XD@Q0xk4@1Q}sxSjk%L~^hPYE&d>udi`5 zp2FQSQj}AJsKe-!#i&b-m;@vm?lNo<4dR076ue$DN;y!&5)oM8rbs81pZ}0JBo-)z z1n>S6W4v#}#*@oCc36bXi`oBv=z4BEY;IF7?AV5ufIO-IM(vpggA|Fc?qA>!wM3C3 zb?Ryn6>w3k++M35tz^8yH1jKHK9Jbfd6+&5P7uCfl>4CR5+mc+9uPm4*WART_L5jf zp5Gz$LnuCSpF-Q60gBZh-h$|9xp3C33896_y|Rxpqc6>IJzj;dyZmDa&~5(cDG=jcVlnBS#)z zM^34lkwvnWm+m2d8@7A4Zn9an>m`4>>sN|xQ(rbN5V?-o(qKOkIW+o`>4gqs*0w)NEo<;hx-GJ!)xdWP%kbg1W zwSRpu)o|a`RzYDXRF~ck3T<%75_>XV6w1y8s^5^u`&Yzt>fd~tZ2HK3G^(3I(|gOhAY(Eq28aWx~+&t*LVK)z(VJ3zP86E|q=J_|{6~4W2P1 zok;>q@L!mJ)R(%e1l%F{Min^NFOU3Ps=W&85}}UH;+nk8XGd6}l&t~N+fq}WlOSVJ zEU3YRR4U->zv{$${e1XEXoM}|u}kj=%*Z=k8!kmB^QhwMrFsjp$A(3u z~Rjctq3c&Bi5_g*R%1;(hlDVZa4Pu?&Dw06{2RiM=j2w%Jhsgw@cQlI3Hex}6;h&1;k+M9iHR zRUlqn$UJd(sSvSc!n3x>nk6bKc1Ek`wG#>twz97herv`?Ml|;@FtpA4xm$zQsyOm0 zyN{9|aPVYEVagPOf$1BB9@K-)piQr`dtWNvE>Jh`c@36*-h<2_?fc2Iji*^l8?WW8 zEF{|(2a+p+EIVWW+$S7$5RH|L5(-O)E*ne`toABBuEX~egbkFAe|g(+6?UZr==a({f>DAXpIm0S6_|E{aT&Ay0ax%VBYzIKq;QoB@_esHpaJJ|uY(4(@SZ~a&0 zOOQn-2hO6_#$`(vm~5>S8!hcijJniL3;l9sg^)0W!NmEYsjNQ44{?hHm?MKOMjBN} zOPuA;I@Yo?3kN;b$Qpb%iZa39#!xS%+yB0#?slDZa~%3)725gM(^; zuVuMMROI)hbaqg0<{S3DT|3t^SkUil1zmPKY?X@_=!`+gvh;q*CyWmOd_BwhZF(+x z-ZiE2+(IPmxAkzko)-V>kA<}q@md86Zh!<-Kvgj;mU)28YeuZH8iet(C<08Zb#MP6 z4U5qHY?Wdu5HaSj!tV0V+3h@?{A6jPwOSXcU-$+-KHubwN}#F&2N9GH0w?wRzD%{M zrG5ze0FUAKsm!#{Hw3k;qjT<%x}D z6PZiD0q#3}Zm9De6z}lK!h6Ok?_HGa9RuY+KkoEhhSxX(FA#adtnD%qtdO$u=KM#O zK@iZ_HKXq?5RT0cKL#xU*ha=;w*U{+&*bWAxx-<5*4*G`n2kHHFcqQr5LhkYjNm;2 z*rrnUPQCFJI3yeEQ>FS7c6NG|GLXI-V=ow!e!8j4OX6L$&=8l{q5#-94R4_opUKWO zZ{eP>^fVs8()#C{M53J>ofP=@tL%vy&&9|(qd$Q9Y=O`I5~+Hbjxd+WC8#X-y8B-t zFYle^+WK~zGrgfnpU($QWmb*@pJ%-C#Q8g;LNM$G0;Hko?!4H1qa-V;h*6mbM_Ubw z++We&D4+#vCfG_z0S$L3+($SwHY1OX?SYj=Qtzb!3IkZP9f+_yu(C0BQa#d(GahN7 z;lJAF7ddQBeXBJE=i47w9G)CV{F>nh-L%RJf7SF%-(SODN=0xB1HMHKPBsG|`V1yD zfUgG<{;UAv-&VZ3D<+h=tIJyS=`SwwZ8{06{Ak2b+2aPZC`QA7nB9d}cP=g5BupNd zOfHcaTA4KED%RSmD7pmc{}>-@_ym5k_RfxgjQ&hUF)Y@*R%6faCy1?Hr+{8)ixamg_ZGju=LY0 ze^W-fa0#e5(OP0SBczSRjj8!A9nn$W9psupExtS2Tq=0uP^sU^2)(|7IYhjpOls^P ztAA~bamYfHoH337j+|(?CjzOA=xs(R);M&{Eb*V%+^JYUoMkNVr`OuLf&MtUYxp7oSCIw&Wc!2wxiooBB(hLwtRHm6GGUlYocSOmw+1t9vh?IV#>gA|{#*ip|&hIuAY}j1d zq%nH#PO20XDJ2EGL!kByyEAA!|NIhqBEz%d4Zvt)WBSDS{oP9Lbsc3N(OD^a0P&Tj<^#xgt#Lu!%}wdjiS1QonK3e+~M6yfTxX5><9DW&jUM?87!i<)tXL zMIKEm{3Emzn-5FvKld}#vt=I=a7;DEwS>yh68caOe;ur!X79nz1g>nfSWGN)ynLJ8 z+i`fU`E7sy1FwlGYvw&3ob59};`8;7=ifX^jh?0x$}nT!S=2GDA=_UYYOWPyM}N#% zsgBA`IjMf@y^EKtuh$o=(@J56a4-mc*1gWSUCE~1y@-4gjVT1$e?h09Td?*qww=XK z{Zabsq$|+yJ+2UVW1vQ7G%qOT7#oVXD3J9pCciQ<8BJA>_|3(8{5)ND;D-Tn!I)AY zsCVq~;i&dhbpUQP3!T!x`G?-zU^xAv z!DW3&(y7{%#eT;2L&HRsLlY-GL6?p`3BzF< zlRLT9U_CI1I4LDA!=Z_X6Nb~O)aDeXfsONuDH95eAsm2(JupMDkG+%z(=rGrrQdn1 z@oX!EA%UODxW}++P+xD`$1lRmbvleh7WJ?|Ur{AZE?he|)RVKd>Z@n@;iWV>3x?f+ zZmNSmWk$DG+}746g?T#}T_f#ov*9TbsYE;8t2W{B9d8BAxv4ggG8(N)bE!_YjDoQu z*E&}pfqARi`P&FyI(^1DMU+|&!@&Oe@zY_$HePqH2-<2qbLb% z!=-A^Xk;$;u3S>L5&ZIg1SJkqgJ2@tR&*OGV;(<0Vc*csak`1S!oQ!i^UmH%o-4Ma z=ic&BOtjs_D`^MD{b==OF6LNf?a3;dm$m7Z(v2em;H?a62m> zER1beee$Nrd<756U_!h*aj5p`u85%+d7@t&W>$hoRv(SZkZswEkqC|o4 z*ld2>hJw>|tQ0pys^%@_L1Li7l3`T37s6sAS>mrqxTK#YA+tu}tcib9QJF8Nj0^U1 zcWT#h-&23mwXZ)n3A&)!QU=6rRIs!A1OOSSe$5OovMnrv%PGY&)HdusEnz+J-_Fhxcgz}RgGiwLND|qnKcKa_+t=H%~=m`+Ud1Q z`?KxGM{I7?_w62Z?&#zam5~omG#STXC^+MRUV8?I&E|2J!Q_H6y6WOG3>e>1z>|96 zmT_^7<6v+IE+0|KN6V|;s{ba>6m(ni5^h|c7)e0cv|X%|jX!q=Mx_uIQzu1Z!UUS_ z>OqT|ih~9^Uf`zt&m|tDv?&RrBDb5QC%*O0xR>woy)L>cpzwJZZ*}%bPZ9FByk0Mx zOR(t16KrUxcJqFC?vE3t^!9FY)O^W)Z#`aK_U$<^uHGOEmTx=Z9VpaUlW6&xFu+)j~BO8pmCtG4e`Qop@z$I*9 zy_PYSP&wp~bm_~RojI}`bZkh){*4{PpiNz)pSK%Ec^$0a2wsr=#>oW*hAiyIT@c`@ zOlE1djDhF-BEuOup)xEjsnPV;4$`St7fpDk#m#jl4`EruDvjY_$WiMCxo;*CMld(o zJ^yt@J4nK*-GAvgh76$l)&1ZG68KAqZn`fReK=xK_SoW_Z-bd>L4lV>XzCbe-leh7 z0vHAi)f`M%_VP3N*@(u}p#3K2Myr4zoiFdH&BK%wIiY9Gn~Azl`+QxpBTxL1C?vmS zY1%B8hf~4dO1JM?_$dlUpPKV{!hH1XJxn(4RiMEliT{M6BRh5b*K+7mU^n8Uf-|54 zRbr_Jsgs=bz~0Z{)&!(i%=?rxoC<{fquG}{L_JjT52Mxxq6o5nRc0IZ zZk7zSK@C9=xF-4tOk$R5xy~cxl>)1P3F$9nfN9LUwW?^J4WbTXGQ)>CHHvmrDn^M) zXb}jJQ@x(o0O;>=Ll7w&4n5fl=t)gL?)ESm&!jOi9I}N4th1G)`HZ=(-xCseVUHzS%!VRR#R7|AP&8_O zwr<9Vv|T^`+5p*As*b&yi6Z4%Myh1dI9V_!Fh%zidXB?5QWC{!5kjG3xdk0$;zf#m zwC2zW6w}%}J&YMPDKUPGYER!#wUxLvmQYvik3Fh_UB&Dpb8IYsjSruK;(QymN^{t{ z*Y_sZ6lT9lORgiZvE^SM7Gyz}!`wd^+o~U52lGV&$MvMZ4zex|)ft=E{Dnb%;%n}Vg(%nBKqwA<{ z;S!n0;mlO`>>0mWNE#m4ofmEZNGIKAJ0&$0FP|Z8W+% zC~*l71NFy*RS~GF>n~H|I_22fo9DNlCX*d9JxMccFjM0?lqQTeyiV+Z<655mX-T7T zEg_U+nP;umHa-6!aO_HVZA8(|zMNn82LH3>UO|qwy+65*l(zgVvuhyf`J@evOT)_r znX|(3_QfNYQ9(N!JFxeD1Jz7cWm({TdgH@pa*plol3=#8N^sEN_hR+)VcPFY0c1&{ zQl&aKQ48SE=jML3$xMd0ywGcqmZW@C_7w!PL^9u&V0 znPs2~%2!QozmEeCVJBr{LBR3k9mG58@6ed+Hl=`I}Kz zm$n>yfsgh9rAW>(+>z(~U8xL|rjc+PY7j422~QGTnnbxS942d+C@=syT5!Z%KtLc* zXW67vO;Iyl;!NNGl0b#$Rhl-&-7xky#m>yVm7@=5Uf*7@$6QU88uA-Dr&|-@IRK83(|j{8#WQF+za3im7=#lU?at88cFV z?y_j>GTNEg?1kR4fcUfs-gqB%Ic9eDT=X`@y81Z{l|!uVbd5Nab3-$jnVH$ju>ZVi zWh@SkogwA=y~)mSQz@y~ib!?9y#V;f$OqW{f9V7DYP~ zz_otr8i0h+CnezA9>>C$ooL6d= zl%~5x4CFO{@NvW7M>WR|#mG~UG9>J>RqmvntJM@=I}@V%E&zZ?z_Mc%YIf4crb^JM z(*(fqY_tm@vVKOtDo#*Jbo&%uG0|UR6`VtdvGaduS0Rk zgQOE;CiQsn9l>>T`5wbR%}=FwZgX6!a@Xl@bq^0f)mGtctMvg(bJBcyp*-!ote^G! zRn7L%nU@e_v&m@CA%(w?d{t!t0$zo5&9`a>hjcNlIvP9Zx|HB+pNHIl@wqmqx(!6) zzoAg#{m9udh0a-ku*#BG^B~Rd6DwcuBpfQflu_Jf1A{=evXJ}JfxRdPTTA{}@#v$M zCg@bWWrP-FlH=5$9q-;Y_t$WZ>WjXCd2IxqoAd7El?oS=mbwN|5z+|}kq3TMdY-oi z=ZOT``K8X35t!fn3-cdZErIRHnT^-VaKCxgUgwgsc?+U8fdr?1mNJDV@|KU@=8sVs zp^g*roXo;uDl zT1;$xe1Ce86zHCf%5N2g6q#)qGtM+c0jNvmjB<&Uj}Aa`Af18)btZPDn&T{XmA z+Qo7>1ZCiE?mVEN%9)!?b=VV?Y_Zc;a_M43tg8g)Itk*~vm^?I5q5h%TT~{F3Jo#U z48kMZ{BE#&tEj>i4Vs_;k^~i<5)pVt1g*dA>}(TTEAw{UCxn5d*!;|Ny=EIw5m8db zZKqDvOi5Nxh}4Ef-L3gvhGm7s*$!o Bottom Panel > Action on Play** + editor setting. + +Message categories +------------------ + +Four message categories are available: + +- **Log:** Standard messages printed by the project. Displayed in white or black + (depending on the editor theme). +- **Error:** Messages printed by the project or editor that report important + information, but do not indicate a failure. Displayed in yellow. +- **Warning:** Messages printed by the project or editor that indicate a failure + of some kind. Displayed in red. +- **Editor:** Messages printed by the editor, typically intended to be traces of + undo/redo actions. Displayed in gray. + +Filtering messages +------------------ + +By clicking on the buttons on the right, you can hide certain message categories. +This can make it easier to find specific messages you're looking for. + +You can also filter messages by their text content using the **Filter Messages** box +at the bottom of the Output panel. + +Clearing messages +----------------- + +When running the project, existing messages are automatically cleared by default. This +is controlled by the **Run > Output > Always Clear Output on Play** editor setting. +Additionally, you can manually clear messages by clicking the "cleaning brush" icon +in the top-right corner of the Output panel. + +Printing messages +----------------- + +Several methods are available to print messages: + +- :ref:`print() `: Prints a message. + This method accepts multiple arguments which are concatenated together upon printing. +- :ref:`print_rich() `: Same as ``print()``, + but BBCode can be used to format the text that is printed (see below). +- :ref:`push_error() `: Prints an error message. + When an error is printed in a running project, it's displayed in the **Debugger > Errors** + tab instead. +- :ref:`push_warning() `: Prints a warning message. + When a warning is printed in a running project, it's displayed in the **Debugger > Errors** + tab instead. + +To get more advanced formatting capabilities, consider using +:ref:`doc_gdscript_printf` along with the above printing functions. + +.. _doc_bottom_panel_printing_rich_text: + +Printing rich text +^^^^^^^^^^^^^^^^^^ + +Using :ref:`print_rich() `, you can print +rich text to the editor Output panel and standard output (visible when the user +runs the project from a terminal). This works by converting the BBCode to +`ANSI escape codes `__ that the +terminal understands. + +In the editor output, all BBCode tags are recognized as usual. In the terminal +output, only a subset of BBCode tags will work, as documented in the linked +``print_rich()`` method description above. In the terminal, the colors will look +different depending on the user's theme, while colors in the editor will use the +same colors as they would in the project. + +.. note:: + + ANSI escape code support varies across terminal emulators. On Windows, only + Windows 10 and later can display ANSI escape codes in its default terminal + application. + + The exact colors displayed in terminal output also depend on the terminal + theme chosen by the user. diff --git a/tutorials/scripting/debug/overview_of_debugging_tools.rst b/tutorials/scripting/debug/overview_of_debugging_tools.rst index e0e13e01b8e3..c8f487791dc3 100644 --- a/tutorials/scripting/debug/overview_of_debugging_tools.rst +++ b/tutorials/scripting/debug/overview_of_debugging_tools.rst @@ -14,6 +14,12 @@ in the running game. Finally, you have options to debug the game running on a remote device and to reload changes to your scenes or your code while the game is running. +Output Panel +-------------- + +The output panel allows you to see text printed by the project, but also by the editor (e.g. from ``@tool`` scripts). +You can find information about in :ref:`doc_output_panel`. + Debugger Panel -------------- @@ -251,7 +257,7 @@ GDScript ++++++++ These settings allow you to toggle specific GDScript warnings, such as for -unused variables. You can also turn off warnings completely. See +unused variables. You can also turn off warnings completely. See :ref:`doc_gdscript_warning_system` for more information. Shader Language diff --git a/tutorials/scripting/gdscript/gdscript_documentation_comments.rst b/tutorials/scripting/gdscript/gdscript_documentation_comments.rst index 83957a93c00b..731e3d4b34b4 100644 --- a/tutorials/scripting/gdscript/gdscript_documentation_comments.rst +++ b/tutorials/scripting/gdscript/gdscript_documentation_comments.rst @@ -223,6 +223,8 @@ This can be especially useful for plugin and library creators. While technically you can use both ``@deprecated`` and ``@experimental`` tags on the same class/member, this is not recommended as it is against common conventions. +.. _doc_gdscript_documentation_comments_bbcode_and_class_reference: + BBCode and class reference -------------------------- diff --git a/tutorials/ui/bbcode_in_richtextlabel.rst b/tutorials/ui/bbcode_in_richtextlabel.rst index 68d3d0992f15..18ae2e2f25e8 100644 --- a/tutorials/ui/bbcode_in_richtextlabel.rst +++ b/tutorials/ui/bbcode_in_richtextlabel.rst @@ -21,8 +21,11 @@ scrollbar is automatically displayed if the text does not fit within the control's size. The scrollbar can be disabled by unchecking the **Scroll Active** property in the RichTextLabel inspector. -Note that the BBCode tags can also be used to some extent in the XML source of -the class reference. For more information, see :ref:`doc_class_reference_primer`. +Note that the BBCode tags can also be used to some extent for other use cases: + +- BBCode can be used to :ref:`format comments in the XML source of the class reference `. +- BBCode can be used in :ref:`GDScript documentation comments `. +- BBCode can be used when :ref:`printing rich text to the Output bottom panel `. .. seealso::