From dfe1140444e9ab7a8827c94a7a957d45c602b0d4 Mon Sep 17 00:00:00 2001 From: twanvl Date: Fri, 3 Aug 2007 14:25:40 +0000 Subject: [PATCH] Documented style type git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@597 0fc631ac-6414-0410-93d0-97cfa31319b6 --- doc/type/choice-render-style-both.png | Bin 0 -> 965 bytes .../choice-render-style-checklist-both.png | Bin 0 -> 2627 bytes .../choice-render-style-checklist-image.png | Bin 0 -> 1539 bytes .../choice-render-style-checklist-text.png | Bin 0 -> 854 bytes doc/type/choice-render-style-hidden.png | Bin 0 -> 84 bytes doc/type/choice-render-style-image.png | Bin 0 -> 552 bytes doc/type/choice-render-style-list-both.png | Bin 0 -> 1685 bytes doc/type/choice-render-style-list-image.png | Bin 0 -> 896 bytes doc/type/choice-render-style-list-text.png | Bin 0 -> 663 bytes doc/type/choice-render-style-text.png | Bin 0 -> 456 bytes doc/type/choice_render_style.txt | 31 +++++ doc/type/field.txt | 17 +-- doc/type/script.txt | 19 +++ doc/type/scriptable.txt | 34 +++++ doc/type/style-angle.png | Bin 0 -> 2781 bytes doc/type/style-positioning.png | Bin 0 -> 6908 bytes doc/type/style-text-mask.png | Bin 0 -> 2787 bytes doc/type/style.txt | 128 ++++++++++++++++++ doc/type/symbol_filter.txt | 0 doc/type/symbol_variation.txt | 46 +++++++ 20 files changed, 267 insertions(+), 8 deletions(-) create mode 100644 doc/type/choice-render-style-both.png create mode 100644 doc/type/choice-render-style-checklist-both.png create mode 100644 doc/type/choice-render-style-checklist-image.png create mode 100644 doc/type/choice-render-style-checklist-text.png create mode 100644 doc/type/choice-render-style-hidden.png create mode 100644 doc/type/choice-render-style-image.png create mode 100644 doc/type/choice-render-style-list-both.png create mode 100644 doc/type/choice-render-style-list-image.png create mode 100644 doc/type/choice-render-style-list-text.png create mode 100644 doc/type/choice-render-style-text.png create mode 100644 doc/type/choice_render_style.txt create mode 100644 doc/type/style-angle.png create mode 100644 doc/type/style-positioning.png create mode 100644 doc/type/style-text-mask.png delete mode 100644 doc/type/symbol_filter.txt diff --git a/doc/type/choice-render-style-both.png b/doc/type/choice-render-style-both.png new file mode 100644 index 0000000000000000000000000000000000000000..02b3b54f284fe335a1cec87e061fb8684c03010d GIT binary patch literal 965 zcmV;$13LVPP)yI0=}66hZ;a0iS^(U>sUVLqz;UgpO87|@5y z%gg+4*hc7)Z4s~cu+04(z%9{l3w>yaNQTD7MvA+;yYuq$G)>z-bS05KY$QfmmCp17b+Sb-KHa4awUaxr|5LjGXj8lLvQFGIs6B85qJ#=+uW@abCB&0SH zOYpoT`sRXYqGj$LNVdNK1HgOW6Yvd~m5C>Xxe8ndt^pUMT{adPV>{#(-ha&*XQTw)BV&W zL>q_0v4uDiqu$DdeED-{i>*OJ` z*=(YlBu_FkGwIu8GVOE_@Bw#a#YZGo9!H|;u8b?}DZ?WvFH3)-#VIMGUOhcMgsGsQ zfO^#Jc3Ui#_V#va&3&9<9>{#J{GQMe$A`4}E8hfq*1?3df0ql`%Vu9)T}@3{TU$Fa zGD1|L1(cSSHZ(L878X`kR_+NpTYp|>h7HoFZe4hu!%0uH5)GFm^>ZX!m}HSIO-6YN zvL$&L2!%qbs+!GaeKLu6WZ}N=GOM@*oW68l_-;h*@DV5%dFi%R83St^c}0+WEbpj z5z7Ua;&wQ)I0w)LX3ut!;bIlM)NZ2NL_3Kl5q5#N$V$&unzpU2?ZSl%X0us3?CTNcWo7^V{h67WNl8gYqw&E5_)-E{7A#nR0dn{DNZ;mx?Gk~3wo`Q1^gW5Y{U1b! ziM}Q(9oqJ;Y{y|6^9cVYx=eJD)pJDuBD&#Dau{~Tj2VfEiFfYYX=-W;4-a3wcyVQA z<(f5XA|oR~+9OAfU?fo0*49p*JQ@8HCr(_xjCpC#o;{eVr>6()?%lgRlAQO;ZLhu^ z?0ZJ^AEGiMGZ;qH%1jMUo=)^9qQyj$Sx6h4k$HR6X>7gtp@maPC1E<)1`gOO`AF&(EJfZ!j3%R8H zPRohGKt-IA0|f*mQGfeQ-*#~C=i8Mag=ekz?a&<=d3xv0<6nHy!7>dLO<&)pf`YC2 z`SFd7oR?Kj{%u!3Na5+D*pJ8ec91Jb;VG~PDGVj%t{tV_ z-lx+k?ZYxtgS?vKR2GY!MK^`Rfevy5j1kYkqbU^c2FYII=s!+ zY&3R7NB6r}+oo1qG@AP4WFGnaHHkAr3W*Ff44uhd5Jp8Y0Bt*r{n>SNaQxU6h z2*Ie)XoAM}?Af!5iVCFh+1c4{nM{zdi$4FnEiMkWQX*Ys#&>qCTJ3|349SdxwCDN% zW@WX<#!5>tz+gL=!TWW(9=#qXCD=&C*REZQoIE!-7qJ?8qokxHxF;+qDA=`Y7aj`y z&B@8ZYO2-hP+v2^ODSzOZEr7Hh28Gj;XrSuIQq?zJ1OV73YzVO6fORh)|r76xha%8{uw1V2qzV8-kV~Ld|9~76olpRTV}S z6(OUfD_5?(1F%CEo>GBghX|iEX_BNv{R_`Gn<24?;Ox8!;faEiixw@yy*F;$aMPhd z!j5WfMPyc6tyZ-fZVVwx>ZqCXwP`eNco4Lr+S{?E(b2H?L`Ybb;3Ch%;lU{Y=;#Vh zFak0L`ybA1)~s2h6To)l<+U3Ocw#&{5W+1xI|$lkIXO>0{@95em(qUv>5nBPF)b}v z7q~Hv#iC%ALEoWL5gc1#p&a1}Zr{IuA4c~3gzML@fAr`PHpNv|R;*az3O-2KpB+CA zRKS4Pj4tFZ3wKY#Vr{pe_Kchz`trOnOF&Hx5lG&D3g4?`?`K>4;DcLnQ3bac2%4kUBo zU0p%Uh6KwsFP<=A!Uy3w7CE_JsfIl(rKdKV=&)q$ow0*GD#8;1a{PF>5DE_$0e5y% zb2DNobj4e2ZMk1Oy%fle>C*}FDJcn&mJp;mI;gsuDk`X|N?d|>o8%q~aAsssP7Y0* z25&@=j9A0IJ~0!Ci4kcJ@V;$6y22CE1wkHqMw(653*$h^4^)7cnMrABVh8CH!ZrwR zFc4B^EC-^d(dcIqNq8bkqmLGOc+i-U$xfX*b@l4iX=!Ol@&kq~^XnhPEZ~_;;;u&C z<-7?Ut(FoJ#7l{ZB=bE==wCdK9zD8n;X+(pxpHM*ULG=YKd^)O;z^=ykvqY*BUy<# zV0LVKtca`B_fbOs;#pQ!cK!NwEZpfsUw$oz*SNq9nyKzPD#euXEl!tzMtU4}Jc!J{{6fF}Dq2;tIVM2pM!2r2p~_0C ztqlNeC|^9GgEwv3v~JzH;^JZ~6PTNUSR#kyf#&MKSyx9t{z&EJ1VX{EZEa!&1s*=6 z(ozC3!3FsxlrNq<&!0PYuD7>$)v8rkxI>2yWoKu5l_CLr@$@nf3290SrKS>SC}n9t z4paa9v&aG;xr)a{4)Kd8_I6WK6P&-3{Glo^AM1k<6%iq(We8f*t_E`O+_xYZODQ71 lyz6T9!#`Gkfc<}8{s%QEzz)@d(Wd|a002ovPDHLkV1kiA*!2Ja literal 0 HcmV?d00001 diff --git a/doc/type/choice-render-style-checklist-image.png b/doc/type/choice-render-style-checklist-image.png new file mode 100644 index 0000000000000000000000000000000000000000..5045e2e16cccb7c2c1aa8d126780b9b3e6f867ec GIT binary patch literal 1539 zcmV+e2K@PnP)7fK7=5!pws9OMI0+;);3}zRV zUQM{BizILW=mFA@X^9lj2}Btl$N+x;cYqnVOD;-kpeaq?fDS*6d1_pSRnTt&6Oivn z)i?z70o^LR`o=U*bHFrk8~8M@$?G7#6F92TB)vcC49Eggz_-AU zz<=x6^rycpo5NIvQfZWhl8y-R)J)tx;0NF*;4Y90#uTh^f02c+4I4NH#C3AN(K;&v zPLp+4%T^fG>$1_2N?J(~jYDiUoMGTYT@XJ5f9k4~y1zHDD@acsj!L6e_|@EbbMkT5 zfJNXj@Gr2WQ^V>T1xB>gYLQ7@kL+U#k5_k_7((bV3ayRIax?yA8>Kbc&J40JLEC~Fnl{=+L+FnqvYgiuvV_Hms zwuc~%du%oGg|Bsm-_!!CxlF7ZqnwfQd#Rk=)wIQ%SR`8Yr?&;}Yv#A1*_5RL7au^L zlr&hSvq;^7t>tMerjToku!Ju?KK=V8-hw;fD&bRJ{Ti9j%z33}>lL%R4yGpP-N4iU zO%;|QWn5wacmwh^$;uZop@^{|OhK|`LCP=M#JBAt7(0-=h5mj9vP&g$!02|d=rycT z=~;jON_Tg@hNn^_Qiw)p(`n0b^85BVmQ}KC{xU+@vNEYuHjy~nKBg~EpI+?kuTC6jbbczXMEfvU_G0b_1lRPOFcavzOu&TYO3<_c($X1H_x{3nX!DHp~(}Y6Gx;_ zs5D54G<=R8q>#i^QznGrI36-=UYT0;@tv-J`RaVTwyOx%O*&!6EdDiip6?vWG+3fMDsn5@yis$^)94iMIsm)!tk(C5}mm+hz)M<4joc|4GzLE zTEbKdBJ6t=&BuWQNTpQDwihX>qSOeN&|BomgHrFULA~4&O(kVpr!f?H?9d`lTaN?b zOqJrLVz|Kgx>32T{$huk*SpPNss$0=ukhsPEJ(4uHdj~?Ov{ZK{M$P1cX2MOZwV_dzemK0J&D`&Ye2DbvUv$%B& z*RLxUTfr2*(0nCz@19B`sXB6G-NzRf6-jsRs+(aJzBb;gh(<=$*{O`1_3tT(u$aEa pfaov;7^002ovPDHLkV1meS?c)Fd literal 0 HcmV?d00001 diff --git a/doc/type/choice-render-style-checklist-text.png b/doc/type/choice-render-style-checklist-text.png new file mode 100644 index 0000000000000000000000000000000000000000..0e40d153981c8db38d197429ba6a695fec98f062 GIT binary patch literal 854 zcmV-c1F8IpP)8q=&dU|>V1qJ>6{j;;PadC0_`uh0z`1AAg=H}+t*VntdyLfnb zVPRoYQ&U7lL>wF(2?+@T0s`*t?(6I8=;-L<oV3%6Mmq+aTW(qp$urE)P?3`K>)1&K;0lA!u08Y_bX^<8SCGzA${2U;BZahz@k z2`bm93L$xoQ;~OG-1+eSrd29=qVvoLhnEp?is(FRxYnJbUYsI2&uf?A2yNmN*?D2H z$N8wlUS#JNA70i$n#y&4;r4kBq$r~Ee)Pp+bCk}9xi5E)^UnXt`K3KAQ1|@dJBJ?X zp1-=7E#e%sJrBI=rbI*A^PqVRZPWKWzZQR6rR;h8jttz$Q1(3gbZ0x~HfVc(D}cch g`kuEs%iv$nCuZSA*oL;s{{R3007*qoM6N<$g5Y?a<^TWy literal 0 HcmV?d00001 diff --git a/doc/type/choice-render-style-hidden.png b/doc/type/choice-render-style-hidden.png new file mode 100644 index 0000000000000000000000000000000000000000..d0dbf443ebd18e2f6dbf820915fca34299a40efe GIT binary patch literal 84 zcmeAS@N?(olHy`uVBq!ia0vp^k{~uCGmuP62ww}Nm;-!5T>t<7zx;^w2_Top)5S5Q e;#P9P0s$b;k%3X8)c72b#o+1c=d#Wzp$P!!^b{HZ literal 0 HcmV?d00001 diff --git a/doc/type/choice-render-style-image.png b/doc/type/choice-render-style-image.png new file mode 100644 index 0000000000000000000000000000000000000000..8250a40c533f086078fdaeb98f5fd010fd098f3f GIT binary patch literal 552 zcmV+@0@wYCP)>`)Vb%}8YhV@iG;0+{}CyxEV8&%qWHB(nb?I2k-|<` zhtKdM>>yF%w_y|v68CLLXo{gB2Dy_vR!l#83 zCtwy`P<%NE`(ZLB#b?|&y@8kT5a#XqLZM>B?zw)KyIYP^hA~mD8Gg6TE1uVe=Jc8Ho-tvR@&cPg9gd^trzrz2fB75o38_jy8RmTI?Bn(DBD zU4=6y(y$Osj<{~#T{2<%BBeK;T9Ixm-WuL0b~kYwRXLq^JTvYC7?nOvdoH6ng)xu% zjWrsppHmenbG1}zN=%8f_*oxq5@ee)JZCIR`*rN*oE(PKg7F6|k-B0Uj-f*eo_6Cd qlIY-47aF5==~@HQ_CMi2i}VZhl)}A%6)Noj00000F7BCrGe=ff7TARr)HpjinKS3?FyDON ze_J#m1U{5z!3Wenf_Yb)wcm|Z-U^G5(*}f9AOXTJpab!M7x)M0<{PjGizc*TSAYHb z^|*mCbOT91I*vjCm*ay651u^9b+K*RHZJw@v&& zP{4%;s4l8^tRu{LN9M)43pLqh{6larIBRoZNPYEf-O>C7*{4@xHuYWE_rH{I+O zw?+F^!_Uf?Iz$^ZT_atB0s8wft^BkPsnYD{&9vddKT8B%an{oV!w4tw z8^^49@J9bWc`_zVLPCOs(b0jYPwD&N^}egj4AxRpF>@yJ^O2d!$iNH=FJ7Rr5!bHa z?p+D&y#d4B&z_CNi!oyc($WweEyeTd6~j50VNrO5G&Da<8PAPhY)ybwNP^lfB5mL`BI>I~>wlY__)^f&&JIDO2R5j0}XCaE!hL z*tc)r(xprJbmhvGyLRnjb{7E{^1!%E9tP@yct{b=i8!O8!U8k;5}>ZG?(EsKJdXSK z?^9_^BO;R-VelH#Ym*St#TUY4X7lFFW(jcq{CQ@<8#iv8H*X#@8VYaIrcF$9dY843 zuI%jWojZ4K*|LQt0JHrgM~(!Z5+Si2IB-DgzpY_*LCfyy0!0xrs*rp>;tOH^qGXl; z%v@Lk@QjBo0r-?GF`WyP0P-g!!(cg7T3Whd#R@aa4i^mf`tYF)DRf^010ogc@yPD; zMQqA_O91Bod-m)h0P|5$3BW<`$$HP6IpcD<3JVJf(&zJ4S64>>hPz}WxqTZC9!LgE zeh7o1hT)~D3H9}GyT_;m&~<(N`t@tqu4Q3I@YL9B`qS{iaQDs4xO54ZFN2hlgtj)> zN!P7gsI3L1LEgru1h87I6%`d-U0thIt>SU)-o1O_!i9rp&4c7-Okr|zke3Gv!OQ@N zhqTzM>35qO?w{P)=d(U^j^L^*MS0f@^%J6Yn<6lGyWLyO7rTE0&_K<*3g(L(& zT!91l3Hv$&pZJWJg3;sgcy=Vu?-7P3sD~&L73!cG%5@QJ!Dsjc3wWCzM|O!{{8=#) z`pd(Kn=pXf6MNDMjZkA3*`va7T7fy3fOqcLAt8w(vuDy>ZeAE}IgD`fI>(}27=h>T z8osCUnRQ59av;TxmBbXWLrvWjyn;6{39-URfjqg)H-gX$A(!4~PQOD)6z#oJ)^X2| zoI+(Ty2&h%E_meZ^A^51XNsGjTzEB)PRU5RwLRE?Mfe7rE;;JJ9_V%wrsIk8q)uCd zZO1GbLARw9@<4JUsk~od3_id|Sb`sJy?XBs48eWqbiO|^yx&yBodijhW_F}C!+WRm zh$D2`RM#EYW9V}t6&gY=M?7`j9dp8@4L_;!lm(HOV!MXtD2C3^jWRjiHB3A1r!X?| z6!Cb742hPx)vqk4vC=tZA_YuVDp^9b2)FSDJZlq`t;OLP$1-WZpzEA9g^==K9E15p zLP7*?AlF1aZ7Pf<5ybe7CPofKp5#Efytjra)Q9w~;&*J1j_|x9yeDVxKcNuK%``Sr zRb?@@w^?6jZHg(z0p|_XzcEVv23AVPFn`2^v*;$KvF-RJ^zn{TDy1Qv; zpuF7XBo-qYrMA}QQ}K#n7APo;MjRNRua8K?UM97ythD*``PkcIb(MvMlD}BW%INH* ztIH}B3?5rXPbw;CZMBcu+AL(LNV@l?ChF>J(oS|4V`-^`x(VG-sYseG#rTu7lZ$

_adh{DhAL)d&kFE0}X`q!ATRO2=ma5#@v3Aho@UUbg4WSh?GsE(- z-FuRmVrWTe8O_f#JzbRX3cFlGFD^1XY@3kM(l()%Q>5KpmX;VFXLQsuzL?5YsivlE z8kJT@N2*6`Y*<2*llEpY4e-=k!{jTh>T25*)Y(ae6igGCA0}sq{i`pK|NqoV8NUEe WmR_jvcS3yt0000PyIn&eAadB}ZBqRX= z0sQ>@@9*#F>FKYpudA!8dU|>f4-W+e1^xZ~`uh6#`1tel^XBH}*Vos(ySuZqvv_!T zVPRn$92^M=2?7EF@bK{N?(XaB>*(m{l+oSdADjEsqiiFI{#XJ=h2e7|2_#4`kluS@@7)-C@4fe~ z|9>sx#*rbymb<#&+;{cO1Gr$qF%`&Io{n!0ejgsTVSL3ZtH09wrxRBY|)g6eTaP9RWXJ-7ReocUPAOXM&OcyD28K(Jk&xqILH( zUB%Xx*>J11UJxwJc|d;<>xDs-IK_NV{=002ovPDHLkV1mC$KqvqJ literal 0 HcmV?d00001 diff --git a/doc/type/choice-render-style-text.png b/doc/type/choice-render-style-text.png new file mode 100644 index 0000000000000000000000000000000000000000..05382aef1c26b68ac7d8f9e0de6f28d804f0e121 GIT binary patch literal 456 zcmV;(0XP1MP)lq%G($CM&%*@Qj#>T_L!@9bTU%RJR#sJ2RZ>z?QBhG$OiW2hNkBkAHa0dhGczqMEi5c7D=RB1Dk>-_ zC?zE&9UUDR85soy1!ZA6+W-InqDe$SRCwCW&bJnVP!vSbJ6E5eA_xXB=bUrS+5i6_ zT~^{!YfdrME{4cKrP?8)_&?!-o5E54FSI3sOq`dAI1$qdOmfC9BmhP=3U$l^D-*}T z9W#Cx*$wK!^EK2*N5CvA*codSZ9gL59QMPJH4&Io0}3hde2Nmbk|Z?+0_25{{2yY9 yuztDKdWY68(N$GX + Rendered as text +| @image@ + Rendered as an image +| @both@ + Both an image and text +| @hidden@ + The box is hidden, but the value can still be edited. +| @image hidden@ + The box is hidden, but the value can still be edited. +| @checklist@ + A list of checkboxes, for multiple choice styles. +| @image checklist@ + A list of checkboxes with images instead of text. +| @both checklist@ + A list of checkboxes with both images and text. +| @text list@ + A list of the selected items, for multiple choice styles. +| @image list@ + A list of the selected items with images instead of text. +| @both list@ + A list of the selected items with both images and text. + +--Examples-- +> render style: image diff --git a/doc/type/field.txt b/doc/type/field.txt index 3acaf5e7..3efc93a6 100644 --- a/doc/type/field.txt +++ b/doc/type/field.txt @@ -43,14 +43,15 @@ Fields are part of the [[file:style triangle]]: | @tab index@ [[type:int]] @0@ Index for moving through the fields with the tab key. The default is from left to right and then top to bottom. The @type@ determines what values of this field contain: -! Type Values contain -| @text@ Text with markup (a [[type:tagged string]]) -| @choice@ A choice from a list -| @multiple choice@ Zero or more choices from a list -| @boolean@ @yes@ or @no@ -| @image@ Any image -| @symbol@ A [[type:symbol]] edited with the symbol editor -| @info@ An informational message, for example to group fields together. +! Type Values contain Displayed as +| @text@ Text with markup (a [[type:tagged string]]) Text +| @choice@ A choice from a list Text or an image +| @multiple choice@ Zero or more choices from a list A single image or multiple images +| @boolean@ @yes@ or @no@ Text or an image or both +| @color@ Any color or a restricted selection from a list A box filled with the color +| @image@ Any image The image +| @symbol@ A [[type:symbol]] edited with the symbol editor The image +| @info@ An informational message, for example to group fields together. A box containing the label Additional properties are available, depending on the type of field: diff --git a/doc/type/script.txt b/doc/type/script.txt index e69de29b..171605a5 100644 --- a/doc/type/script.txt +++ b/doc/type/script.txt @@ -0,0 +1,19 @@ +Data type: script + +--Overview-- + +A script object is a piece of code written in the [[script:index|MSE scripting language]]. + +--File syntax-- + +A script is given in the same way as a [[type:string]]. + +--Example-- +A simple [[type:field]] script that converts everything to upper case: +>script: to_upper(value) + +A larger script, changes @"y"@s to @"x"@s and @"a"@s to @"b"@s: +>script: +> new_value := replace(value, match: "x", replace: "y") +> new_value := replace(value, match: "a", replace: "b") +> new_value diff --git a/doc/type/scriptable.txt b/doc/type/scriptable.txt index e69de29b..b0f4e973 100644 --- a/doc/type/scriptable.txt +++ b/doc/type/scriptable.txt @@ -0,0 +1,34 @@ +Data type: scriptable + +--Overview-- + +Many [[type:style]] properties are ''scriptable''; their value can be changed by a script. + +Consider for example: +>left: 123 +This defines that the left coordinate of a field is 123 pixels. +To script this you can write: +>left: { if card.name == "" then 100 else 123 } +Now the left position depends on whether or not the name is empty. + +--File syntax-- +A 'scriptable something' can take three forms: +# It can be a regular 'something' + >something: 123 +# It can be a script that produces 'something', enclosed in curly braces: + >something: {100 + 23} +# It can be a script that produces 'something', indented and preceded by @script:@: + >something: + > script: 100 + 23 + +Note: To use a multiline script the following does not work: +>something: { 100 + +> 23 } +If the script has multiple lines, it must start on a new line, and be indented with a TAB: +>something: +> { 100 + +> 23 } +or +>something: +> script: 100 + +> 23 diff --git a/doc/type/style-angle.png b/doc/type/style-angle.png new file mode 100644 index 0000000000000000000000000000000000000000..b8abd76c69f2d02837065d5b40810e0485edfc07 GIT binary patch literal 2781 zcmV<33L^E1P){{H>_{oC8y_V)I}!^3!Zc=`GH>+9?0=H|!8$6Q=o^YioZ@$u;B z=%uBlsi~=pi;E&6A|N0j_xJaIe}8dtaVaS&A0HnS6chyo1@!dvySuxBf`Ug!M?^$K zLqkJ4IyxaCA^ZFL;Nak_tgNf6tD>T!mzS4*etst>CmtRi2L}iG`uh0z`0efO=jZ3; z<>lPm+|ba_!otFhjg5tcg?V{-Vq#)BIXO5uIN#sj)YR0{($cuNxR{ujl9G~$h=_Z8 zdvI`YQc_YtKtL=kEF>f(;o;%g+1bm>%gM>f$jHdQzrV1su%n}+p`oFmprD_hpL%+F za&mHOYinw1YG-F>W@ctjPftilNH;e(Gcz+WF)=GED<&o;BO@an9UU1N85R~6_4W1g z^788H>f++!*x1<2%*?&Ly}Z1C5poR*fBm6er~lar5+kAZ=Ke0+RwZ*OdDY-D6)VPRoiU0qmMSXWn9R#sM3 zRaI0}R6IO9J3BivGBPeME*KaX6%`c<3JM7c2?z)X1_lP{>FM6y-qzOE&d$!n#KghD z!MeJ-udlDJuCA!4sHCK%ii(PdhlhZGfOmIybaZrOWo1xMP)<%xO-)TdKR+-qFd7;f z1Ox;E0s`*t?(FRBd#>TX?w5_eJs;a7QBg}vOGQORLPA18K|ww~J~cHpFE1|~92^%H7Y`2)3=9n2-QBjf zwzajjl$4Z_k&%gsiG+lNZEbC6XlP$wUtV5bTU%R7N=iLFJvKHrDk>@x5)uv$4hstl z0|Nu@Cybx~0004WQchCi zC*7>nhyHQLA%!y}h;+fg{SzeV#NhVkChVI}8v=+)gq^keP?5lE4yxd2fp9(6bPRzI zt#J1Nw|QG1q)V!i#vd`JpvJbFy63cM5${H1LQH9Al!EWtQA21O8}=6V6quBz6}t!`9Bch z3k=LOf;w9&v$&0#AmR{#NC6agi^U~U41#GtO)}$W0|vp}E!pXEmed6CZ9eh^0{AtC z#bP~=L9AoE?l*fLd~^~Z%y2-|lfDDdj~F_9rd9gDO9D7sw{)8Ts<-gU_fRt;bN)_7+ZDK5l^psD2Epv^_bHre zKp;Ysl6oErO||m~FB|H2wk@f;k#9*IFlz={is0_*;X5*uNsh0~k`u}rDxrF;S{4r1 z5qqJDUvHWogLpBQiMF-N2fZyb*@!?4+mQ&x(cLxC3Oxq#>>+19fR&=1I?Hf$bhP6| z(GOxxEHEs9E7D^SKWzTc9Qgpj6nrKQ3kyp;4Nn4M;d4VjkX&tjhOgC;%88 z9|zp_HJz$*aJp11(gI=LkP}G4^KOx+>QEcEm37MwV-V(1CshSG+XBlAAMT9=^ZEW- z9U8g4+4a96|e-4QLqWgnJs09k)U^3K+0CQxk;ul>`S~ zJUEr?D(KGu58>ocr3V7RDcRPBV=aK}X{=-D$Occ8%gv8=WCKH`L<&h+T!8NlR+co7 zZV+!?y|U8+7Vj$MUP34)I*fEiOANkfo+7QOh2YMXF!2TWJO{<*FY{I|m8x0rP{l5rc>pftxTo-?=d@ zrpH&yGy>bYlojAK7vRkFDG$)?9T>#>y<+jMgV@|>O~Atb_6uBfIJ*xskj2S9lvCXl zLoe3m6rJrg)9~t{A1s_v0xLy-PRMo1K?!@_pOzlJ7N(k#t^)Kd@sxF8)f|GYC~?pA3Ln`RK}@&J4flGEc!V*7VG zgUCJbAmJ-Q1>%3#EaevfrtejQ07(#7UBe(&l~lvK5{(C5TnlMjzUDxDdt%ZWo%3Z% zHw=HpH?wmCXpb5jkO42c?!|vUS!m7H-86_L6M8G%)gY|Y#=P`V5OqpM>AL+kY7pU{ z@IL%K3V|RtewI}6g2wae1o!$fv2!l=LVnx+6PSoHy~}SP5Mu6oIy*~qv%giQks2&_CmxefUF?u;?;>=2qoU$V zP7YO`P5Y2(guWFX)#;zzx0GfOu4PV+Wr1+?56|fS6a-@btGcxh$c17 zlUof(Z0L5DUWr>)7ws5n`#@xOSYTp8v4(t7<&D(!)O5Ufznm`!b_pDIj6D41ZA zJ18;mBXj{7(2;!T0C%H0pCXxyhDfMJ55iRVuqP=gbSyx;BHVK|k7SzIWZrjHy3|5Q z5WuwHMf;sf8NxcH*LYZ-ERaKPUfgsPi?3C>0sxMmG z5tBv-B84hqDA^tWIr{}N#G61@WvBL_x}Ybk9Yny4kQQ`A2sc&!Pcd<=poF{^9_ z$Nqw_l3PNM!kbzoRaN_oS30@^0%5uI$jMrCe#oz7k78pKyfd$K#NOoD;nJ02~xbp3x#*y z`{mx7HJMp!K1|M>bDsVD_D-z&dwF~uY8(&%+K3=jP(X|Y6A6K zjbUGQ;?lo_VCk#Fs#DOg1e6X>pHsm+avqY?s@b=QG@FS$1R^{8HehdT>}_~kTbm0O zR;MJI017GtCMv@a1tUFuaeaL~7xVGak<&&8BK`hiyHBs?qa^B;r@TBSlhb;ej-g@v zFg=!jchJ8Eo5{bLsY+jIgvETudb}rN-KDHdFg6v*Q&Z5ej46xdoO~k-}dz@Iy*=_^lBK!SW;55%se_e zx=axr9Q=64^V!TK?|qq`o*tvyi$LL8NL7_4RuOswykFD;ivP2cx2*e$AGpAuNT~+C15@QqQ{{2%f?USL&3v zQgU*>mz015!N1nqz0a5Gc6-AypPrtUmW|uJeEt2Ue+~@|jgI2V;EHYv3JM-f7DkVy zrjjTsDo){^{LsisIaUT~48;g%QBNVzmFc7K0B=wG;pKNrk)(or< zzR=(74mMF%#vKKwnw*%Jir-e<+IqiKF^x`MOKWy!CiT)jE-sEPLQ_+-ry36%8ygoF zJWfJEfoWtmN?Ek~UFQcKJtHGu(BmDUGh%-JMf+zsT#y@siAa0ROQ^;zBY)WP;OC|r^ix_lXIYmWmCbagD zmKLFh1D6UyXY5kqjF4v%^4##ZKi)a52^}gFp_h7}tzk2~90n!>W%A!royE4cmKLdv zuW5Ky)oEey6Sf^rBgk)R@6DBIJ!ozN|=^yKyC}43lzfA7^70gl1QAXUu>d-{p7ZIFgooR-j!xG8ei;TtXpam~ znc8zE2n3a;=8VujZ>0UJ!q|cWtw>)#Xewmg=Q66gxHy&vTvSx_nw6C>TcL_>>+|Q& z%uE*)oOuqPKH1vaxB2`Q4V5@NIoX*l5(S3^sc=8Juq+ix#-mxY=qoFaUToXHeEBkq zcDs@-U5OQDxot>^CCLzZWsy^q0!kjr%vdP$lEAP#2i3XmkHt1NKJfDLl9TH`JvBrI z)Uh%QiBuX~TPPxq5ow)0b9cuz?m)fKymgXCO7!qhUT0_jij5_#+u~@j9`|%_FllyD zuIbfJX=X4gn*DWjlyg!mMnXa&9femsdz``^57KRW7peL8c2lobADG(AqoX4-GBTKf zr0Kh(Xo8m}^_D^E>U1g6s)-(V7i`EXI&PE*bxlo0)j*?p7Hdqv@xa~Cb z^b9{J8aBQLCEx+d!T?h!(YbqgaEZ*2PL-zQv52C8uS`#=V~)}jVF?O)oe;rdAU_=( z`-fPYnwqLix~(S*{*_Cn7;HxYC25ZFzdhjp9J~t80wHS3#oV_lh+&1yOuec3dFfPe zG0pTe1r(Z1V}AG7Z)y1ha(|!Bjn1R5&myjo-~9j|8@r=m!zC~fECVdItu0BXxwI#WB zy1KT}4|jBVS!gpzm0aLBg()={Z`c(7~1`;2E|9UVcXj~nZI?WO6d5)aL4iRPQcUCbQx>Q zKk4S?CL|IzU=?`8vc_xJA!Xp;|)slQj0m)F5*;dPBCO+7+tlc)6bPDx3b z)yBDXmWtQ$6!qblHEWHEhFT4E6|uTHFS;y-`dHPhISny{6QVHaP#*2?qwuF}cgxhe z5i19e&w|cTsRLiXZk(MBJwKR)GDK%(EycZH$HBn~p>p3J>*d8p3#+TE>md~IRn2mN z(xVI$7p4?_uf)TME6ZJ-&wWc;QZgwkYi9M0>tjH``9~YW)yExkX?gi!VQO-(`@uwi z9-ei)hI&*gt&blnoUF;=L7g3ym0KxbZoeyAWo2ccyUWUM8-THpS-jq7PgRDbT3UL* zvmQ2}9QgRMzP=ouo|PaEUmaC^Zt%?Cckfsj{bLi)2hGRSt*mCIii-l#5+OnhO#gsx zOe^Y>qV%;so!xL0>rEGpn31+Nzn~bc(6+Ey*yz=-k+?W9Qr3Fhp5^xos0RNT$=4j8 z#X{MQ(AY|c{E@bHcG=>=Vkvz;e@d0_WQ1JkxBK53iHoO@tN%_5e)2v3iGK6J3LX8W zs;Vg=8GFFLzjg%fyp$-(=ZA-&5*;HIQ%tVSANo2v^W_>P`xE)2-t(XX)POlcD6A{Z z!rSN0M?^%SeQA~T>(|7oKrX4%ue(EK90pg%bry6|jRO31@^K1{k53Q9o59a_`{R>c zr#7vvjMvw)zVqLAlTZ$jNI;vdmvhY~wNQ3}GFb*YXD=@|goU}`;`VCo9nE<+D=~Op z+Z0vng%p0FV;#x{pW*#>&r}Ix{bXumQ&i?HD7yA@iEdw*EI@&8eYVAMB>**78ze#h)xKh0Rc#I*g=@I{vapMovL7s+*$>kcN;cpootJZUlm`v_i8px@S2jMB9n{fd-UR6l+JE(md0v-y)JjDRNb zIK!mnj*y*?yg|;;gm0Um_9Dl66T1 zR3un|f4sl{n3*}dbvl5<2Zv0K_afDU4fG?9RR`}c4=6Z|UUP8~emey4QVqZ;V&dPC z7U$;b%e`8Wh3dHIN8`*mW1Kv|hxYu0;%Dp41u3I|;XbB6uR2!P!^f+3HKHSs_v z|GV*X9XUKQ5*Hi0+~IqF7jDZN|sO zVq$PMHMk!g+D5C`&UAFF8MoiGwW_YQdwc8X?Cp;`Y}dX*Qu12HbajbwPqZ9B&lY=n z!yf<)3#(#Z>k8bhHZ}~p-%}3?`lzL~`%P7Zf$=#ZIr-s}btAk9-Fex~_Tar&Qh4&@ zbqv;q$&VS64j)*4UY;a_U1=$kg>X@3CZ{ovV@|N6V^wD-`s#^(i%Ugk=j{9sp6-9} z%|-9Qm8RUu0_eKDbq8ZKEpCc_ow=;Ev^1dK`wbz#c|w|$6cqvdC&0&#^6(XIDxwRP z;9T99<`EZaIUCQN8&k2DMbB8CTYLQPZRTcK-8Bw=qM3ogyAx?5dcs#?LVj2L3nmtW zOZ6ryODikVKl}R|J33C3O~SVI!~a7;K~Yszb#-;cCI1f#A3yRu^t+CYO=eTm_~G;d z)LWbz9+_2sh#LI-za7Wt#%CQ(R4ibKfLJom2LRvkJvk3gPk7zOKE7A!H)jzoEog$* zXk=2Gx4VB|3-`=?=nA+8JP$Amyl9{$><%RtLjB>&@o} zGczRI6-zeTY|c+>urgO&U3iH+Abk#hkf0Gg^pw77*T-zWA-yUCLv3xJ^N%y1*~B_C z`gfUgavyk%AE9~~QpF*AW|o!_FR7`i!>TK)t7*&aLzGc@r#3cb2CUYa9P~n%^K23m zR0>3Wk-L1q8&(gkBzsFkKw1wds$e!^8U97GzjxZ#e+Y&d#@8 zf^20yCBv>+7fF<=y{E@t65R79e(W6+Dbbls++GQ4HVS9ugxqEX$LlDgN;=%iHUl zxNyrdj_?iI>DM4kW&^-9C&yrAj7%RcIb>ECnmx9Qgx7sC@1 zf_v(#pWLo+ru3<(xJXEy<>gIO6kCT(=Y|G1xZgHIdfF#PMlP;A(lavZ>ZlG*q2s;V zm^%+?<`TJ;AKJ7{8xe19H7BB&iJ0>9jr|;#Zih8AG+>#TnC8-z;n`ThmDxMLT2A{4`+(ud-0 z2n_=RYGUG03yuPed*VJG{2Y^E$*OYDvf%V`HrtF#%K#9HxVZ>5x|ellQXK7bF+?XO zj?e$lyKiH8qoh=Wur%;&!f~L#Ygk)za_%Zc^Sq>hNfX&KylJyWkXW#?vhy`8z~Kq3 zYC+;ITc5P&^8Ihs-{Oi0gK%vo9(yM^Irth%8ZNJDy2B{6G<5c$W~fKj+sv4)l_$O* z3*tNfeQgnfu*;y*-S>hO9#jhw{@y7gB#YH&W@h|2e*ele?ErBLe5p2ehc`h7h~J`s z8HPY9C8edv+s*9Dta!jlva_F_ob>ni1Cj`ck8dGl7l1=>EX~1W3GGXXnA*g(Sj(%m zr={J}3Zv%iDKnhYb+8Hp*+CL5^v#<$BW1;ClP8(R_U%a|-)MQA6^ZYgf}T_!wTLrR(kV4m|Te0+MEhl{JGrA0sXS}-S*{;g%q{bGV}`0#Y1_|qNWo68vG5<+AG z0v^-Z_0%IcEmOQo%FACT2^8Yop|D_`$Kyvh%K)y+i;$3zjcuRA$Jh6MyDwTzj<149 zm^%f5ES8S0{@6)9BLO>IZ6>7Vk70=s`NnXS3t=Lu00O$uCMbH+i^I?F%SHoh5m;f| z)TMy$FOpA4NEmEbVBT!=blCnG34TF@7kb{A4)wnQe&B0aSu-3ykuS2?#`=lm`AdQv zd$Bql4B+n9T+elZT|`gW5Rd~o+P5g;>1hY=)3AuN8fOPX!<&4O!cMiK+V=XeXaHk* zD-mHn*w|obC+zRv@$_4Pbu?~9+FG{Zle5Umv|EYJ$AnG_Ugl=nr3LN!3F*pf5faeUY5v>_T?svAL(pPwHYd5?z?o^N42xOV;e-Cu^J7kKYP z9)7ci)iAnY{Rbq@0fDT0`}?LMq~;1rehMs^rKQ{@aX@&1iH^>~R2q*po=YN=#-c?)$J5{B_2z1S$%$^7D`fSkr3OageIV&(R2{ zbL#-Z-7l9LVC8Hnz`!U* zADY6#9%p72m&`OY=(CN!7Zt_K;h?%VZK{bog0w8=UYAr?SLfv&w0l1@AVUv`gg1JJ zhMdPJb6M5uLm<|G9$MVSK%^2gGBSKG9~l|G^sMyMMH#55%9nnHrjzY}mSZ4e-X&UP zej)yvI2Y`?cuw;B226CGkY(QfuJl*-A8w5rNc!+{R*TT(hE2FQ?bu`XzMr25t# z+hybTr+#_HK(N-a@bI{KcsgAf*?4*18yb2eQhkBjD%!d;OicaZ;nGcw9>7Oh`YkWz zH9kHb5KZP~WeLGY@w~8N|NiykhllkFIJ%Aw*$T0BmduX}37Dq%xeEXIGXa@tP)Z4R-&KHml zJP#!so3h5nv0~|=@o^4fVWKP%xrm5Lz=Y;S4%kBY?tZSPvs19L+JsR^7pKs(GBO%} z{3xlXN4N};!lbT}GT8)KVDxNkC~9c5!r?6M{(dPdV@Li!NgLKnV56z3CUTj0Idft& zfy8wsC8zr=aLOsMSuVD^L7^!I#0*SKYa1;*Xe7>?U7nszG-3fVfq~F;rGN>>IE#{3W}(0TgcSY% z3+eoPpNUD`jkUCJVc|4+ySOL({&-VZYL|v56geKuSE_{p952<>lqKx3@GjG~eIfEiEnW?d`Czu&Jr3;Nalg+}zmM z*qWM}{QUg!@$u~J?BnC(;^N}n-QC;U+p@B<6ciN0!^6SB!9+wv_xJa|zrSH&VO?Ea zQBhGgHa03MDi;?Q`T6+0(2=H}+v+1b(2(Zs~WwY9aRq@FMdt&d$ln$+@|?wzjsctgN1%o|&1Mk&%&)kB@|ego1*CbaZrV zY;0+1X=7t!TwGjNS65S0Q$0OBH#avjGBPVGDCW*rGS8detv#^eSLOzc5!iW zaBy&CWo2MsU|wEcSy@?CRaH+NxVX5SoSd7Ro0yoGmX?;2 zlarE?l8}&)i;IhSd3kkpb#iiYZEbC5XJ=++W>!{KP*6}!O-)5bMMFbFK|w)3KR-M? zJUTi$FfcGFDJdu@C1Zy}P@+v$M0Yv9YeMuBfP}wVRuajEs1Acz1Vq zWMpJwVq#8CPD)BjE-o%2A|eY53;Loh!T)j9} z>^5Zrle6c%v)>8i-prjZzucKC0gC!9h95I+EotpAM1AC8E3%+*LD=AW)wdx-BwuXhNsO9%I z=af(`cdvI|GI(saCDP1MiXJ{mou7BUMrCZ`{peH`o)tWN5B@~033ud$FPgd8jz1}a z8mr|y2K(8H7L~ct&EbfA)lN75q3oGbQQel;sL7$jzg{-GC@TFUih5=ge^yF!8}e*+ zw>P-(ZL@PPP!@O=fZm>-YTGWrq&zuxV|k7F}n; zb0AzKSh@3vb9h+z29;raX+r2Gx%R+6smsG@2`_X7<(HY{f4_~1Ifqx-Gfa8$DvM8* zk<(`R3}kZre_0oBq`^>*eh)k;dfPv##gI8z#uy@p6+EMD0!$9ryS*{U!+zzj)rP9_ z4PV347yu3%4%JxEBfIZzav)}_V2~$cL+xxsbqP8fp6=Pg`Adp$Pb+z1TqXbr+`};gyEB6CO93Ab3&VDffZbA^g1W$WHtWeIpN9`bHLh{NR?&An$+(or4ciQ!^jl))JyFh%SKB~v z87}5}?|Ba#<8yUzS>W~GPuw#9(c3>xW8qE+H+QKEzT%HIUYG(aGl@rXLt%yMb)a*_ zzdgwHf*_P&13(;(1$RLlYEGT98StFQDh*Y-pfmBXi6@A7wm&>?jr(U+hnIkOG|-YI z&s-1Snq3MS!5DojK-7STyZ0#{80_&(j96lUXXr3`3cFjb?G%2xIQU^994*iIdt~9m z;4mkjV_iYbM~&?cMzncx5%;~Bif8E%v&a;juVRNviqUQFFX({>@Ybq+ajX~8OGTU!L&g3MFz7kTe4ScpkyXkCj zQCg9y=P#%&vW|y4PAkI{HQGrqQGo%+aU$HwaKI$cH!nmRR}55Qx|d{^E}m`biN$BF zb-kt(JK%G~lZbX=40s#uK(pB!e+TWGitsQO11FF&BpsQM@pFPiq{et1+M+1H@RuDQ;Q3Zh|*zKfLS54c08dz~^uo zxN53bB@Y^3SG1!BdyoOoV|T|2App5vv1F8SWNZxVd6Dyj&*1USmHn)L5J$XTnBT5T z@Ev1eK4x%f&4(id^?A&I?Ah%80*BUmF+xzkhsDtPHA2vUrw=414>p_4B|mKYo(H@4 zH>ama`bm7uk!<^gLJs($Bg?mJi z8EZAVjy>L0*pKz`s<`(|3aR&FZEm!=Y z@j+gT>xF0S^I{IJthB1BcO*46K{EmFII$183D(`~$$oiiM!a zs*RF*ZiLg191WgD7riUZdXNDR3l>D&{J8rt+&)VV)^@yUx{rOImCD$Hs}`~v-6Pj>mvH|&#*zi z^q2#2+4h!ukO9vVW@?qJw=mvi20afl;OPe`jwnpqMs8f%TbFe$zonz+K?Xd%AYQRY zwx8ioQ*yRYC{)0jb)+&aIyzcjhw{^y5Bp!X8`^^mc=~!M4o{M9*&-<*X#-Rh#f5RO zmK2xGi8!(D250v6z%S~D_8no*GTE5NT zhI+usy|F`kkO7YYWIr*qG#ZYF5>K#mG}PjF*xdvmzX959K=#+yz98E)XBr-4z(YWz zAu=M(;mbKFiTPOc==FK%@3prWpk^_&hJzbUnv|WYK_MLvGT<@vkg~h(a@cje?FF39 zFX7x(cXwCdPO$?!&()$2?IC~O2V1zbJjj5D<(v9h>KO9986^M*zq2J@n`6is3)&6a zdj7PYy_^0|K+l5=c)mC8n2CpXZteWOGd3>kKiTD9uLE5Vj@(0cPfgE*40u>fdXNDR pi%AbM;9)W8`4#^E^;?*W{{b*P$gXx9X{`VN002ovPDHLkV1i18S9bsa literal 0 HcmV?d00001 diff --git a/doc/type/style.txt b/doc/type/style.txt index e69de29b..d11d8aa4 100644 --- a/doc/type/style.txt +++ b/doc/type/style.txt @@ -0,0 +1,128 @@ +Data type: style + +--Overview-- + +A style specifies how a [[type:field]] should look, +things like position, size, fonts, colors, etc. + +Styles are part of the [[file:style triangle]]: +| Description Looks Data +| [[type:Game]] [[type:Stylesheet]] [[type:Set]] +| [[type:Field]] '''Style''' [[type:Value]] + +--Positioning-- + + +A style specifies the position of a box for the content. +To specify the horizontal location ''two'' of @left@, @width@ and @right@ must be specified. + +For example: +> left: 10 +> width: 20 +Implies that @right@ is 30 pixels if the card is 60 pixels wide. + +Similairly: +> left: 10 +> right: 30 +Implies the @width@ is 20. + +The same holds for the vertical location and size; @top@, @height@ and @bottom@. + +--Rotation-- +Some types of styles allow an @angle@ to be specified. +The angle gives a counter clockwise rotation in degrees of the ''contents'' of the box. + +For example, a text field with style: +>example: +> width: 60 +> height: 40 +> alignment: top left +Would, with different angles, look like:
+ + +--Properties-- +! Property Type Default Description +| @z index@ [[type:int]] @0@ Stacking of this box, fields with a heigher @z index@ are placed on top of those with a lower index. +| @left@ [[type:scriptable]] [[type:double]] ''Required'' Distance between left edge of the box and the left of the card in pixels. +| @width@ [[type:scriptable]] [[type:double]] ''Required'' Width of the box in pixels. +| @right@ [[type:scriptable]] [[type:double]] ''Required'' Distance between right edge of the box and the right of the card in pixels. +| @top@ [[type:scriptable]] [[type:double]] ''Required'' Distance between top edge of the box and the top of the card in pixels. +| @height@ [[type:scriptable]] [[type:double]] ''Required'' Height of the box in pixels. +| @bottom@ [[type:scriptable]] [[type:double]] ''Required'' Distance between bottom edge of the box and the bottom of the card in pixels. +| @visible@ [[type:scriptable]] [[type:boolean]] @true@ Is this field visible at all? + +The rest of the properties depend on the type of [[type:field]] this style is for. +! Type Property Type Default Description +| @"text"@ @font@ [[type:font]] ''Required'' Font to render the text. +| ^^^ @symbol font@ [[type:symbol font]] Font to render symbols in the text (optional). +| ^^^ @always symbol@ [[type:boolean]] @false@ Should all text be rendered with symbols?
If set, @font@ is not needed. +| ^^^ @allow formating@ [[type:boolean]] @true@ Is custom formating (bold, italic) allowed? +| ^^^ @alignment@ [[type:scriptable]] [[type:alignment]] @top left@ Alignment of the text. +| ^^^ @angle@ [[type:scriptable]] [[type:int]] @0@ Rotation of the text inside the box, in degrees. +| ^^^ @direction@ [[type:direction]] @"left to right"@ Direction in which the text flows. If set to @"vertical"@ it is as if a line break is inserted after each character. +| ^^^ @padding left@ [[type:double]] @0@ Padding between the text and the border of the box, in pixels. +| ^^^ @padding right@ ^^^ ^^^ ^^^ +| ^^^ @padding top@ ^^^ ^^^ ^^^ +| ^^^ @padding bottom@ ^^^ ^^^ ^^^ +| ^^^ @padding left min@ [[type:double]] ∞ Minimal padding around the field.
When the text is scalled down the padding is scalled as well, but it becomes no smaller than this. +| ^^^ @padding right min@ ^^^ ^^^ ^^^ +| ^^^ @padding top min@ ^^^ ^^^ ^^^ +| ^^^ @padding bottom min@ ^^^ ^^^ ^^^ +| ^^^ @line height soft@ [[type:double]] @1@ Multiplier for the line height of 'soft' line breaks. These are breaks caused by wrapping around lines that are too long.
+ A line height of @0@ means all lines are in the same position, @1@ is normal behaviour, @2@ skips a line, etc. +| ^^^ @line height hard@ [[type:double]] @1@ Multiplier for the line height of 'hard' line breaks. These are breaks caused by the enter key. +| ^^^ @line height line@ [[type:double]] @1@ Multiplier for the line height of 'soft' line breaks. These are breaks caused by @"\n"@ tags. +| ^^^ @mask@ [[type:filename]] ''none'' A mask that indicates where in the box text can be placed.
+ Text is never put in black areas of the box:
+ +| ^^^ @content width@ [[type:double]] ''automatic'' When read from a script, gives the width of the current content in this box. +| ^^^ @content height@ [[type:double]] ''automatic'' When read from a script, gives the height of the current content in this box. +| ^^^ @content lines@ [[type:int]] ''automatic'' When read from a script, gives the number of lines of the current content in this box. + +! <<< <<< <<< <<< +| @"choice"@, @"multiple choice"@, @"boolean"@ + @popup style@ @"drop down"@ or @"in place"@ @"drop down"@ Where to place the drop down box for editing the value.
+ @"drop down"@ places the box below the field, similair to normal combo boxes.
+ @"in place"@ places the box at the mouse coordinates. +| ^^^ @render style@ [[type:choice render style]] @"text"@ How should the field be rendered? +| ^^^ @mask@ [[type:scriptable]] [[type:filename]] ''none'' A mask to apply to the image, black areas in the mask become transparent, similair to [[fun:set_mask]]. +| ^^^ @combine@ [[type:combine]] @"normal"@ How to combine the image with the background? Can be overriden using the [[fun:set_combine]] function. +| ^^^ @alignment@ [[type:alignment]] Alignment of text and images in the box. +| ^^^ @angle@ [[type:int]] @0@ Rotation of the text and images inside the box, in degrees. +| ^^^ @font@ [[type:font]] Font to use for rendering text (depending on @render style@) +| ^^^ @image@ [[type:image|scriptable image]] Image to show (depending on @render style@).
+ The script will be called with @input@ set to the value to determine an image for. +| ^^^ @choice images@ [[type:map]] of [[type:image]]s An alternative way to specify what image to show.
+ For each [[type:choice]] a separate image is specified. +| @"multiple choice"@ + @direction@ [[type:direction]] @"left to right"@ Direction the items are layed out in, only when @render style@ is @list@. +| ^^^ @spacing@ [[type:double]] @0@ Spacing between the items. + +! <<< <<< <<< <<< +| @"color"@ @radius@ [[type:script]] @0@ Radius of rounded corners for the box in pixels. +| ^^^ @left width@ [[type:double]] ∞ Draw only this many pixels from the side, creating a box with a hole in it, or a card border. +| ^^^ @right width@ ^^^ ^^^ ^^^ +| ^^^ @top width@ ^^^ ^^^ ^^^ +| ^^^ @bottom width@ ^^^ ^^^ ^^^ +| ^^^ @mask@ [[type:scriptable]] [[type:filename]] ''none'' A mask to apply to the box, black areas in the mask become transparent. + +! <<< <<< <<< <<< +| @"image"@ @mask@ [[type:scriptable]] [[type:filename]] ''none'' A mask to apply to the image, black areas in the mask become transparent, similair to [[fun:set_mask]]. + @default@ [[type:image|scriptable image]] ''none'' A default image to use when the card has none. + +! <<< <<< <<< <<< +| @"symbol"@ @variations@ [[type:list]] of [[type:symbol variation]]s Available variations of the symbol, a variation describes color and border size. +| @min aspec ratio@ [[type:double]] @1@ Bounds for the aspect ratio, @width/height@ symbols can take. This can be used to make non-squary symbols. +| @max aspec ratio@ [[type:double]] @1@ ^^^ + +! <<< <<< <<< <<< +| @"info"@ @font@ [[type:font]] ''Required'' Font to render the text. +| ^^^ @alignment@ [[type:scriptable]] [[type:alignment]] @top left@ Alignment of the text. +| ^^^ @padding left@ [[type:double]] @0@ Padding between the text and the border of the box, in pixels. +| ^^^ @padding right@ ^^^ ^^^ ^^^ +| ^^^ @padding top@ ^^^ ^^^ ^^^ +| ^^^ @padding bottom@ ^^^ ^^^ ^^^ +| ^^^ @background color@ [[type:color]] @rgb(255,255,255)@ Background color for the box, can be used to make it stand out. + +--Example-- + diff --git a/doc/type/symbol_filter.txt b/doc/type/symbol_filter.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/doc/type/symbol_variation.txt b/doc/type/symbol_variation.txt index e69de29b..cc237af6 100644 --- a/doc/type/symbol_variation.txt +++ b/doc/type/symbol_variation.txt @@ -0,0 +1,46 @@ +Data type: symbol variation + +--Overview-- + +A variation of a symbol, describes color and border. + +--Properties-- +! Property Type Default Description +| @name@ [[type:string]] ''Required'' Name of this variation, refered to by the [[fun:symbol_variation]] function. +| @border radius@ [[type:double]] @0.05@ Border radius of the symbol. +| @fill type@ @solid@ or @linear gradient@ or @radial gradient@ + @"solid"@ How to fill the symbol. + +Depending on the @fill type@ there are additional properties: +! Fill type Property Type Description +| @"solid"@ @fill color@ [[type:color]] Color to use for filling the symbol. +| ^^^ @border color@ [[type:color]] Color to use for the border of the symbol. +| @"linear gradient"@ @fill color 1@ [[type:color]] Color to use for filling the symbol at the center of the gradient. +| ^^^ @border color 1@ [[type:color]] Color to use for the border of the symbol at the center of the gradient. +| ^^^ @fill color 2@ [[type:color]] Color to use for filling the symbol at the ends of the gradient. +| ^^^ @border color 2@ [[type:color]] Color to use for the border of the symbol at the ends of the gradient. +| ^^^ @center x@, @center y@ [[type:double]] Position of the center point of the gradient (in the range 0 to 1) +| ^^^ @end x@, @end y@ [[type:double]] Position of the end point of the gradient (in the range 0 to 1) +| @"radial gradient"@ @fill color 1@ [[type:color]] Color to use for filling the symbol at the center of the symbol. +| ^^^ @border color 1@ [[type:color]] Color to use for the border of the symbol at the center of the symbol. +| ^^^ @fill color 2@ [[type:color]] Color to use for filling the symbol at the edges of the symbol. +| ^^^ @border color 2@ [[type:color]] Color to use for the border of the symbol at the edges of the symbol. + +--Examples-- +'Common' and 'uncommon' magic expansion symbol styles: +>variation: +> name: common +> border radius: 0.10 +> # White border, black fill +> fill type: solid +> fill color: rgb(0,0,0) +> border color: rgb(255,255,255) +>variation: +> name: uncommon +> border radius: 0.05 +> fill type: linear gradient +> # Black border, silver gradient fill +> fill color 1: rgb(224,224,224) +> fill color 2: rgb(84, 84, 84) +> border color 1: rgb(0, 0, 0) +> border color 2: rgb(0, 0, 0)