class_textserver.rst 324 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/TextServer.xml.
  6. .. _class_TextServer:
  7. TextServer
  8. ==========
  9. **Inherits:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
  10. **Inherited By:** :ref:`TextServerExtension<class_TextServerExtension>`
  11. A server interface for font management and text rendering.
  12. .. rst-class:: classref-introduction-group
  13. Description
  14. -----------
  15. **TextServer** is the API backend for managing fonts and rendering text.
  16. \ **Note:** This is a low-level API, consider using :ref:`TextLine<class_TextLine>`, :ref:`TextParagraph<class_TextParagraph>`, and :ref:`Font<class_Font>` classes instead.
  17. This is an abstract class, so to get the currently active **TextServer** instance, use the following code:
  18. .. tabs::
  19. .. code-tab:: gdscript
  20. var ts = TextServerManager.get_primary_interface()
  21. .. code-tab:: csharp
  22. var ts = TextServerManager.GetPrimaryInterface();
  23. .. rst-class:: classref-reftable-group
  24. Methods
  25. -------
  26. .. table::
  27. :widths: auto
  28. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  29. | :ref:`RID<class_RID>` | :ref:`create_font<class_TextServer_method_create_font>`\ (\ ) |
  30. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  31. | :ref:`RID<class_RID>` | :ref:`create_font_linked_variation<class_TextServer_method_create_font_linked_variation>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  32. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  33. | :ref:`RID<class_RID>` | :ref:`create_shaped_text<class_TextServer_method_create_shaped_text>`\ (\ direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |
  34. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  35. | |void| | :ref:`draw_hex_code_box<class_TextServer_method_draw_hex_code_box>`\ (\ canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |const| |
  36. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  37. | |void| | :ref:`font_clear_glyphs<class_TextServer_method_font_clear_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  38. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  39. | |void| | :ref:`font_clear_kerning_map<class_TextServer_method_font_clear_kerning_map>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |
  40. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  41. | |void| | :ref:`font_clear_size_cache<class_TextServer_method_font_clear_size_cache>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  42. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  43. | |void| | :ref:`font_clear_textures<class_TextServer_method_font_clear_textures>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  44. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  45. | |void| | :ref:`font_draw_glyph<class_TextServer_method_font_draw_glyph>`\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| |
  46. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  47. | |void| | :ref:`font_draw_glyph_outline<class_TextServer_method_font_draw_glyph_outline>`\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, outline_size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| |
  48. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  49. | :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`font_get_antialiasing<class_TextServer_method_font_get_antialiasing>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  50. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`float<class_float>` | :ref:`font_get_ascent<class_TextServer_method_font_get_ascent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  52. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | :ref:`float<class_float>` | :ref:`font_get_baseline_offset<class_TextServer_method_font_get_baseline_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  54. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. | :ref:`int<class_int>` | :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_index\: :ref:`int<class_int>`\ ) |const| |
  56. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  57. | :ref:`float<class_float>` | :ref:`font_get_descent<class_TextServer_method_font_get_descent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  58. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  59. | :ref:`bool<class_bool>` | :ref:`font_get_disable_embedded_bitmaps<class_TextServer_method_font_get_disable_embedded_bitmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  60. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  61. | :ref:`float<class_float>` | :ref:`font_get_embolden<class_TextServer_method_font_get_embolden>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  62. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  63. | :ref:`int<class_int>` | :ref:`font_get_face_count<class_TextServer_method_font_get_face_count>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  64. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  65. | :ref:`int<class_int>` | :ref:`font_get_face_index<class_TextServer_method_font_get_face_index>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  66. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  67. | :ref:`int<class_int>` | :ref:`font_get_fixed_size<class_TextServer_method_font_get_fixed_size>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  68. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  69. | :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` | :ref:`font_get_fixed_size_scale_mode<class_TextServer_method_font_get_fixed_size_scale_mode>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  70. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  71. | :ref:`bool<class_bool>` | :ref:`font_get_generate_mipmaps<class_TextServer_method_font_get_generate_mipmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  72. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  73. | :ref:`float<class_float>` | :ref:`font_get_global_oversampling<class_TextServer_method_font_get_global_oversampling>`\ (\ ) |const| |
  74. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  75. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_advance<class_TextServer_method_font_get_glyph_advance>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  76. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  77. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_glyph_contours<class_TextServer_method_font_get_glyph_contours>`\ (\ font\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| |
  78. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  79. | :ref:`int<class_int>` | :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, char\: :ref:`int<class_int>`, variation_selector\: :ref:`int<class_int>`\ ) |const| |
  80. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  81. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_glyph_list<class_TextServer_method_font_get_glyph_list>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  82. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  83. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_offset<class_TextServer_method_font_get_glyph_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  84. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  85. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_size<class_TextServer_method_font_get_glyph_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  86. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  87. | :ref:`int<class_int>` | :ref:`font_get_glyph_texture_idx<class_TextServer_method_font_get_glyph_texture_idx>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  88. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  89. | :ref:`RID<class_RID>` | :ref:`font_get_glyph_texture_rid<class_TextServer_method_font_get_glyph_texture_rid>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  90. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  91. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_texture_size<class_TextServer_method_font_get_glyph_texture_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  92. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  93. | :ref:`Rect2<class_Rect2>` | :ref:`font_get_glyph_uv_rect<class_TextServer_method_font_get_glyph_uv_rect>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| |
  94. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  95. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`font_get_hinting<class_TextServer_method_font_get_hinting>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  96. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  97. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_kerning<class_TextServer_method_font_get_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  98. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  100. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`bool<class_bool>` | :ref:`font_get_language_support_override<class_TextServer_method_font_get_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
  102. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  104. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`int<class_int>` | :ref:`font_get_msdf_pixel_range<class_TextServer_method_font_get_msdf_pixel_range>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  106. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  108. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  110. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_opentype_feature_overrides<class_TextServer_method_font_get_opentype_feature_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  112. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_ot_name_strings<class_TextServer_method_font_get_ot_name_strings>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  114. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  116. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`float<class_float>` | :ref:`font_get_scale<class_TextServer_method_font_get_scale>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  118. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`bool<class_bool>` | :ref:`font_get_script_support_override<class_TextServer_method_font_get_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |
  120. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  122. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  124. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`font_get_spacing<class_TextServer_method_font_get_spacing>`\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| |
  126. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  128. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] | :ref:`font_get_style<class_TextServer_method_font_get_style>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  130. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  132. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  134. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  136. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`int<class_int>` | :ref:`font_get_texture_count<class_TextServer_method_font_get_texture_count>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  138. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`Image<class_Image>` | :ref:`font_get_texture_image<class_TextServer_method_font_get_texture_image>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| |
  140. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_texture_offsets<class_TextServer_method_font_get_texture_offsets>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| |
  142. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  144. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :ref:`float<class_float>` | :ref:`font_get_underline_position<class_TextServer_method_font_get_underline_position>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  146. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`float<class_float>` | :ref:`font_get_underline_thickness<class_TextServer_method_font_get_underline_thickness>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  148. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  150. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  152. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`bool<class_bool>` | :ref:`font_has_char<class_TextServer_method_font_has_char>`\ (\ font_rid\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) |const| |
  154. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :ref:`bool<class_bool>` | :ref:`font_is_allow_system_fallback<class_TextServer_method_font_is_allow_system_fallback>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  156. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  158. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :ref:`bool<class_bool>` | :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |const| |
  160. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :ref:`bool<class_bool>` | :ref:`font_is_multichannel_signed_distance_field<class_TextServer_method_font_is_multichannel_signed_distance_field>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  162. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :ref:`bool<class_bool>` | :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |const| |
  164. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | |void| | :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |
  166. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |void| | :ref:`font_remove_kerning<class_TextServer_method_font_remove_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |
  168. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |void| | :ref:`font_remove_language_support_override<class_TextServer_method_font_remove_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
  170. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |void| | :ref:`font_remove_script_support_override<class_TextServer_method_font_remove_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |
  172. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |void| | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  174. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |
  176. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`font_render_glyph<class_TextServer_method_font_render_glyph>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, index\: :ref:`int<class_int>`\ ) |
  178. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |void| | :ref:`font_render_range<class_TextServer_method_font_render_range>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |
  180. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |void| | :ref:`font_set_allow_system_fallback<class_TextServer_method_font_set_allow_system_fallback>`\ (\ font_rid\: :ref:`RID<class_RID>`, allow_system_fallback\: :ref:`bool<class_bool>`\ ) |
  182. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |void| | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>`\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) |
  184. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`font_set_ascent<class_TextServer_method_font_set_ascent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, ascent\: :ref:`float<class_float>`\ ) |
  186. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |void| | :ref:`font_set_baseline_offset<class_TextServer_method_font_set_baseline_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`, baseline_offset\: :ref:`float<class_float>`\ ) |
  188. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |void| | :ref:`font_set_data<class_TextServer_method_font_set_data>`\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  190. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |void| | :ref:`font_set_descent<class_TextServer_method_font_set_descent>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, descent\: :ref:`float<class_float>`\ ) |
  192. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |void| | :ref:`font_set_disable_embedded_bitmaps<class_TextServer_method_font_set_disable_embedded_bitmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`, disable_embedded_bitmaps\: :ref:`bool<class_bool>`\ ) |
  194. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |void| | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>`\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) |
  196. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |void| | :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`\ (\ font_rid\: :ref:`RID<class_RID>`, face_index\: :ref:`int<class_int>`\ ) |
  198. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`font_set_fixed_size<class_TextServer_method_font_set_fixed_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size\: :ref:`int<class_int>`\ ) |
  200. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |void| | :ref:`font_set_fixed_size_scale_mode<class_TextServer_method_font_set_fixed_size_scale_mode>`\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>`\ ) |
  202. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |void| | :ref:`font_set_force_autohinter<class_TextServer_method_font_set_force_autohinter>`\ (\ font_rid\: :ref:`RID<class_RID>`, force_autohinter\: :ref:`bool<class_bool>`\ ) |
  204. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |void| | :ref:`font_set_generate_mipmaps<class_TextServer_method_font_set_generate_mipmaps>`\ (\ font_rid\: :ref:`RID<class_RID>`, generate_mipmaps\: :ref:`bool<class_bool>`\ ) |
  206. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |void| | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>`\ (\ oversampling\: :ref:`float<class_float>`\ ) |
  208. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`font_set_glyph_advance<class_TextServer_method_font_set_glyph_advance>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`, advance\: :ref:`Vector2<class_Vector2>`\ ) |
  210. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`font_set_glyph_offset<class_TextServer_method_font_set_glyph_offset>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, offset\: :ref:`Vector2<class_Vector2>`\ ) |
  212. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |void| | :ref:`font_set_glyph_size<class_TextServer_method_font_set_glyph_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, gl_size\: :ref:`Vector2<class_Vector2>`\ ) |
  214. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |void| | :ref:`font_set_glyph_texture_idx<class_TextServer_method_font_set_glyph_texture_idx>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, texture_idx\: :ref:`int<class_int>`\ ) |
  216. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |void| | :ref:`font_set_glyph_uv_rect<class_TextServer_method_font_set_glyph_uv_rect>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, uv_rect\: :ref:`Rect2<class_Rect2>`\ ) |
  218. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |void| | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>`\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) |
  220. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |void| | :ref:`font_set_kerning<class_TextServer_method_font_set_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`, kerning\: :ref:`Vector2<class_Vector2>`\ ) |
  222. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |void| | :ref:`font_set_language_support_override<class_TextServer_method_font_set_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) |
  224. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`font_set_msdf_pixel_range<class_TextServer_method_font_set_msdf_pixel_range>`\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_pixel_range\: :ref:`int<class_int>`\ ) |
  226. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |void| | :ref:`font_set_msdf_size<class_TextServer_method_font_set_msdf_size>`\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_size\: :ref:`int<class_int>`\ ) |
  228. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |void| | :ref:`font_set_multichannel_signed_distance_field<class_TextServer_method_font_set_multichannel_signed_distance_field>`\ (\ font_rid\: :ref:`RID<class_RID>`, msdf\: :ref:`bool<class_bool>`\ ) |
  230. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |void| | :ref:`font_set_name<class_TextServer_method_font_set_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  232. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`font_set_opentype_feature_overrides<class_TextServer_method_font_set_opentype_feature_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`, overrides\: :ref:`Dictionary<class_Dictionary>`\ ) |
  234. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |void| | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) |
  236. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | |void| | :ref:`font_set_scale<class_TextServer_method_font_set_scale>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, scale\: :ref:`float<class_float>`\ ) |
  238. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |void| | :ref:`font_set_script_support_override<class_TextServer_method_font_set_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) |
  240. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`font_set_spacing<class_TextServer_method_font_set_spacing>`\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) |
  242. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |void| | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  244. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`font_set_style<class_TextServer_method_font_set_style>`\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) |
  246. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  248. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`font_set_subpixel_positioning<class_TextServer_method_font_set_subpixel_positioning>`\ (\ font_rid\: :ref:`RID<class_RID>`, subpixel_positioning\: :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>`\ ) |
  250. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`font_set_texture_image<class_TextServer_method_font_set_texture_image>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, image\: :ref:`Image<class_Image>`\ ) |
  252. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`font_set_texture_offsets<class_TextServer_method_font_set_texture_offsets>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, offset\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) |
  254. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |void| | :ref:`font_set_transform<class_TextServer_method_font_set_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  256. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |void| | :ref:`font_set_underline_position<class_TextServer_method_font_set_underline_position>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_position\: :ref:`float<class_float>`\ ) |
  258. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |void| | :ref:`font_set_underline_thickness<class_TextServer_method_font_set_underline_thickness>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_thickness\: :ref:`float<class_float>`\ ) |
  260. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`\ (\ font_rid\: :ref:`RID<class_RID>`, variation_coordinates\: :ref:`Dictionary<class_Dictionary>`\ ) |
  262. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |void| | :ref:`font_set_weight<class_TextServer_method_font_set_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  264. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  266. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  268. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  270. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | |void| | :ref:`free_rid<class_TextServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  272. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>`\ (\ ) |const| |
  274. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`Vector2<class_Vector2>` | :ref:`get_hex_code_box_size<class_TextServer_method_get_hex_code_box_size>`\ (\ size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| |
  276. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>`\ (\ ) |const| |
  278. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>`\ (\ ) |const| |
  280. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>`\ (\ ) |const| |
  282. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  284. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| |
  286. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>`\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| |
  288. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>`\ (\ locale\: :ref:`String<class_String>`\ ) |const| |
  290. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  292. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`bool<class_bool>` | :ref:`is_valid_letter<class_TextServer_method_is_valid_letter>`\ (\ unicode\: :ref:`int<class_int>`\ ) |const| |
  294. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |
  296. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>`\ (\ name\: :ref:`String<class_String>`\ ) |const| |
  298. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  300. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] | :ref:`parse_structured_text<class_TextServer_method_parse_structured_text>`\ (\ parser_type\: :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>`, args\: :ref:`Array<class_Array>`, text\: :ref:`String<class_String>`\ ) |const| |
  302. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>`\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| |
  304. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |const| |
  306. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  308. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_span_meta<class_TextServer_method_shaped_get_span_meta>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  310. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | |void| | :ref:`shaped_set_span_update_font<class_TextServer_method_shaped_set_span_update_font>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}\ ) |
  312. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_object<class_TextServer_method_shaped_text_add_object>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, length\: :ref:`int<class_int>` = 1, baseline\: :ref:`float<class_float>` = 0.0\ ) |
  314. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_string<class_TextServer_method_shaped_text_add_string>`\ (\ shaped\: :ref:`RID<class_RID>`, text\: :ref:`String<class_String>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}, language\: :ref:`String<class_String>` = "", meta\: :ref:`Variant<class_Variant>` = null\ ) |
  316. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | |void| | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  318. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | :ref:`int<class_int>` | :ref:`shaped_text_closest_character_pos<class_TextServer_method_shaped_text_closest_character_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  320. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |void| | :ref:`shaped_text_draw<class_TextServer_method_shaped_text_draw>`\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| |
  322. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |void| | :ref:`shaped_text_draw_outline<class_TextServer_method_shaped_text_draw_outline>`\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, outline_size\: :ref:`int<class_int>` = 1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| |
  324. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | :ref:`float<class_float>` | :ref:`shaped_text_fit_to_width<class_TextServer_method_shaped_text_fit_to_width>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3\ ) |
  326. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  328. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | :ref:`Dictionary<class_Dictionary>` | :ref:`shaped_text_get_carets<class_TextServer_method_shaped_text_get_carets>`\ (\ shaped\: :ref:`RID<class_RID>`, position\: :ref:`int<class_int>`\ ) |const| |
  330. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  332. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | :ref:`int<class_int>` | :ref:`shaped_text_get_custom_ellipsis<class_TextServer_method_shaped_text_get_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  334. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  336. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  338. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  340. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_dominant_direction_in_range<class_TextServer_method_shaped_text_get_dominant_direction_in_range>`\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| |
  342. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_glyph_count<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  344. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  346. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  348. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  350. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  352. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_grapheme_bounds<class_TextServer_method_shaped_text_get_grapheme_bounds>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  354. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_inferred_direction<class_TextServer_method_shaped_text_get_inferred_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  356. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks<class_TextServer_method_shaped_text_get_line_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, start\: :ref:`int<class_int>` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| |
  358. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks_adv<class_TextServer_method_shaped_text_get_line_breaks_adv>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, start\: :ref:`int<class_int>` = 0, once\: :ref:`bool<class_bool>` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| |
  360. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :ref:`int<class_int>` | :ref:`shaped_text_get_object_glyph<class_TextServer_method_shaped_text_get_object_glyph>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  362. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_object_range<class_TextServer_method_shaped_text_get_object_range>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  364. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :ref:`Rect2<class_Rect2>` | :ref:`shaped_text_get_object_rect<class_TextServer_method_shaped_text_get_object_rect>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| |
  366. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  368. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  370. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  372. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  374. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  376. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  378. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`shaped_text_get_selection<class_TextServer_method_shaped_text_get_selection>`\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| |
  380. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  382. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`int<class_int>` | :ref:`shaped_text_get_spacing<class_TextServer_method_shaped_text_get_spacing>`\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| |
  384. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  386. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  388. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  390. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  392. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_word_breaks<class_TextServer_method_shaped_text_get_word_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 4\ ) |const| |
  394. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  396. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_grapheme<class_TextServer_method_shaped_text_hit_test_grapheme>`\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| |
  398. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_position<class_TextServer_method_shaped_text_hit_test_position>`\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| |
  400. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  402. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`int<class_int>` | :ref:`shaped_text_next_character_pos<class_TextServer_method_shaped_text_next_character_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  404. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :ref:`int<class_int>` | :ref:`shaped_text_next_grapheme_pos<class_TextServer_method_shaped_text_next_grapheme_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  406. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | |void| | :ref:`shaped_text_overrun_trim_to_width<class_TextServer_method_shaped_text_overrun_trim_to_width>`\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\] = 0\ ) |
  408. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | :ref:`int<class_int>` | :ref:`shaped_text_prev_character_pos<class_TextServer_method_shaped_text_prev_character_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  410. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :ref:`int<class_int>` | :ref:`shaped_text_prev_grapheme_pos<class_TextServer_method_shaped_text_prev_grapheme_pos>`\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| |
  412. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :ref:`bool<class_bool>` | :ref:`shaped_text_resize_object<class_TextServer_method_shaped_text_resize_object>`\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, baseline\: :ref:`float<class_float>` = 0.0\ ) |
  414. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | |void| | :ref:`shaped_text_set_bidi_override<class_TextServer_method_shaped_text_set_bidi_override>`\ (\ shaped\: :ref:`RID<class_RID>`, override\: :ref:`Array<class_Array>`\ ) |
  416. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | |void| | :ref:`shaped_text_set_custom_ellipsis<class_TextServer_method_shaped_text_set_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) |
  418. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | |void| | :ref:`shaped_text_set_custom_punctuation<class_TextServer_method_shaped_text_set_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`, punct\: :ref:`String<class_String>`\ ) |
  420. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | |void| | :ref:`shaped_text_set_direction<class_TextServer_method_shaped_text_set_direction>`\ (\ shaped\: :ref:`RID<class_RID>`, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0\ ) |
  422. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | |void| | :ref:`shaped_text_set_orientation<class_TextServer_method_shaped_text_set_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) |
  424. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | |void| | :ref:`shaped_text_set_preserve_control<class_TextServer_method_shaped_text_set_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  426. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | |void| | :ref:`shaped_text_set_preserve_invalid<class_TextServer_method_shaped_text_set_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) |
  428. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | |void| | :ref:`shaped_text_set_spacing<class_TextServer_method_shaped_text_set_spacing>`\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) |
  430. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  432. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  434. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | :ref:`RID<class_RID>` | :ref:`shaped_text_substr<class_TextServer_method_shaped_text_substr>`\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, length\: :ref:`int<class_int>`\ ) |const| |
  436. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | :ref:`float<class_float>` | :ref:`shaped_text_tab_align<class_TextServer_method_shaped_text_tab_align>`\ (\ shaped\: :ref:`RID<class_RID>`, tab_stops\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) |
  438. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  440. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_character_breaks<class_TextServer_method_string_get_character_breaks>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  442. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_word_breaks<class_TextServer_method_string_get_word_breaks>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = "", chars_per_line\: :ref:`int<class_int>` = 0\ ) |const| |
  444. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :ref:`String<class_String>` | :ref:`string_to_lower<class_TextServer_method_string_to_lower>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  446. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :ref:`String<class_String>` | :ref:`string_to_title<class_TextServer_method_string_to_title>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  448. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :ref:`String<class_String>` | :ref:`string_to_upper<class_TextServer_method_string_to_upper>`\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  450. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  452. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>`\ (\ tag\: :ref:`int<class_int>`\ ) |const| |
  454. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. .. rst-class:: classref-section-separator
  456. ----
  457. .. rst-class:: classref-descriptions-group
  458. Enumerations
  459. ------------
  460. .. _enum_TextServer_FontAntialiasing:
  461. .. rst-class:: classref-enumeration
  462. enum **FontAntialiasing**: :ref:`๐Ÿ”—<enum_TextServer_FontAntialiasing>`
  463. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  466. Font glyphs are rasterized as 1-bit bitmaps.
  467. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  468. .. rst-class:: classref-enumeration-constant
  469. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  470. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  471. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  472. .. rst-class:: classref-enumeration-constant
  473. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  474. Font glyphs are rasterized for LCD screens.
  475. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  476. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  477. .. rst-class:: classref-item-separator
  478. ----
  479. .. _enum_TextServer_FontLCDSubpixelLayout:
  480. .. rst-class:: classref-enumeration
  481. enum **FontLCDSubpixelLayout**: :ref:`๐Ÿ”—<enum_TextServer_FontLCDSubpixelLayout>`
  482. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  483. .. rst-class:: classref-enumeration-constant
  484. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  485. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  486. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  487. .. rst-class:: classref-enumeration-constant
  488. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  489. Horizontal RGB subpixel layout.
  490. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  493. Horizontal BGR subpixel layout.
  494. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  495. .. rst-class:: classref-enumeration-constant
  496. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  497. Vertical RGB subpixel layout.
  498. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  501. Vertical BGR subpixel layout.
  502. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  505. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  506. .. rst-class:: classref-item-separator
  507. ----
  508. .. _enum_TextServer_Direction:
  509. .. rst-class:: classref-enumeration
  510. enum **Direction**: :ref:`๐Ÿ”—<enum_TextServer_Direction>`
  511. .. _class_TextServer_constant_DIRECTION_AUTO:
  512. .. rst-class:: classref-enumeration-constant
  513. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  514. Text direction is determined based on contents and current locale.
  515. .. _class_TextServer_constant_DIRECTION_LTR:
  516. .. rst-class:: classref-enumeration-constant
  517. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  518. Text is written from left to right.
  519. .. _class_TextServer_constant_DIRECTION_RTL:
  520. .. rst-class:: classref-enumeration-constant
  521. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  522. Text is written from right to left.
  523. .. _class_TextServer_constant_DIRECTION_INHERITED:
  524. .. rst-class:: classref-enumeration-constant
  525. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  526. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  527. .. rst-class:: classref-item-separator
  528. ----
  529. .. _enum_TextServer_Orientation:
  530. .. rst-class:: classref-enumeration
  531. enum **Orientation**: :ref:`๐Ÿ”—<enum_TextServer_Orientation>`
  532. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  533. .. rst-class:: classref-enumeration-constant
  534. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  535. Text is written horizontally.
  536. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  537. .. rst-class:: classref-enumeration-constant
  538. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  539. Left to right text is written vertically from top to bottom.
  540. Right to left text is written vertically from bottom to top.
  541. .. rst-class:: classref-item-separator
  542. ----
  543. .. _enum_TextServer_JustificationFlag:
  544. .. rst-class:: classref-enumeration
  545. flags **JustificationFlag**: :ref:`๐Ÿ”—<enum_TextServer_JustificationFlag>`
  546. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  549. Do not justify text.
  550. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  553. Justify text by adding and removing kashidas.
  554. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  557. Justify text by changing width of the spaces between the words.
  558. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  561. Remove trailing and leading spaces from the justified text.
  562. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  565. Only apply justification to the part of the text after the last tab.
  566. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  569. Apply justification to the trimmed line with ellipsis.
  570. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  571. .. rst-class:: classref-enumeration-constant
  572. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  573. Do not apply justification to the last line of the paragraph.
  574. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  575. .. rst-class:: classref-enumeration-constant
  576. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  577. Do not apply justification to the last line of the paragraph with visible characters (takes precedence over :ref:`JUSTIFICATION_SKIP_LAST_LINE<class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE>`).
  578. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  579. .. rst-class:: classref-enumeration-constant
  580. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  581. Always apply justification to the paragraphs with a single line (:ref:`JUSTIFICATION_SKIP_LAST_LINE<class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE>` and :ref:`JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS<class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS>` are ignored).
  582. .. rst-class:: classref-item-separator
  583. ----
  584. .. _enum_TextServer_AutowrapMode:
  585. .. rst-class:: classref-enumeration
  586. enum **AutowrapMode**: :ref:`๐Ÿ”—<enum_TextServer_AutowrapMode>`
  587. .. _class_TextServer_constant_AUTOWRAP_OFF:
  588. .. rst-class:: classref-enumeration-constant
  589. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  590. Autowrap is disabled.
  591. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  592. .. rst-class:: classref-enumeration-constant
  593. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  594. Wraps the text inside the node's bounding rectangle by allowing to break lines at arbitrary positions, which is useful when very limited space is available.
  595. .. _class_TextServer_constant_AUTOWRAP_WORD:
  596. .. rst-class:: classref-enumeration-constant
  597. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  598. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  599. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  600. .. rst-class:: classref-enumeration-constant
  601. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  602. Behaves similarly to :ref:`AUTOWRAP_WORD<class_TextServer_constant_AUTOWRAP_WORD>`, but force-breaks a word if that single word does not fit in one line.
  603. .. rst-class:: classref-item-separator
  604. ----
  605. .. _enum_TextServer_LineBreakFlag:
  606. .. rst-class:: classref-enumeration
  607. flags **LineBreakFlag**: :ref:`๐Ÿ”—<enum_TextServer_LineBreakFlag>`
  608. .. _class_TextServer_constant_BREAK_NONE:
  609. .. rst-class:: classref-enumeration-constant
  610. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  611. Do not break the line.
  612. .. _class_TextServer_constant_BREAK_MANDATORY:
  613. .. rst-class:: classref-enumeration-constant
  614. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  615. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  616. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  617. .. rst-class:: classref-enumeration-constant
  618. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  619. Break the line between the words.
  620. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  621. .. rst-class:: classref-enumeration-constant
  622. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  623. Break the line between any unconnected graphemes.
  624. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  625. .. rst-class:: classref-enumeration-constant
  626. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  627. Should be used only in conjunction with :ref:`BREAK_WORD_BOUND<class_TextServer_constant_BREAK_WORD_BOUND>`, break the line between any unconnected graphemes, if it's impossible to break it between the words.
  628. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  629. .. rst-class:: classref-enumeration-constant
  630. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  631. Remove edge spaces from the broken line segments.
  632. .. _class_TextServer_constant_BREAK_TRIM_INDENT:
  633. .. rst-class:: classref-enumeration-constant
  634. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_INDENT** = ``32``
  635. Subtract first line indentation width from all lines after the first one.
  636. .. rst-class:: classref-item-separator
  637. ----
  638. .. _enum_TextServer_VisibleCharactersBehavior:
  639. .. rst-class:: classref-enumeration
  640. enum **VisibleCharactersBehavior**: :ref:`๐Ÿ”—<enum_TextServer_VisibleCharactersBehavior>`
  641. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  642. .. rst-class:: classref-enumeration-constant
  643. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  644. Trims text before the shaping. e.g, increasing :ref:`Label.visible_characters<class_Label_property_visible_characters>` or :ref:`RichTextLabel.visible_characters<class_RichTextLabel_property_visible_characters>` value is visually identical to typing the text.
  645. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  646. .. rst-class:: classref-enumeration-constant
  647. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  648. Displays glyphs that are mapped to the first :ref:`Label.visible_characters<class_Label_property_visible_characters>` or :ref:`RichTextLabel.visible_characters<class_RichTextLabel_property_visible_characters>` characters from the beginning of the text.
  649. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  650. .. rst-class:: classref-enumeration-constant
  651. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  652. Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the left or from the right, depending on :ref:`Control.layout_direction<class_Control_property_layout_direction>` value.
  653. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  654. .. rst-class:: classref-enumeration-constant
  655. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  656. Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the left.
  657. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  658. .. rst-class:: classref-enumeration-constant
  659. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  660. Displays :ref:`Label.visible_ratio<class_Label_property_visible_ratio>` or :ref:`RichTextLabel.visible_ratio<class_RichTextLabel_property_visible_ratio>` glyphs, starting from the right.
  661. .. rst-class:: classref-item-separator
  662. ----
  663. .. _enum_TextServer_OverrunBehavior:
  664. .. rst-class:: classref-enumeration
  665. enum **OverrunBehavior**: :ref:`๐Ÿ”—<enum_TextServer_OverrunBehavior>`
  666. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  667. .. rst-class:: classref-enumeration-constant
  668. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  669. No text trimming is performed.
  670. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  671. .. rst-class:: classref-enumeration-constant
  672. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  673. Trims the text per character.
  674. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  675. .. rst-class:: classref-enumeration-constant
  676. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  677. Trims the text per word.
  678. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  679. .. rst-class:: classref-enumeration-constant
  680. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  681. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  682. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  683. .. rst-class:: classref-enumeration-constant
  684. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  685. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  686. .. rst-class:: classref-item-separator
  687. ----
  688. .. _enum_TextServer_TextOverrunFlag:
  689. .. rst-class:: classref-enumeration
  690. flags **TextOverrunFlag**: :ref:`๐Ÿ”—<enum_TextServer_TextOverrunFlag>`
  691. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  692. .. rst-class:: classref-enumeration-constant
  693. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  694. No trimming is performed.
  695. .. _class_TextServer_constant_OVERRUN_TRIM:
  696. .. rst-class:: classref-enumeration-constant
  697. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  698. Trims the text when it exceeds the given width.
  699. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  700. .. rst-class:: classref-enumeration-constant
  701. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  702. Trims the text per word instead of per grapheme.
  703. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  704. .. rst-class:: classref-enumeration-constant
  705. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  706. Determines whether an ellipsis should be added at the end of the text.
  707. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  708. .. rst-class:: classref-enumeration-constant
  709. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  710. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  711. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  712. .. rst-class:: classref-enumeration-constant
  713. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  714. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  715. .. rst-class:: classref-item-separator
  716. ----
  717. .. _enum_TextServer_GraphemeFlag:
  718. .. rst-class:: classref-enumeration
  719. flags **GraphemeFlag**: :ref:`๐Ÿ”—<enum_TextServer_GraphemeFlag>`
  720. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  723. Grapheme is supported by the font, and can be drawn.
  724. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  725. .. rst-class:: classref-enumeration-constant
  726. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  727. Grapheme is part of right-to-left or bottom-to-top run.
  728. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  729. .. rst-class:: classref-enumeration-constant
  730. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  731. Grapheme is not part of source text, it was added by justification process.
  732. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  733. .. rst-class:: classref-enumeration-constant
  734. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  735. Grapheme is whitespace.
  736. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  737. .. rst-class:: classref-enumeration-constant
  738. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  739. Grapheme is mandatory break point (e.g. ``"\n"``).
  740. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  741. .. rst-class:: classref-enumeration-constant
  742. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  743. Grapheme is optional break point (e.g. space).
  744. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  745. .. rst-class:: classref-enumeration-constant
  746. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  747. Grapheme is the tabulation character.
  748. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  751. Grapheme is kashida.
  752. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  753. .. rst-class:: classref-enumeration-constant
  754. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  755. Grapheme is punctuation character.
  756. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  757. .. rst-class:: classref-enumeration-constant
  758. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  759. Grapheme is underscore character.
  760. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  761. .. rst-class:: classref-enumeration-constant
  762. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  763. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  764. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  765. .. rst-class:: classref-enumeration-constant
  766. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  767. It is safe to insert a U+0640 before this grapheme for elongation.
  768. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  769. .. rst-class:: classref-enumeration-constant
  770. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  771. Grapheme is an object replacement character for the embedded object.
  772. .. _class_TextServer_constant_GRAPHEME_IS_SOFT_HYPHEN:
  773. .. rst-class:: classref-enumeration-constant
  774. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SOFT_HYPHEN** = ``8192``
  775. Grapheme is a soft hyphen.
  776. .. rst-class:: classref-item-separator
  777. ----
  778. .. _enum_TextServer_Hinting:
  779. .. rst-class:: classref-enumeration
  780. enum **Hinting**: :ref:`๐Ÿ”—<enum_TextServer_Hinting>`
  781. .. _class_TextServer_constant_HINTING_NONE:
  782. .. rst-class:: classref-enumeration-constant
  783. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  784. Disables font hinting (smoother but less crisp).
  785. .. _class_TextServer_constant_HINTING_LIGHT:
  786. .. rst-class:: classref-enumeration-constant
  787. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  788. Use the light font hinting mode.
  789. .. _class_TextServer_constant_HINTING_NORMAL:
  790. .. rst-class:: classref-enumeration-constant
  791. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  792. Use the default font hinting mode (crisper but less smooth).
  793. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  794. .. rst-class:: classref-item-separator
  795. ----
  796. .. _enum_TextServer_SubpixelPositioning:
  797. .. rst-class:: classref-enumeration
  798. enum **SubpixelPositioning**: :ref:`๐Ÿ”—<enum_TextServer_SubpixelPositioning>`
  799. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  800. .. rst-class:: classref-enumeration-constant
  801. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  802. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  803. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  804. .. rst-class:: classref-enumeration-constant
  805. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  806. Glyph horizontal position is rounded based on font size.
  807. - To one quarter of the pixel size if font size is smaller or equal to :ref:`SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE<class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE>`.
  808. - To one half of the pixel size if font size is smaller or equal to :ref:`SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE<class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE>`.
  809. - To the whole pixel size for larger fonts.
  810. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  811. .. rst-class:: classref-enumeration-constant
  812. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  813. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  814. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  815. .. rst-class:: classref-enumeration-constant
  816. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  817. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  818. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  819. .. rst-class:: classref-enumeration-constant
  820. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  821. Maximum font size which will use one half of the pixel subpixel positioning in :ref:`SUBPIXEL_POSITIONING_AUTO<class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO>` mode.
  822. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  823. .. rst-class:: classref-enumeration-constant
  824. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  825. Maximum font size which will use one quarter of the pixel subpixel positioning in :ref:`SUBPIXEL_POSITIONING_AUTO<class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO>` mode.
  826. .. rst-class:: classref-item-separator
  827. ----
  828. .. _enum_TextServer_Feature:
  829. .. rst-class:: classref-enumeration
  830. enum **Feature**: :ref:`๐Ÿ”—<enum_TextServer_Feature>`
  831. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  832. .. rst-class:: classref-enumeration-constant
  833. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  834. TextServer supports simple text layouts.
  835. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  836. .. rst-class:: classref-enumeration-constant
  837. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  838. TextServer supports bidirectional text layouts.
  839. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  840. .. rst-class:: classref-enumeration-constant
  841. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  842. TextServer supports vertical layouts.
  843. .. _class_TextServer_constant_FEATURE_SHAPING:
  844. .. rst-class:: classref-enumeration-constant
  845. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  846. TextServer supports complex text shaping.
  847. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  848. .. rst-class:: classref-enumeration-constant
  849. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  850. TextServer supports justification using kashidas.
  851. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  852. .. rst-class:: classref-enumeration-constant
  853. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  854. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  855. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  856. .. rst-class:: classref-enumeration-constant
  857. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  858. TextServer supports loading bitmap fonts.
  859. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  860. .. rst-class:: classref-enumeration-constant
  861. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  862. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  863. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  864. .. rst-class:: classref-enumeration-constant
  865. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  866. TextServer supports multichannel signed distance field dynamic font rendering.
  867. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  868. .. rst-class:: classref-enumeration-constant
  869. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  870. TextServer supports loading system fonts.
  871. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  872. .. rst-class:: classref-enumeration-constant
  873. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  874. TextServer supports variable fonts.
  875. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  876. .. rst-class:: classref-enumeration-constant
  877. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  878. TextServer supports locale dependent and context sensitive case conversion.
  879. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  880. .. rst-class:: classref-enumeration-constant
  881. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  882. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  883. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  884. .. rst-class:: classref-enumeration-constant
  885. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  886. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  887. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  888. .. rst-class:: classref-enumeration-constant
  889. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  890. TextServer supports `Unicode Technical Report #36 <https://unicode.org/reports/tr36/>`__ and `Unicode Technical Standard #39 <https://unicode.org/reports/tr39/>`__ based spoof detection features.
  891. .. rst-class:: classref-item-separator
  892. ----
  893. .. _enum_TextServer_ContourPointTag:
  894. .. rst-class:: classref-enumeration
  895. enum **ContourPointTag**: :ref:`๐Ÿ”—<enum_TextServer_ContourPointTag>`
  896. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  897. .. rst-class:: classref-enumeration-constant
  898. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  899. Contour point is on the curve.
  900. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  901. .. rst-class:: classref-enumeration-constant
  902. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  903. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bรฉzier arc.
  904. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  905. .. rst-class:: classref-enumeration-constant
  906. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  907. Contour point isn't on the curve, but serves as a control point for a cubic Bรฉzier arc.
  908. .. rst-class:: classref-item-separator
  909. ----
  910. .. _enum_TextServer_SpacingType:
  911. .. rst-class:: classref-enumeration
  912. enum **SpacingType**: :ref:`๐Ÿ”—<enum_TextServer_SpacingType>`
  913. .. _class_TextServer_constant_SPACING_GLYPH:
  914. .. rst-class:: classref-enumeration-constant
  915. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  916. Spacing for each glyph.
  917. .. _class_TextServer_constant_SPACING_SPACE:
  918. .. rst-class:: classref-enumeration-constant
  919. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  920. Spacing for the space character.
  921. .. _class_TextServer_constant_SPACING_TOP:
  922. .. rst-class:: classref-enumeration-constant
  923. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  924. Spacing at the top of the line.
  925. .. _class_TextServer_constant_SPACING_BOTTOM:
  926. .. rst-class:: classref-enumeration-constant
  927. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  928. Spacing at the bottom of the line.
  929. .. _class_TextServer_constant_SPACING_MAX:
  930. .. rst-class:: classref-enumeration-constant
  931. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  932. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  933. .. rst-class:: classref-item-separator
  934. ----
  935. .. _enum_TextServer_FontStyle:
  936. .. rst-class:: classref-enumeration
  937. flags **FontStyle**: :ref:`๐Ÿ”—<enum_TextServer_FontStyle>`
  938. .. _class_TextServer_constant_FONT_BOLD:
  939. .. rst-class:: classref-enumeration-constant
  940. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  941. Font is bold.
  942. .. _class_TextServer_constant_FONT_ITALIC:
  943. .. rst-class:: classref-enumeration-constant
  944. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  945. Font is italic or oblique.
  946. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  947. .. rst-class:: classref-enumeration-constant
  948. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  949. Font have fixed-width characters.
  950. .. rst-class:: classref-item-separator
  951. ----
  952. .. _enum_TextServer_StructuredTextParser:
  953. .. rst-class:: classref-enumeration
  954. enum **StructuredTextParser**: :ref:`๐Ÿ”—<enum_TextServer_StructuredTextParser>`
  955. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  956. .. rst-class:: classref-enumeration-constant
  957. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  958. Use default Unicode BiDi algorithm.
  959. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  960. .. rst-class:: classref-enumeration-constant
  961. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  962. BiDi override for URI.
  963. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  964. .. rst-class:: classref-enumeration-constant
  965. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  966. BiDi override for file path.
  967. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  968. .. rst-class:: classref-enumeration-constant
  969. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  970. BiDi override for email.
  971. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  972. .. rst-class:: classref-enumeration-constant
  973. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  974. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  975. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  976. .. rst-class:: classref-enumeration-constant
  977. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  978. BiDi override for GDScript.
  979. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  980. .. rst-class:: classref-enumeration-constant
  981. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  982. User defined structured text BiDi override function.
  983. .. rst-class:: classref-item-separator
  984. ----
  985. .. _enum_TextServer_FixedSizeScaleMode:
  986. .. rst-class:: classref-enumeration
  987. enum **FixedSizeScaleMode**: :ref:`๐Ÿ”—<enum_TextServer_FixedSizeScaleMode>`
  988. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  989. .. rst-class:: classref-enumeration-constant
  990. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  991. Bitmap font is not scaled.
  992. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  993. .. rst-class:: classref-enumeration-constant
  994. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  995. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  996. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  997. .. rst-class:: classref-enumeration-constant
  998. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  999. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  1000. .. rst-class:: classref-section-separator
  1001. ----
  1002. .. rst-class:: classref-descriptions-group
  1003. Method Descriptions
  1004. -------------------
  1005. .. _class_TextServer_method_create_font:
  1006. .. rst-class:: classref-method
  1007. :ref:`RID<class_RID>` **create_font**\ (\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font>`
  1008. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  1009. .. rst-class:: classref-item-separator
  1010. ----
  1011. .. _class_TextServer_method_create_font_linked_variation:
  1012. .. rst-class:: classref-method
  1013. :ref:`RID<class_RID>` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font_linked_variation>`
  1014. Creates a new variation existing font which is reusing the same glyph cache and font data. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  1015. .. rst-class:: classref-item-separator
  1016. ----
  1017. .. _class_TextServer_method_create_shaped_text:
  1018. .. rst-class:: classref-method
  1019. :ref:`RID<class_RID>` **create_shaped_text**\ (\ direction\: :ref:`Direction<enum_TextServer_Direction>` = 0, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_shaped_text>`
  1020. Creates a new buffer for complex text layout, with the given ``direction`` and ``orientation``. To free the resulting buffer, use :ref:`free_rid<class_TextServer_method_free_rid>` method.
  1021. \ **Note:** Direction is ignored if server does not support :ref:`FEATURE_BIDI_LAYOUT<class_TextServer_constant_FEATURE_BIDI_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  1022. \ **Note:** Orientation is ignored if server does not support :ref:`FEATURE_VERTICAL_LAYOUT<class_TextServer_constant_FEATURE_VERTICAL_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  1023. .. rst-class:: classref-item-separator
  1024. ----
  1025. .. _class_TextServer_method_draw_hex_code_box:
  1026. .. rst-class:: classref-method
  1027. |void| **draw_hex_code_box**\ (\ canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_draw_hex_code_box>`
  1028. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  1029. .. rst-class:: classref-item-separator
  1030. ----
  1031. .. _class_TextServer_method_font_clear_glyphs:
  1032. .. rst-class:: classref-method
  1033. |void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_glyphs>`
  1034. Removes all rendered glyph information from the cache entry.
  1035. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>` to remove them manually.
  1036. .. rst-class:: classref-item-separator
  1037. ----
  1038. .. _class_TextServer_method_font_clear_kerning_map:
  1039. .. rst-class:: classref-method
  1040. |void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_kerning_map>`
  1041. Removes all kerning overrides.
  1042. .. rst-class:: classref-item-separator
  1043. ----
  1044. .. _class_TextServer_method_font_clear_size_cache:
  1045. .. rst-class:: classref-method
  1046. |void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_size_cache>`
  1047. Removes all font sizes from the cache entry.
  1048. .. rst-class:: classref-item-separator
  1049. ----
  1050. .. _class_TextServer_method_font_clear_textures:
  1051. .. rst-class:: classref-method
  1052. |void| **font_clear_textures**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_textures>`
  1053. Removes all textures from font cache entry.
  1054. \ **Note:** This function will not remove glyphs associated with the texture, use :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>` to remove them manually.
  1055. .. rst-class:: classref-item-separator
  1056. ----
  1057. .. _class_TextServer_method_font_draw_glyph:
  1058. .. rst-class:: classref-method
  1059. |void| **font_draw_glyph**\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_draw_glyph>`
  1060. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1061. \ **Note:** Glyph index is specific to the font, use glyphs indices returned by :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` or :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`.
  1062. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1063. .. rst-class:: classref-item-separator
  1064. ----
  1065. .. _class_TextServer_method_font_draw_glyph_outline:
  1066. .. rst-class:: classref-method
  1067. |void| **font_draw_glyph_outline**\ (\ font_rid\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, outline_size\: :ref:`int<class_int>`, pos\: :ref:`Vector2<class_Vector2>`, index\: :ref:`int<class_int>`, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_draw_glyph_outline>`
  1068. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1069. \ **Note:** Glyph index is specific to the font, use glyphs indices returned by :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` or :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`.
  1070. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1071. .. rst-class:: classref-item-separator
  1072. ----
  1073. .. _class_TextServer_method_font_get_antialiasing:
  1074. .. rst-class:: classref-method
  1075. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_antialiasing>`
  1076. Returns font anti-aliasing mode.
  1077. .. rst-class:: classref-item-separator
  1078. ----
  1079. .. _class_TextServer_method_font_get_ascent:
  1080. .. rst-class:: classref-method
  1081. :ref:`float<class_float>` **font_get_ascent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_ascent>`
  1082. Returns the font ascent (number of pixels above the baseline).
  1083. .. rst-class:: classref-item-separator
  1084. ----
  1085. .. _class_TextServer_method_font_get_baseline_offset:
  1086. .. rst-class:: classref-method
  1087. :ref:`float<class_float>` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_baseline_offset>`
  1088. Returns extra baseline offset (as a fraction of font height).
  1089. .. rst-class:: classref-item-separator
  1090. ----
  1091. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1092. .. rst-class:: classref-method
  1093. :ref:`int<class_int>` **font_get_char_from_glyph_index**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_char_from_glyph_index>`
  1094. Returns character code associated with ``glyph_index``, or ``0`` if ``glyph_index`` is invalid. See :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>`.
  1095. .. rst-class:: classref-item-separator
  1096. ----
  1097. .. _class_TextServer_method_font_get_descent:
  1098. .. rst-class:: classref-method
  1099. :ref:`float<class_float>` **font_get_descent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_descent>`
  1100. Returns the font descent (number of pixels below the baseline).
  1101. .. rst-class:: classref-item-separator
  1102. ----
  1103. .. _class_TextServer_method_font_get_disable_embedded_bitmaps:
  1104. .. rst-class:: classref-method
  1105. :ref:`bool<class_bool>` **font_get_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_disable_embedded_bitmaps>`
  1106. Returns whether the font's embedded bitmap loading is disabled.
  1107. .. rst-class:: classref-item-separator
  1108. ----
  1109. .. _class_TextServer_method_font_get_embolden:
  1110. .. rst-class:: classref-method
  1111. :ref:`float<class_float>` **font_get_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_embolden>`
  1112. Returns font embolden strength.
  1113. .. rst-class:: classref-item-separator
  1114. ----
  1115. .. _class_TextServer_method_font_get_face_count:
  1116. .. rst-class:: classref-method
  1117. :ref:`int<class_int>` **font_get_face_count**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_count>`
  1118. Returns number of faces in the TrueType / OpenType collection.
  1119. .. rst-class:: classref-item-separator
  1120. ----
  1121. .. _class_TextServer_method_font_get_face_index:
  1122. .. rst-class:: classref-method
  1123. :ref:`int<class_int>` **font_get_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_index>`
  1124. Returns an active face index in the TrueType / OpenType collection.
  1125. .. rst-class:: classref-item-separator
  1126. ----
  1127. .. _class_TextServer_method_font_get_fixed_size:
  1128. .. rst-class:: classref-method
  1129. :ref:`int<class_int>` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size>`
  1130. Returns bitmap font fixed size.
  1131. .. rst-class:: classref-item-separator
  1132. ----
  1133. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1134. .. rst-class:: classref-method
  1135. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **font_get_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size_scale_mode>`
  1136. Returns bitmap font scaling mode.
  1137. .. rst-class:: classref-item-separator
  1138. ----
  1139. .. _class_TextServer_method_font_get_generate_mipmaps:
  1140. .. rst-class:: classref-method
  1141. :ref:`bool<class_bool>` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_generate_mipmaps>`
  1142. Returns ``true`` if font texture mipmap generation is enabled.
  1143. .. rst-class:: classref-item-separator
  1144. ----
  1145. .. _class_TextServer_method_font_get_global_oversampling:
  1146. .. rst-class:: classref-method
  1147. :ref:`float<class_float>` **font_get_global_oversampling**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_global_oversampling>`
  1148. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1149. .. rst-class:: classref-item-separator
  1150. ----
  1151. .. _class_TextServer_method_font_get_glyph_advance:
  1152. .. rst-class:: classref-method
  1153. :ref:`Vector2<class_Vector2>` **font_get_glyph_advance**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_advance>`
  1154. Returns glyph advance (offset of the next glyph).
  1155. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1156. .. rst-class:: classref-item-separator
  1157. ----
  1158. .. _class_TextServer_method_font_get_glyph_contours:
  1159. .. rst-class:: classref-method
  1160. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours**\ (\ font\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_contours>`
  1161. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1162. \ ``points`` - :ref:`PackedVector3Array<class_PackedVector3Array>`, containing outline points. ``x`` and ``y`` are point coordinates. ``z`` is the type of the point, using the :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` values.
  1163. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1164. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1165. .. rst-class:: classref-item-separator
  1166. ----
  1167. .. _class_TextServer_method_font_get_glyph_index:
  1168. .. rst-class:: classref-method
  1169. :ref:`int<class_int>` **font_get_glyph_index**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, char\: :ref:`int<class_int>`, variation_selector\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_index>`
  1170. Returns the glyph index of a ``char``, optionally modified by the ``variation_selector``. See :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>`.
  1171. .. rst-class:: classref-item-separator
  1172. ----
  1173. .. _class_TextServer_method_font_get_glyph_list:
  1174. .. rst-class:: classref-method
  1175. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_list>`
  1176. Returns list of rendered glyphs in the cache entry.
  1177. .. rst-class:: classref-item-separator
  1178. ----
  1179. .. _class_TextServer_method_font_get_glyph_offset:
  1180. .. rst-class:: classref-method
  1181. :ref:`Vector2<class_Vector2>` **font_get_glyph_offset**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_offset>`
  1182. Returns glyph offset from the baseline.
  1183. .. rst-class:: classref-item-separator
  1184. ----
  1185. .. _class_TextServer_method_font_get_glyph_size:
  1186. .. rst-class:: classref-method
  1187. :ref:`Vector2<class_Vector2>` **font_get_glyph_size**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_size>`
  1188. Returns size of the glyph.
  1189. .. rst-class:: classref-item-separator
  1190. ----
  1191. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1192. .. rst-class:: classref-method
  1193. :ref:`int<class_int>` **font_get_glyph_texture_idx**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_texture_idx>`
  1194. Returns index of the cache texture containing the glyph.
  1195. .. rst-class:: classref-item-separator
  1196. ----
  1197. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1198. .. rst-class:: classref-method
  1199. :ref:`RID<class_RID>` **font_get_glyph_texture_rid**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_texture_rid>`
  1200. Returns resource ID of the cache texture containing the glyph.
  1201. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1202. .. rst-class:: classref-item-separator
  1203. ----
  1204. .. _class_TextServer_method_font_get_glyph_texture_size:
  1205. .. rst-class:: classref-method
  1206. :ref:`Vector2<class_Vector2>` **font_get_glyph_texture_size**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_texture_size>`
  1207. Returns size of the cache texture containing the glyph.
  1208. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1209. .. rst-class:: classref-item-separator
  1210. ----
  1211. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1212. .. rst-class:: classref-method
  1213. :ref:`Rect2<class_Rect2>` **font_get_glyph_uv_rect**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_glyph_uv_rect>`
  1214. Returns rectangle in the cache texture containing the glyph.
  1215. .. rst-class:: classref-item-separator
  1216. ----
  1217. .. _class_TextServer_method_font_get_hinting:
  1218. .. rst-class:: classref-method
  1219. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_hinting>`
  1220. Returns the font hinting mode. Used by dynamic fonts only.
  1221. .. rst-class:: classref-item-separator
  1222. ----
  1223. .. _class_TextServer_method_font_get_kerning:
  1224. .. rst-class:: classref-method
  1225. :ref:`Vector2<class_Vector2>` **font_get_kerning**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_kerning>`
  1226. Returns kerning for the pair of glyphs.
  1227. .. rst-class:: classref-item-separator
  1228. ----
  1229. .. _class_TextServer_method_font_get_kerning_list:
  1230. .. rst-class:: classref-method
  1231. :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] **font_get_kerning_list**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_kerning_list>`
  1232. Returns list of the kerning overrides.
  1233. .. rst-class:: classref-item-separator
  1234. ----
  1235. .. _class_TextServer_method_font_get_language_support_override:
  1236. .. rst-class:: classref-method
  1237. :ref:`bool<class_bool>` **font_get_language_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_override>`
  1238. Returns ``true`` if support override is enabled for the ``language``.
  1239. .. rst-class:: classref-item-separator
  1240. ----
  1241. .. _class_TextServer_method_font_get_language_support_overrides:
  1242. .. rst-class:: classref-method
  1243. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_overrides>`
  1244. Returns list of language support overrides.
  1245. .. rst-class:: classref-item-separator
  1246. ----
  1247. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1248. .. rst-class:: classref-method
  1249. :ref:`int<class_int>` **font_get_msdf_pixel_range**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_pixel_range>`
  1250. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1251. .. rst-class:: classref-item-separator
  1252. ----
  1253. .. _class_TextServer_method_font_get_msdf_size:
  1254. .. rst-class:: classref-method
  1255. :ref:`int<class_int>` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_size>`
  1256. Returns source font size used to generate MSDF textures.
  1257. .. rst-class:: classref-item-separator
  1258. ----
  1259. .. _class_TextServer_method_font_get_name:
  1260. .. rst-class:: classref-method
  1261. :ref:`String<class_String>` **font_get_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_name>`
  1262. Returns font family name.
  1263. .. rst-class:: classref-item-separator
  1264. ----
  1265. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1266. .. rst-class:: classref-method
  1267. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_opentype_feature_overrides>`
  1268. Returns font OpenType feature set override.
  1269. .. rst-class:: classref-item-separator
  1270. ----
  1271. .. _class_TextServer_method_font_get_ot_name_strings:
  1272. .. rst-class:: classref-method
  1273. :ref:`Dictionary<class_Dictionary>` **font_get_ot_name_strings**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_ot_name_strings>`
  1274. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1275. .. rst-class:: classref-item-separator
  1276. ----
  1277. .. _class_TextServer_method_font_get_oversampling:
  1278. .. rst-class:: classref-method
  1279. :ref:`float<class_float>` **font_get_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_oversampling>`
  1280. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1281. .. rst-class:: classref-item-separator
  1282. ----
  1283. .. _class_TextServer_method_font_get_scale:
  1284. .. rst-class:: classref-method
  1285. :ref:`float<class_float>` **font_get_scale**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_scale>`
  1286. Returns scaling factor of the color bitmap font.
  1287. .. rst-class:: classref-item-separator
  1288. ----
  1289. .. _class_TextServer_method_font_get_script_support_override:
  1290. .. rst-class:: classref-method
  1291. :ref:`bool<class_bool>` **font_get_script_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_override>`
  1292. Returns ``true`` if support override is enabled for the ``script``.
  1293. .. rst-class:: classref-item-separator
  1294. ----
  1295. .. _class_TextServer_method_font_get_script_support_overrides:
  1296. .. rst-class:: classref-method
  1297. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_overrides>`
  1298. Returns list of script support overrides.
  1299. .. rst-class:: classref-item-separator
  1300. ----
  1301. .. _class_TextServer_method_font_get_size_cache_list:
  1302. .. rst-class:: classref-method
  1303. :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] **font_get_size_cache_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_size_cache_list>`
  1304. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1305. .. rst-class:: classref-item-separator
  1306. ----
  1307. .. _class_TextServer_method_font_get_spacing:
  1308. .. rst-class:: classref-method
  1309. :ref:`int<class_int>` **font_get_spacing**\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_spacing>`
  1310. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1311. .. rst-class:: classref-item-separator
  1312. ----
  1313. .. _class_TextServer_method_font_get_stretch:
  1314. .. rst-class:: classref-method
  1315. :ref:`int<class_int>` **font_get_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_stretch>`
  1316. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1317. .. rst-class:: classref-item-separator
  1318. ----
  1319. .. _class_TextServer_method_font_get_style:
  1320. .. rst-class:: classref-method
  1321. |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **font_get_style**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style>`
  1322. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1323. .. rst-class:: classref-item-separator
  1324. ----
  1325. .. _class_TextServer_method_font_get_style_name:
  1326. .. rst-class:: classref-method
  1327. :ref:`String<class_String>` **font_get_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style_name>`
  1328. Returns font style name.
  1329. .. rst-class:: classref-item-separator
  1330. ----
  1331. .. _class_TextServer_method_font_get_subpixel_positioning:
  1332. .. rst-class:: classref-method
  1333. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_subpixel_positioning>`
  1334. Returns font subpixel glyph positioning mode.
  1335. .. rst-class:: classref-item-separator
  1336. ----
  1337. .. _class_TextServer_method_font_get_supported_chars:
  1338. .. rst-class:: classref-method
  1339. :ref:`String<class_String>` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_chars>`
  1340. Returns a string containing all the characters available in the font.
  1341. .. rst-class:: classref-item-separator
  1342. ----
  1343. .. _class_TextServer_method_font_get_texture_count:
  1344. .. rst-class:: classref-method
  1345. :ref:`int<class_int>` **font_get_texture_count**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_texture_count>`
  1346. Returns number of textures used by font cache entry.
  1347. .. rst-class:: classref-item-separator
  1348. ----
  1349. .. _class_TextServer_method_font_get_texture_image:
  1350. .. rst-class:: classref-method
  1351. :ref:`Image<class_Image>` **font_get_texture_image**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_texture_image>`
  1352. Returns font cache texture image data.
  1353. .. rst-class:: classref-item-separator
  1354. ----
  1355. .. _class_TextServer_method_font_get_texture_offsets:
  1356. .. rst-class:: classref-method
  1357. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_texture_offsets**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_texture_offsets>`
  1358. Returns array containing glyph packing data.
  1359. .. rst-class:: classref-item-separator
  1360. ----
  1361. .. _class_TextServer_method_font_get_transform:
  1362. .. rst-class:: classref-method
  1363. :ref:`Transform2D<class_Transform2D>` **font_get_transform**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_transform>`
  1364. Returns 2D transform applied to the font outlines.
  1365. .. rst-class:: classref-item-separator
  1366. ----
  1367. .. _class_TextServer_method_font_get_underline_position:
  1368. .. rst-class:: classref-method
  1369. :ref:`float<class_float>` **font_get_underline_position**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_underline_position>`
  1370. Returns pixel offset of the underline below the baseline.
  1371. .. rst-class:: classref-item-separator
  1372. ----
  1373. .. _class_TextServer_method_font_get_underline_thickness:
  1374. .. rst-class:: classref-method
  1375. :ref:`float<class_float>` **font_get_underline_thickness**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_underline_thickness>`
  1376. Returns thickness of the underline in pixels.
  1377. .. rst-class:: classref-item-separator
  1378. ----
  1379. .. _class_TextServer_method_font_get_variation_coordinates:
  1380. .. rst-class:: classref-method
  1381. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_variation_coordinates>`
  1382. Returns variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` for more info.
  1383. .. rst-class:: classref-item-separator
  1384. ----
  1385. .. _class_TextServer_method_font_get_weight:
  1386. .. rst-class:: classref-method
  1387. :ref:`int<class_int>` **font_get_weight**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_weight>`
  1388. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1389. .. rst-class:: classref-item-separator
  1390. ----
  1391. .. _class_TextServer_method_font_has_char:
  1392. .. rst-class:: classref-method
  1393. :ref:`bool<class_bool>` **font_has_char**\ (\ font_rid\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_has_char>`
  1394. Returns ``true`` if a Unicode ``char`` is available in the font.
  1395. .. rst-class:: classref-item-separator
  1396. ----
  1397. .. _class_TextServer_method_font_is_allow_system_fallback:
  1398. .. rst-class:: classref-method
  1399. :ref:`bool<class_bool>` **font_is_allow_system_fallback**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_allow_system_fallback>`
  1400. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1401. .. rst-class:: classref-item-separator
  1402. ----
  1403. .. _class_TextServer_method_font_is_force_autohinter:
  1404. .. rst-class:: classref-method
  1405. :ref:`bool<class_bool>` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_force_autohinter>`
  1406. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1407. .. rst-class:: classref-item-separator
  1408. ----
  1409. .. _class_TextServer_method_font_is_language_supported:
  1410. .. rst-class:: classref-method
  1411. :ref:`bool<class_bool>` **font_is_language_supported**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_language_supported>`
  1412. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1413. .. rst-class:: classref-item-separator
  1414. ----
  1415. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1416. .. rst-class:: classref-method
  1417. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_multichannel_signed_distance_field>`
  1418. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1419. .. rst-class:: classref-item-separator
  1420. ----
  1421. .. _class_TextServer_method_font_is_script_supported:
  1422. .. rst-class:: classref-method
  1423. :ref:`bool<class_bool>` **font_is_script_supported**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_script_supported>`
  1424. Returns ``true``, if font supports given script (ISO 15924 code).
  1425. .. rst-class:: classref-item-separator
  1426. ----
  1427. .. _class_TextServer_method_font_remove_glyph:
  1428. .. rst-class:: classref-method
  1429. |void| **font_remove_glyph**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_glyph>`
  1430. Removes specified rendered glyph information from the cache entry.
  1431. \ **Note:** This function will not remove textures associated with the glyphs, use :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>` to remove them manually.
  1432. .. rst-class:: classref-item-separator
  1433. ----
  1434. .. _class_TextServer_method_font_remove_kerning:
  1435. .. rst-class:: classref-method
  1436. |void| **font_remove_kerning**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_kerning>`
  1437. Removes kerning override for the pair of glyphs.
  1438. .. rst-class:: classref-item-separator
  1439. ----
  1440. .. _class_TextServer_method_font_remove_language_support_override:
  1441. .. rst-class:: classref-method
  1442. |void| **font_remove_language_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_language_support_override>`
  1443. Remove language support override.
  1444. .. rst-class:: classref-item-separator
  1445. ----
  1446. .. _class_TextServer_method_font_remove_script_support_override:
  1447. .. rst-class:: classref-method
  1448. |void| **font_remove_script_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_script_support_override>`
  1449. Removes script support override.
  1450. .. rst-class:: classref-item-separator
  1451. ----
  1452. .. _class_TextServer_method_font_remove_size_cache:
  1453. .. rst-class:: classref-method
  1454. |void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_size_cache>`
  1455. Removes specified font size from the cache entry.
  1456. .. rst-class:: classref-item-separator
  1457. ----
  1458. .. _class_TextServer_method_font_remove_texture:
  1459. .. rst-class:: classref-method
  1460. |void| **font_remove_texture**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_texture>`
  1461. Removes specified texture from the cache entry.
  1462. \ **Note:** This function will not remove glyphs associated with the texture, remove them manually, using :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>`.
  1463. .. rst-class:: classref-item-separator
  1464. ----
  1465. .. _class_TextServer_method_font_render_glyph:
  1466. .. rst-class:: classref-method
  1467. |void| **font_render_glyph**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_render_glyph>`
  1468. Renders specified glyph to the font cache texture.
  1469. .. rst-class:: classref-item-separator
  1470. ----
  1471. .. _class_TextServer_method_font_render_range:
  1472. .. rst-class:: classref-method
  1473. |void| **font_render_range**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_render_range>`
  1474. Renders the range of characters to the font cache texture.
  1475. .. rst-class:: classref-item-separator
  1476. ----
  1477. .. _class_TextServer_method_font_set_allow_system_fallback:
  1478. .. rst-class:: classref-method
  1479. |void| **font_set_allow_system_fallback**\ (\ font_rid\: :ref:`RID<class_RID>`, allow_system_fallback\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_allow_system_fallback>`
  1480. If set to ``true``, system fonts can be automatically used as fallbacks.
  1481. .. rst-class:: classref-item-separator
  1482. ----
  1483. .. _class_TextServer_method_font_set_antialiasing:
  1484. .. rst-class:: classref-method
  1485. |void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_antialiasing>`
  1486. Sets font anti-aliasing mode.
  1487. .. rst-class:: classref-item-separator
  1488. ----
  1489. .. _class_TextServer_method_font_set_ascent:
  1490. .. rst-class:: classref-method
  1491. |void| **font_set_ascent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, ascent\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_ascent>`
  1492. Sets the font ascent (number of pixels above the baseline).
  1493. .. rst-class:: classref-item-separator
  1494. ----
  1495. .. _class_TextServer_method_font_set_baseline_offset:
  1496. .. rst-class:: classref-method
  1497. |void| **font_set_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`, baseline_offset\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_baseline_offset>`
  1498. Sets extra baseline offset (as a fraction of font height).
  1499. .. rst-class:: classref-item-separator
  1500. ----
  1501. .. _class_TextServer_method_font_set_data:
  1502. .. rst-class:: classref-method
  1503. |void| **font_set_data**\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_data>`
  1504. Sets font source data, e.g contents of the dynamic font source file.
  1505. .. rst-class:: classref-item-separator
  1506. ----
  1507. .. _class_TextServer_method_font_set_descent:
  1508. .. rst-class:: classref-method
  1509. |void| **font_set_descent**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, descent\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_descent>`
  1510. Sets the font descent (number of pixels below the baseline).
  1511. .. rst-class:: classref-item-separator
  1512. ----
  1513. .. _class_TextServer_method_font_set_disable_embedded_bitmaps:
  1514. .. rst-class:: classref-method
  1515. |void| **font_set_disable_embedded_bitmaps**\ (\ font_rid\: :ref:`RID<class_RID>`, disable_embedded_bitmaps\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_disable_embedded_bitmaps>`
  1516. If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
  1517. .. rst-class:: classref-item-separator
  1518. ----
  1519. .. _class_TextServer_method_font_set_embolden:
  1520. .. rst-class:: classref-method
  1521. |void| **font_set_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_embolden>`
  1522. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1523. .. rst-class:: classref-item-separator
  1524. ----
  1525. .. _class_TextServer_method_font_set_face_index:
  1526. .. rst-class:: classref-method
  1527. |void| **font_set_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`, face_index\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_face_index>`
  1528. Sets an active face index in the TrueType / OpenType collection.
  1529. .. rst-class:: classref-item-separator
  1530. ----
  1531. .. _class_TextServer_method_font_set_fixed_size:
  1532. .. rst-class:: classref-method
  1533. |void| **font_set_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_fixed_size>`
  1534. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1535. .. rst-class:: classref-item-separator
  1536. ----
  1537. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1538. .. rst-class:: classref-method
  1539. |void| **font_set_fixed_size_scale_mode**\ (\ font_rid\: :ref:`RID<class_RID>`, fixed_size_scale_mode\: :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_fixed_size_scale_mode>`
  1540. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1541. .. rst-class:: classref-item-separator
  1542. ----
  1543. .. _class_TextServer_method_font_set_force_autohinter:
  1544. .. rst-class:: classref-method
  1545. |void| **font_set_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`, force_autohinter\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_force_autohinter>`
  1546. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1547. .. rst-class:: classref-item-separator
  1548. ----
  1549. .. _class_TextServer_method_font_set_generate_mipmaps:
  1550. .. rst-class:: classref-method
  1551. |void| **font_set_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`, generate_mipmaps\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_generate_mipmaps>`
  1552. If set to ``true`` font texture mipmap generation is enabled.
  1553. .. rst-class:: classref-item-separator
  1554. ----
  1555. .. _class_TextServer_method_font_set_global_oversampling:
  1556. .. rst-class:: classref-method
  1557. |void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_global_oversampling>`
  1558. Sets oversampling factor, shared by all font in the TextServer.
  1559. \ **Note:** This value can be automatically changed by display server.
  1560. .. rst-class:: classref-item-separator
  1561. ----
  1562. .. _class_TextServer_method_font_set_glyph_advance:
  1563. .. rst-class:: classref-method
  1564. |void| **font_set_glyph_advance**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph\: :ref:`int<class_int>`, advance\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_advance>`
  1565. Sets glyph advance (offset of the next glyph).
  1566. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1567. .. rst-class:: classref-item-separator
  1568. ----
  1569. .. _class_TextServer_method_font_set_glyph_offset:
  1570. .. rst-class:: classref-method
  1571. |void| **font_set_glyph_offset**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, offset\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_offset>`
  1572. Sets glyph offset from the baseline.
  1573. .. rst-class:: classref-item-separator
  1574. ----
  1575. .. _class_TextServer_method_font_set_glyph_size:
  1576. .. rst-class:: classref-method
  1577. |void| **font_set_glyph_size**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, gl_size\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_size>`
  1578. Sets size of the glyph.
  1579. .. rst-class:: classref-item-separator
  1580. ----
  1581. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1582. .. rst-class:: classref-method
  1583. |void| **font_set_glyph_texture_idx**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, texture_idx\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_texture_idx>`
  1584. Sets index of the cache texture containing the glyph.
  1585. .. rst-class:: classref-item-separator
  1586. ----
  1587. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1588. .. rst-class:: classref-method
  1589. |void| **font_set_glyph_uv_rect**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, glyph\: :ref:`int<class_int>`, uv_rect\: :ref:`Rect2<class_Rect2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_glyph_uv_rect>`
  1590. Sets rectangle in the cache texture containing the glyph.
  1591. .. rst-class:: classref-item-separator
  1592. ----
  1593. .. _class_TextServer_method_font_set_hinting:
  1594. .. rst-class:: classref-method
  1595. |void| **font_set_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_hinting>`
  1596. Sets font hinting mode. Used by dynamic fonts only.
  1597. .. rst-class:: classref-item-separator
  1598. ----
  1599. .. _class_TextServer_method_font_set_kerning:
  1600. .. rst-class:: classref-method
  1601. |void| **font_set_kerning**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`, kerning\: :ref:`Vector2<class_Vector2>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_kerning>`
  1602. Sets kerning for the pair of glyphs.
  1603. .. rst-class:: classref-item-separator
  1604. ----
  1605. .. _class_TextServer_method_font_set_language_support_override:
  1606. .. rst-class:: classref-method
  1607. |void| **font_set_language_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_language_support_override>`
  1608. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1609. .. rst-class:: classref-item-separator
  1610. ----
  1611. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1612. .. rst-class:: classref-method
  1613. |void| **font_set_msdf_pixel_range**\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_pixel_range\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_msdf_pixel_range>`
  1614. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1615. .. rst-class:: classref-item-separator
  1616. ----
  1617. .. _class_TextServer_method_font_set_msdf_size:
  1618. .. rst-class:: classref-method
  1619. |void| **font_set_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`, msdf_size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_msdf_size>`
  1620. Sets source font size used to generate MSDF textures.
  1621. .. rst-class:: classref-item-separator
  1622. ----
  1623. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1624. .. rst-class:: classref-method
  1625. |void| **font_set_multichannel_signed_distance_field**\ (\ font_rid\: :ref:`RID<class_RID>`, msdf\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_multichannel_signed_distance_field>`
  1626. If set to ``true``, glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data. MSDF rendering allows displaying the font at any scaling factor without blurriness, and without incurring a CPU cost when the font size changes (since the font no longer needs to be rasterized on the CPU). As a downside, font hinting is not available with MSDF. The lack of font hinting may result in less crisp and less readable fonts at small sizes.
  1627. \ **Note:** MSDF font rendering does not render glyphs with overlapping shapes correctly. Overlapping shapes are not valid per the OpenType standard, but are still commonly found in many font files, especially those converted by Google Fonts. To avoid issues with overlapping glyphs, consider downloading the font file directly from the type foundry instead of relying on Google Fonts.
  1628. .. rst-class:: classref-item-separator
  1629. ----
  1630. .. _class_TextServer_method_font_set_name:
  1631. .. rst-class:: classref-method
  1632. |void| **font_set_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_name>`
  1633. Sets the font family name.
  1634. .. rst-class:: classref-item-separator
  1635. ----
  1636. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1637. .. rst-class:: classref-method
  1638. |void| **font_set_opentype_feature_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`, overrides\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_opentype_feature_overrides>`
  1639. Sets font OpenType feature set override.
  1640. .. rst-class:: classref-item-separator
  1641. ----
  1642. .. _class_TextServer_method_font_set_oversampling:
  1643. .. rst-class:: classref-method
  1644. |void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_oversampling>`
  1645. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1646. .. rst-class:: classref-item-separator
  1647. ----
  1648. .. _class_TextServer_method_font_set_scale:
  1649. .. rst-class:: classref-method
  1650. |void| **font_set_scale**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, scale\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_scale>`
  1651. Sets scaling factor of the color bitmap font.
  1652. .. rst-class:: classref-item-separator
  1653. ----
  1654. .. _class_TextServer_method_font_set_script_support_override:
  1655. .. rst-class:: classref-method
  1656. |void| **font_set_script_support_override**\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`, supported\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_script_support_override>`
  1657. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1658. .. rst-class:: classref-item-separator
  1659. ----
  1660. .. _class_TextServer_method_font_set_spacing:
  1661. .. rst-class:: classref-method
  1662. |void| **font_set_spacing**\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_spacing>`
  1663. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1664. .. rst-class:: classref-item-separator
  1665. ----
  1666. .. _class_TextServer_method_font_set_stretch:
  1667. .. rst-class:: classref-method
  1668. |void| **font_set_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_stretch>`
  1669. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1670. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, or :ref:`font_set_transform<class_TextServer_method_font_set_transform>` instead.
  1671. .. rst-class:: classref-item-separator
  1672. ----
  1673. .. _class_TextServer_method_font_set_style:
  1674. .. rst-class:: classref-method
  1675. |void| **font_set_style**\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style>`
  1676. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1677. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>`, or :ref:`font_set_transform<class_TextServer_method_font_set_transform>` instead.
  1678. .. rst-class:: classref-item-separator
  1679. ----
  1680. .. _class_TextServer_method_font_set_style_name:
  1681. .. rst-class:: classref-method
  1682. |void| **font_set_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style_name>`
  1683. Sets the font style name.
  1684. .. rst-class:: classref-item-separator
  1685. ----
  1686. .. _class_TextServer_method_font_set_subpixel_positioning:
  1687. .. rst-class:: classref-method
  1688. |void| **font_set_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`, subpixel_positioning\: :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_subpixel_positioning>`
  1689. Sets font subpixel glyph positioning mode.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _class_TextServer_method_font_set_texture_image:
  1693. .. rst-class:: classref-method
  1694. |void| **font_set_texture_image**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, image\: :ref:`Image<class_Image>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_texture_image>`
  1695. Sets font cache texture image data.
  1696. .. rst-class:: classref-item-separator
  1697. ----
  1698. .. _class_TextServer_method_font_set_texture_offsets:
  1699. .. rst-class:: classref-method
  1700. |void| **font_set_texture_offsets**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`, texture_index\: :ref:`int<class_int>`, offset\: :ref:`PackedInt32Array<class_PackedInt32Array>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_texture_offsets>`
  1701. Sets array containing glyph packing data.
  1702. .. rst-class:: classref-item-separator
  1703. ----
  1704. .. _class_TextServer_method_font_set_transform:
  1705. .. rst-class:: classref-method
  1706. |void| **font_set_transform**\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_transform>`
  1707. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
  1708. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1709. .. rst-class:: classref-item-separator
  1710. ----
  1711. .. _class_TextServer_method_font_set_underline_position:
  1712. .. rst-class:: classref-method
  1713. |void| **font_set_underline_position**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_position\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_underline_position>`
  1714. Sets pixel offset of the underline below the baseline.
  1715. .. rst-class:: classref-item-separator
  1716. ----
  1717. .. _class_TextServer_method_font_set_underline_thickness:
  1718. .. rst-class:: classref-method
  1719. |void| **font_set_underline_thickness**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, underline_thickness\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_underline_thickness>`
  1720. Sets thickness of the underline in pixels.
  1721. .. rst-class:: classref-item-separator
  1722. ----
  1723. .. _class_TextServer_method_font_set_variation_coordinates:
  1724. .. rst-class:: classref-method
  1725. |void| **font_set_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`, variation_coordinates\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_variation_coordinates>`
  1726. Sets variation coordinates for the specified font cache entry. See :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` for more info.
  1727. .. rst-class:: classref-item-separator
  1728. ----
  1729. .. _class_TextServer_method_font_set_weight:
  1730. .. rst-class:: classref-method
  1731. |void| **font_set_weight**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_weight>`
  1732. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1733. \ **Note:** This value is used for font matching only and will not affect font rendering. Use :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>`, :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>`, or :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>` instead.
  1734. .. rst-class:: classref-item-separator
  1735. ----
  1736. .. _class_TextServer_method_font_supported_feature_list:
  1737. .. rst-class:: classref-method
  1738. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_feature_list>`
  1739. Returns the dictionary of the supported OpenType features.
  1740. .. rst-class:: classref-item-separator
  1741. ----
  1742. .. _class_TextServer_method_font_supported_variation_list:
  1743. .. rst-class:: classref-method
  1744. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_variation_list>`
  1745. Returns the dictionary of the supported OpenType variation coordinates.
  1746. .. rst-class:: classref-item-separator
  1747. ----
  1748. .. _class_TextServer_method_format_number:
  1749. .. rst-class:: classref-method
  1750. :ref:`String<class_String>` **format_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_format_number>`
  1751. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1752. If ``language`` is omitted, the active locale will be used.
  1753. .. rst-class:: classref-item-separator
  1754. ----
  1755. .. _class_TextServer_method_free_rid:
  1756. .. rst-class:: classref-method
  1757. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_free_rid>`
  1758. Frees an object created by this **TextServer**.
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_TextServer_method_get_features:
  1762. .. rst-class:: classref-method
  1763. :ref:`int<class_int>` **get_features**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_features>`
  1764. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1765. .. rst-class:: classref-item-separator
  1766. ----
  1767. .. _class_TextServer_method_get_hex_code_box_size:
  1768. .. rst-class:: classref-method
  1769. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size**\ (\ size\: :ref:`int<class_int>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_hex_code_box_size>`
  1770. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1771. .. rst-class:: classref-item-separator
  1772. ----
  1773. .. _class_TextServer_method_get_name:
  1774. .. rst-class:: classref-method
  1775. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_name>`
  1776. Returns the name of the server interface.
  1777. .. rst-class:: classref-item-separator
  1778. ----
  1779. .. _class_TextServer_method_get_support_data_filename:
  1780. .. rst-class:: classref-method
  1781. :ref:`String<class_String>` **get_support_data_filename**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_filename>`
  1782. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1783. .. rst-class:: classref-item-separator
  1784. ----
  1785. .. _class_TextServer_method_get_support_data_info:
  1786. .. rst-class:: classref-method
  1787. :ref:`String<class_String>` **get_support_data_info**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_info>`
  1788. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1789. .. rst-class:: classref-item-separator
  1790. ----
  1791. .. _class_TextServer_method_has:
  1792. .. rst-class:: classref-method
  1793. :ref:`bool<class_bool>` **has**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_has>`
  1794. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1795. .. rst-class:: classref-item-separator
  1796. ----
  1797. .. _class_TextServer_method_has_feature:
  1798. .. rst-class:: classref-method
  1799. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_has_feature>`
  1800. Returns ``true`` if the server supports a feature.
  1801. .. rst-class:: classref-item-separator
  1802. ----
  1803. .. _class_TextServer_method_is_confusable:
  1804. .. rst-class:: classref-method
  1805. :ref:`int<class_int>` **is_confusable**\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_confusable>`
  1806. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1807. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1808. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_TextServer_method_is_locale_right_to_left:
  1812. .. rst-class:: classref-method
  1813. :ref:`bool<class_bool>` **is_locale_right_to_left**\ (\ locale\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_locale_right_to_left>`
  1814. Returns ``true`` if locale is right-to-left.
  1815. .. rst-class:: classref-item-separator
  1816. ----
  1817. .. _class_TextServer_method_is_valid_identifier:
  1818. .. rst-class:: classref-method
  1819. :ref:`bool<class_bool>` **is_valid_identifier**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_identifier>`
  1820. Returns ``true`` if ``string`` is a valid identifier.
  1821. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1822. - Conform to normalization form C.
  1823. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1824. - May contain Unicode characters of class XID_Continue in the other positions.
  1825. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1826. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1827. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1828. - May contain Unicode characters of class XID_Continue in the other positions.
  1829. .. rst-class:: classref-item-separator
  1830. ----
  1831. .. _class_TextServer_method_is_valid_letter:
  1832. .. rst-class:: classref-method
  1833. :ref:`bool<class_bool>` **is_valid_letter**\ (\ unicode\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_letter>`
  1834. Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L".
  1835. .. rst-class:: classref-item-separator
  1836. ----
  1837. .. _class_TextServer_method_load_support_data:
  1838. .. rst-class:: classref-method
  1839. :ref:`bool<class_bool>` **load_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_load_support_data>`
  1840. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1841. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1842. .. rst-class:: classref-item-separator
  1843. ----
  1844. .. _class_TextServer_method_name_to_tag:
  1845. .. rst-class:: classref-method
  1846. :ref:`int<class_int>` **name_to_tag**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_name_to_tag>`
  1847. Converts readable feature, variation, script, or language name to OpenType tag.
  1848. .. rst-class:: classref-item-separator
  1849. ----
  1850. .. _class_TextServer_method_parse_number:
  1851. .. rst-class:: classref-method
  1852. :ref:`String<class_String>` **parse_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_number>`
  1853. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1854. .. rst-class:: classref-item-separator
  1855. ----
  1856. .. _class_TextServer_method_parse_structured_text:
  1857. .. rst-class:: classref-method
  1858. :ref:`Array<class_Array>`\[:ref:`Vector3i<class_Vector3i>`\] **parse_structured_text**\ (\ parser_type\: :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>`, args\: :ref:`Array<class_Array>`, text\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_structured_text>`
  1859. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1860. .. rst-class:: classref-item-separator
  1861. ----
  1862. .. _class_TextServer_method_percent_sign:
  1863. .. rst-class:: classref-method
  1864. :ref:`String<class_String>` **percent_sign**\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_percent_sign>`
  1865. Returns percent sign used in the ``language``.
  1866. .. rst-class:: classref-item-separator
  1867. ----
  1868. .. _class_TextServer_method_save_support_data:
  1869. .. rst-class:: classref-method
  1870. :ref:`bool<class_bool>` **save_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_save_support_data>`
  1871. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1872. \ **Note:** This function is used by during project export, to include TextServer database.
  1873. .. rst-class:: classref-item-separator
  1874. ----
  1875. .. _class_TextServer_method_shaped_get_span_count:
  1876. .. rst-class:: classref-method
  1877. :ref:`int<class_int>` **shaped_get_span_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_count>`
  1878. Returns number of text spans added using :ref:`shaped_text_add_string<class_TextServer_method_shaped_text_add_string>` or :ref:`shaped_text_add_object<class_TextServer_method_shaped_text_add_object>`.
  1879. .. rst-class:: classref-item-separator
  1880. ----
  1881. .. _class_TextServer_method_shaped_get_span_meta:
  1882. .. rst-class:: classref-method
  1883. :ref:`Variant<class_Variant>` **shaped_get_span_meta**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_meta>`
  1884. Returns text span metadata.
  1885. .. rst-class:: classref-item-separator
  1886. ----
  1887. .. _class_TextServer_method_shaped_set_span_update_font:
  1888. .. rst-class:: classref-method
  1889. |void| **shaped_set_span_update_font**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_set_span_update_font>`
  1890. Changes text span font, font size, and OpenType features, without changing the text.
  1891. .. rst-class:: classref-item-separator
  1892. ----
  1893. .. _class_TextServer_method_shaped_text_add_object:
  1894. .. rst-class:: classref-method
  1895. :ref:`bool<class_bool>` **shaped_text_add_object**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, length\: :ref:`int<class_int>` = 1, baseline\: :ref:`float<class_float>` = 0.0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_add_object>`
  1896. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1897. .. rst-class:: classref-item-separator
  1898. ----
  1899. .. _class_TextServer_method_shaped_text_add_string:
  1900. .. rst-class:: classref-method
  1901. :ref:`bool<class_bool>` **shaped_text_add_string**\ (\ shaped\: :ref:`RID<class_RID>`, text\: :ref:`String<class_String>`, fonts\: :ref:`Array<class_Array>`\[:ref:`RID<class_RID>`\], size\: :ref:`int<class_int>`, opentype_features\: :ref:`Dictionary<class_Dictionary>` = {}, language\: :ref:`String<class_String>` = "", meta\: :ref:`Variant<class_Variant>` = null\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_add_string>`
  1902. Adds text span and font to draw it to the text buffer.
  1903. .. rst-class:: classref-item-separator
  1904. ----
  1905. .. _class_TextServer_method_shaped_text_clear:
  1906. .. rst-class:: classref-method
  1907. |void| **shaped_text_clear**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_clear>`
  1908. Clears text buffer (removes text and inline objects).
  1909. .. rst-class:: classref-item-separator
  1910. ----
  1911. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1912. .. rst-class:: classref-method
  1913. :ref:`int<class_int>` **shaped_text_closest_character_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_closest_character_pos>`
  1914. Returns composite character position closest to the ``pos``.
  1915. .. rst-class:: classref-item-separator
  1916. ----
  1917. .. _class_TextServer_method_shaped_text_draw:
  1918. .. rst-class:: classref-method
  1919. |void| **shaped_text_draw**\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_draw>`
  1920. Draw shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
  1921. .. rst-class:: classref-item-separator
  1922. ----
  1923. .. _class_TextServer_method_shaped_text_draw_outline:
  1924. .. rst-class:: classref-method
  1925. |void| **shaped_text_draw_outline**\ (\ shaped\: :ref:`RID<class_RID>`, canvas\: :ref:`RID<class_RID>`, pos\: :ref:`Vector2<class_Vector2>`, clip_l\: :ref:`float<class_float>` = -1, clip_r\: :ref:`float<class_float>` = -1, outline_size\: :ref:`int<class_int>` = 1, color\: :ref:`Color<class_Color>` = Color(1, 1, 1, 1)\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_draw_outline>`
  1926. Draw the outline of the shaped text into a canvas item at a given position, with ``color``. ``pos`` specifies the leftmost point of the baseline (for horizontal layout) or topmost point of the baseline (for vertical layout).
  1927. .. rst-class:: classref-item-separator
  1928. ----
  1929. .. _class_TextServer_method_shaped_text_fit_to_width:
  1930. .. rst-class:: classref-method
  1931. :ref:`float<class_float>` **shaped_text_fit_to_width**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, justification_flags\: |bitfield|\[:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\] = 3\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_fit_to_width>`
  1932. Adjusts text width to fit to specified width, returns new text width.
  1933. .. rst-class:: classref-item-separator
  1934. ----
  1935. .. _class_TextServer_method_shaped_text_get_ascent:
  1936. .. rst-class:: classref-method
  1937. :ref:`float<class_float>` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ascent>`
  1938. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1939. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1940. .. rst-class:: classref-item-separator
  1941. ----
  1942. .. _class_TextServer_method_shaped_text_get_carets:
  1943. .. rst-class:: classref-method
  1944. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets**\ (\ shaped\: :ref:`RID<class_RID>`, position\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_carets>`
  1945. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1946. .. rst-class:: classref-item-separator
  1947. ----
  1948. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1949. .. rst-class:: classref-method
  1950. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_character_breaks>`
  1951. Returns array of the composite character boundaries.
  1952. .. rst-class:: classref-item-separator
  1953. ----
  1954. .. _class_TextServer_method_shaped_text_get_custom_ellipsis:
  1955. .. rst-class:: classref-method
  1956. :ref:`int<class_int>` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_ellipsis>`
  1957. Returns ellipsis character used for text clipping.
  1958. .. rst-class:: classref-item-separator
  1959. ----
  1960. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1961. .. rst-class:: classref-method
  1962. :ref:`String<class_String>` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_punctuation>`
  1963. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1964. .. rst-class:: classref-item-separator
  1965. ----
  1966. .. _class_TextServer_method_shaped_text_get_descent:
  1967. .. rst-class:: classref-method
  1968. :ref:`float<class_float>` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_descent>`
  1969. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1970. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1971. .. rst-class:: classref-item-separator
  1972. ----
  1973. .. _class_TextServer_method_shaped_text_get_direction:
  1974. .. rst-class:: classref-method
  1975. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_direction>`
  1976. Returns direction of the text.
  1977. .. rst-class:: classref-item-separator
  1978. ----
  1979. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1980. .. rst-class:: classref-method
  1981. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_dominant_direction_in_range**\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_dominant_direction_in_range>`
  1982. Returns dominant direction of in the range of text.
  1983. .. rst-class:: classref-item-separator
  1984. ----
  1985. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1986. .. rst-class:: classref-method
  1987. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>`
  1988. Returns number of glyphs in the ellipsis.
  1989. .. rst-class:: classref-item-separator
  1990. ----
  1991. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  1992. .. rst-class:: classref-method
  1993. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **shaped_text_get_ellipsis_glyphs**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_glyphs>`
  1994. Returns array of the glyphs in the ellipsis.
  1995. .. rst-class:: classref-item-separator
  1996. ----
  1997. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  1998. .. rst-class:: classref-method
  1999. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_pos>`
  2000. Returns position of the ellipsis.
  2001. .. rst-class:: classref-item-separator
  2002. ----
  2003. .. _class_TextServer_method_shaped_text_get_glyph_count:
  2004. .. rst-class:: classref-method
  2005. :ref:`int<class_int>` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyph_count>`
  2006. Returns number of glyphs in the buffer.
  2007. .. rst-class:: classref-item-separator
  2008. ----
  2009. .. _class_TextServer_method_shaped_text_get_glyphs:
  2010. .. rst-class:: classref-method
  2011. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **shaped_text_get_glyphs**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyphs>`
  2012. Returns an array of glyphs in the visual order.
  2013. .. rst-class:: classref-item-separator
  2014. ----
  2015. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  2016. .. rst-class:: classref-method
  2017. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_grapheme_bounds>`
  2018. Returns composite character's bounds as offsets from the start of the line.
  2019. .. rst-class:: classref-item-separator
  2020. ----
  2021. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  2022. .. rst-class:: classref-method
  2023. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_inferred_direction>`
  2024. Returns direction of the text, inferred by the BiDi algorithm.
  2025. .. rst-class:: classref-item-separator
  2026. ----
  2027. .. _class_TextServer_method_shaped_text_get_line_breaks:
  2028. .. rst-class:: classref-method
  2029. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>`, start\: :ref:`int<class_int>` = 0, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_line_breaks>`
  2030. Breaks text to the lines and returns character ranges for each line.
  2031. .. rst-class:: classref-item-separator
  2032. ----
  2033. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  2034. .. rst-class:: classref-method
  2035. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks_adv**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`, start\: :ref:`int<class_int>` = 0, once\: :ref:`bool<class_bool>` = true, break_flags\: |bitfield|\[:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\] = 3\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_line_breaks_adv>`
  2036. Breaks text to the lines and columns. Returns character ranges for each segment.
  2037. .. rst-class:: classref-item-separator
  2038. ----
  2039. .. _class_TextServer_method_shaped_text_get_object_glyph:
  2040. .. rst-class:: classref-method
  2041. :ref:`int<class_int>` **shaped_text_get_object_glyph**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_object_glyph>`
  2042. Returns the glyph index of the inline object.
  2043. .. rst-class:: classref-item-separator
  2044. ----
  2045. .. _class_TextServer_method_shaped_text_get_object_range:
  2046. .. rst-class:: classref-method
  2047. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_object_range**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_object_range>`
  2048. Returns the character range of the inline object.
  2049. .. rst-class:: classref-item-separator
  2050. ----
  2051. .. _class_TextServer_method_shaped_text_get_object_rect:
  2052. .. rst-class:: classref-method
  2053. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_object_rect>`
  2054. Returns bounding rectangle of the inline object.
  2055. .. rst-class:: classref-item-separator
  2056. ----
  2057. .. _class_TextServer_method_shaped_text_get_objects:
  2058. .. rst-class:: classref-method
  2059. :ref:`Array<class_Array>` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_objects>`
  2060. Returns array of inline objects.
  2061. .. rst-class:: classref-item-separator
  2062. ----
  2063. .. _class_TextServer_method_shaped_text_get_orientation:
  2064. .. rst-class:: classref-method
  2065. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_orientation>`
  2066. Returns text orientation.
  2067. .. rst-class:: classref-item-separator
  2068. ----
  2069. .. _class_TextServer_method_shaped_text_get_parent:
  2070. .. rst-class:: classref-method
  2071. :ref:`RID<class_RID>` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_parent>`
  2072. Returns the parent buffer from which the substring originates.
  2073. .. rst-class:: classref-item-separator
  2074. ----
  2075. .. _class_TextServer_method_shaped_text_get_preserve_control:
  2076. .. rst-class:: classref-method
  2077. :ref:`bool<class_bool>` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_control>`
  2078. Returns ``true`` if text buffer is configured to display control characters.
  2079. .. rst-class:: classref-item-separator
  2080. ----
  2081. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  2082. .. rst-class:: classref-method
  2083. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_invalid>`
  2084. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2085. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2086. .. rst-class:: classref-item-separator
  2087. ----
  2088. .. _class_TextServer_method_shaped_text_get_range:
  2089. .. rst-class:: classref-method
  2090. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_range>`
  2091. Returns substring buffer character range in the parent buffer.
  2092. .. rst-class:: classref-item-separator
  2093. ----
  2094. .. _class_TextServer_method_shaped_text_get_selection:
  2095. .. rst-class:: classref-method
  2096. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection**\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, end\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_selection>`
  2097. Returns selection rectangles for the specified character range.
  2098. .. rst-class:: classref-item-separator
  2099. ----
  2100. .. _class_TextServer_method_shaped_text_get_size:
  2101. .. rst-class:: classref-method
  2102. :ref:`Vector2<class_Vector2>` **shaped_text_get_size**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_size>`
  2103. Returns size of the text.
  2104. .. rst-class:: classref-item-separator
  2105. ----
  2106. .. _class_TextServer_method_shaped_text_get_spacing:
  2107. .. rst-class:: classref-method
  2108. :ref:`int<class_int>` **shaped_text_get_spacing**\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_spacing>`
  2109. Returns extra spacing added between glyphs or lines in pixels.
  2110. .. rst-class:: classref-item-separator
  2111. ----
  2112. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2113. .. rst-class:: classref-method
  2114. :ref:`int<class_int>` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_trim_pos>`
  2115. Returns the position of the overrun trim.
  2116. .. rst-class:: classref-item-separator
  2117. ----
  2118. .. _class_TextServer_method_shaped_text_get_underline_position:
  2119. .. rst-class:: classref-method
  2120. :ref:`float<class_float>` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_position>`
  2121. Returns pixel offset of the underline below the baseline.
  2122. .. rst-class:: classref-item-separator
  2123. ----
  2124. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2125. .. rst-class:: classref-method
  2126. :ref:`float<class_float>` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_thickness>`
  2127. Returns thickness of the underline.
  2128. .. rst-class:: classref-item-separator
  2129. ----
  2130. .. _class_TextServer_method_shaped_text_get_width:
  2131. .. rst-class:: classref-method
  2132. :ref:`float<class_float>` **shaped_text_get_width**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_width>`
  2133. Returns width (for horizontal layout) or height (for vertical) of the text.
  2134. .. rst-class:: classref-item-separator
  2135. ----
  2136. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2137. .. rst-class:: classref-method
  2138. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks**\ (\ shaped\: :ref:`RID<class_RID>`, grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 264, skip_grapheme_flags\: |bitfield|\[:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\] = 4\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_word_breaks>`
  2139. Breaks text into words and returns array of character ranges. Use ``grapheme_flags`` to set what characters are used for breaking (see :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`).
  2140. .. rst-class:: classref-item-separator
  2141. ----
  2142. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2143. .. rst-class:: classref-method
  2144. :ref:`bool<class_bool>` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_has_visible_chars>`
  2145. Returns ``true`` if text buffer contains any visible characters.
  2146. .. rst-class:: classref-item-separator
  2147. ----
  2148. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2149. .. rst-class:: classref-method
  2150. :ref:`int<class_int>` **shaped_text_hit_test_grapheme**\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_hit_test_grapheme>`
  2151. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2152. .. rst-class:: classref-item-separator
  2153. ----
  2154. .. _class_TextServer_method_shaped_text_hit_test_position:
  2155. .. rst-class:: classref-method
  2156. :ref:`int<class_int>` **shaped_text_hit_test_position**\ (\ shaped\: :ref:`RID<class_RID>`, coords\: :ref:`float<class_float>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_hit_test_position>`
  2157. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2158. .. rst-class:: classref-item-separator
  2159. ----
  2160. .. _class_TextServer_method_shaped_text_is_ready:
  2161. .. rst-class:: classref-method
  2162. :ref:`bool<class_bool>` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_is_ready>`
  2163. Returns ``true`` if buffer is successfully shaped.
  2164. .. rst-class:: classref-item-separator
  2165. ----
  2166. .. _class_TextServer_method_shaped_text_next_character_pos:
  2167. .. rst-class:: classref-method
  2168. :ref:`int<class_int>` **shaped_text_next_character_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_next_character_pos>`
  2169. Returns composite character end position closest to the ``pos``.
  2170. .. rst-class:: classref-item-separator
  2171. ----
  2172. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2173. .. rst-class:: classref-method
  2174. :ref:`int<class_int>` **shaped_text_next_grapheme_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_next_grapheme_pos>`
  2175. Returns grapheme end position closest to the ``pos``.
  2176. .. rst-class:: classref-item-separator
  2177. ----
  2178. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2179. .. rst-class:: classref-method
  2180. |void| **shaped_text_overrun_trim_to_width**\ (\ shaped\: :ref:`RID<class_RID>`, width\: :ref:`float<class_float>` = 0, overrun_trim_flags\: |bitfield|\[:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\] = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_overrun_trim_to_width>`
  2181. Trims text if it exceeds the given width.
  2182. .. rst-class:: classref-item-separator
  2183. ----
  2184. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2185. .. rst-class:: classref-method
  2186. :ref:`int<class_int>` **shaped_text_prev_character_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_prev_character_pos>`
  2187. Returns composite character start position closest to the ``pos``.
  2188. .. rst-class:: classref-item-separator
  2189. ----
  2190. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2191. .. rst-class:: classref-method
  2192. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos**\ (\ shaped\: :ref:`RID<class_RID>`, pos\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_prev_grapheme_pos>`
  2193. Returns grapheme start position closest to the ``pos``.
  2194. .. rst-class:: classref-item-separator
  2195. ----
  2196. .. _class_TextServer_method_shaped_text_resize_object:
  2197. .. rst-class:: classref-method
  2198. :ref:`bool<class_bool>` **shaped_text_resize_object**\ (\ shaped\: :ref:`RID<class_RID>`, key\: :ref:`Variant<class_Variant>`, size\: :ref:`Vector2<class_Vector2>`, inline_align\: :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` = 5, baseline\: :ref:`float<class_float>` = 0.0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_resize_object>`
  2199. Sets new size and alignment of embedded object.
  2200. .. rst-class:: classref-item-separator
  2201. ----
  2202. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2203. .. rst-class:: classref-method
  2204. |void| **shaped_text_set_bidi_override**\ (\ shaped\: :ref:`RID<class_RID>`, override\: :ref:`Array<class_Array>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_bidi_override>`
  2205. Overrides BiDi for the structured text.
  2206. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2207. .. rst-class:: classref-item-separator
  2208. ----
  2209. .. _class_TextServer_method_shaped_text_set_custom_ellipsis:
  2210. .. rst-class:: classref-method
  2211. |void| **shaped_text_set_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`, char\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_custom_ellipsis>`
  2212. Sets ellipsis character used for text clipping.
  2213. .. rst-class:: classref-item-separator
  2214. ----
  2215. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2216. .. rst-class:: classref-method
  2217. |void| **shaped_text_set_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`, punct\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_custom_punctuation>`
  2218. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2219. .. rst-class:: classref-item-separator
  2220. ----
  2221. .. _class_TextServer_method_shaped_text_set_direction:
  2222. .. rst-class:: classref-method
  2223. |void| **shaped_text_set_direction**\ (\ shaped\: :ref:`RID<class_RID>`, direction\: :ref:`Direction<enum_TextServer_Direction>` = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_direction>`
  2224. Sets desired text direction. If set to :ref:`DIRECTION_AUTO<class_TextServer_constant_DIRECTION_AUTO>`, direction will be detected based on the buffer contents and current locale.
  2225. \ **Note:** Direction is ignored if server does not support :ref:`FEATURE_BIDI_LAYOUT<class_TextServer_constant_FEATURE_BIDI_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2226. .. rst-class:: classref-item-separator
  2227. ----
  2228. .. _class_TextServer_method_shaped_text_set_orientation:
  2229. .. rst-class:: classref-method
  2230. |void| **shaped_text_set_orientation**\ (\ shaped\: :ref:`RID<class_RID>`, orientation\: :ref:`Orientation<enum_TextServer_Orientation>` = 0\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_orientation>`
  2231. Sets desired text orientation.
  2232. \ **Note:** Orientation is ignored if server does not support :ref:`FEATURE_VERTICAL_LAYOUT<class_TextServer_constant_FEATURE_VERTICAL_LAYOUT>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2233. .. rst-class:: classref-item-separator
  2234. ----
  2235. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2236. .. rst-class:: classref-method
  2237. |void| **shaped_text_set_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_preserve_control>`
  2238. If set to ``true`` text buffer will display control characters.
  2239. .. rst-class:: classref-item-separator
  2240. ----
  2241. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2242. .. rst-class:: classref-method
  2243. |void| **shaped_text_set_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`, enabled\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_preserve_invalid>`
  2244. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2245. .. rst-class:: classref-item-separator
  2246. ----
  2247. .. _class_TextServer_method_shaped_text_set_spacing:
  2248. .. rst-class:: classref-method
  2249. |void| **shaped_text_set_spacing**\ (\ shaped\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`, value\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_set_spacing>`
  2250. Sets extra spacing added between glyphs or lines in pixels.
  2251. .. rst-class:: classref-item-separator
  2252. ----
  2253. .. _class_TextServer_method_shaped_text_shape:
  2254. .. rst-class:: classref-method
  2255. :ref:`bool<class_bool>` **shaped_text_shape**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_shape>`
  2256. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2257. \ **Note:** It is not necessary to call this function manually, buffer will be shaped automatically as soon as any of its output data is requested.
  2258. .. rst-class:: classref-item-separator
  2259. ----
  2260. .. _class_TextServer_method_shaped_text_sort_logical:
  2261. .. rst-class:: classref-method
  2262. :ref:`Array<class_Array>`\[:ref:`Dictionary<class_Dictionary>`\] **shaped_text_sort_logical**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_sort_logical>`
  2263. Returns text glyphs in the logical order.
  2264. .. rst-class:: classref-item-separator
  2265. ----
  2266. .. _class_TextServer_method_shaped_text_substr:
  2267. .. rst-class:: classref-method
  2268. :ref:`RID<class_RID>` **shaped_text_substr**\ (\ shaped\: :ref:`RID<class_RID>`, start\: :ref:`int<class_int>`, length\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_substr>`
  2269. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2270. .. rst-class:: classref-item-separator
  2271. ----
  2272. .. _class_TextServer_method_shaped_text_tab_align:
  2273. .. rst-class:: classref-method
  2274. :ref:`float<class_float>` **shaped_text_tab_align**\ (\ shaped\: :ref:`RID<class_RID>`, tab_stops\: :ref:`PackedFloat32Array<class_PackedFloat32Array>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_tab_align>`
  2275. Aligns shaped text to the given tab-stops.
  2276. .. rst-class:: classref-item-separator
  2277. ----
  2278. .. _class_TextServer_method_spoof_check:
  2279. .. rst-class:: classref-method
  2280. :ref:`bool<class_bool>` **spoof_check**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_spoof_check>`
  2281. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2282. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2283. .. rst-class:: classref-item-separator
  2284. ----
  2285. .. _class_TextServer_method_string_get_character_breaks:
  2286. .. rst-class:: classref-method
  2287. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_character_breaks**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_get_character_breaks>`
  2288. Returns array of the composite character boundaries.
  2289. ::
  2290. var ts = TextServerManager.get_primary_interface()
  2291. print(ts.string_get_word_breaks("Test โค๏ธโ€๐Ÿ”ฅ Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2292. .. rst-class:: classref-item-separator
  2293. ----
  2294. .. _class_TextServer_method_string_get_word_breaks:
  2295. .. rst-class:: classref-method
  2296. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_word_breaks**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = "", chars_per_line\: :ref:`int<class_int>` = 0\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_get_word_breaks>`
  2297. Returns an array of the word break boundaries. Elements in the returned array are the offsets of the start and end of words. Therefore the length of the array is always even.
  2298. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2299. ::
  2300. var ts = TextServerManager.get_primary_interface()
  2301. print(ts.string_get_word_breaks("The Godot Engine, 4")) # Prints [0, 3, 4, 9, 10, 16, 18, 19], which corresponds to the following substrings: "The", "Godot", "Engine", "4"
  2302. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 5)) # Prints [0, 3, 4, 9, 10, 15, 15, 19], which corresponds to the following substrings: "The", "Godot", "Engin", "e, 4"
  2303. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 10)) # Prints [0, 9, 10, 19], which corresponds to the following substrings: "The Godot", "Engine, 4"
  2304. .. rst-class:: classref-item-separator
  2305. ----
  2306. .. _class_TextServer_method_string_to_lower:
  2307. .. rst-class:: classref-method
  2308. :ref:`String<class_String>` **string_to_lower**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_to_lower>`
  2309. Returns the string converted to lowercase.
  2310. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2311. \ **Note:** The result may be longer or shorter than the original.
  2312. .. rst-class:: classref-item-separator
  2313. ----
  2314. .. _class_TextServer_method_string_to_title:
  2315. .. rst-class:: classref-method
  2316. :ref:`String<class_String>` **string_to_title**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_to_title>`
  2317. Returns the string converted to title case.
  2318. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2319. \ **Note:** The result may be longer or shorter than the original.
  2320. .. rst-class:: classref-item-separator
  2321. ----
  2322. .. _class_TextServer_method_string_to_upper:
  2323. .. rst-class:: classref-method
  2324. :ref:`String<class_String>` **string_to_upper**\ (\ string\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_string_to_upper>`
  2325. Returns the string converted to uppercase.
  2326. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2327. \ **Note:** The result may be longer or shorter than the original.
  2328. .. rst-class:: classref-item-separator
  2329. ----
  2330. .. _class_TextServer_method_strip_diacritics:
  2331. .. rst-class:: classref-method
  2332. :ref:`String<class_String>` **strip_diacritics**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_strip_diacritics>`
  2333. Strips diacritics from the string.
  2334. \ **Note:** The result may be longer or shorter than the original.
  2335. .. rst-class:: classref-item-separator
  2336. ----
  2337. .. _class_TextServer_method_tag_to_name:
  2338. .. rst-class:: classref-method
  2339. :ref:`String<class_String>` **tag_to_name**\ (\ tag\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_tag_to_name>`
  2340. Converts OpenType tag to readable feature, variation, script, or language name.
  2341. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2342. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2343. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2344. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2345. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2346. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2347. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2348. .. |void| replace:: :abbr:`void (No return value.)`