class_textserver.rst 331 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320
  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/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/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:`bool<class_bool>` | :ref:`font_get_keep_rounding_remainders<class_TextServer_method_font_get_keep_rounding_remainders>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  98. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :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| |
  100. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :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| |
  102. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :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>`\ ) |
  104. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  106. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :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| |
  108. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  110. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  112. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :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| |
  114. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :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| |
  116. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  118. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :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| |
  120. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :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>`\ ) |
  122. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  124. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :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| |
  126. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :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| |
  128. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  130. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] | :ref:`font_get_style<class_TextServer_method_font_get_style>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  132. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  134. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  136. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  138. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_supported_glyphs<class_TextServer_method_font_get_supported_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  140. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :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| |
  142. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :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| |
  144. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :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| |
  146. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  148. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :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| |
  150. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :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| |
  152. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  154. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  156. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :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| |
  158. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :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| |
  160. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  162. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :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| |
  164. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :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| |
  166. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | :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| |
  168. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |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>`\ ) |
  170. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |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>`\ ) |
  172. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |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>`\ ) |
  174. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |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>`\ ) |
  176. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |void| | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  178. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |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>`\ ) |
  180. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |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>`\ ) |
  182. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |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>`\ ) |
  184. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |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>`\ ) |
  186. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |void| | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>`\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) |
  188. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |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>`\ ) |
  190. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |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>`\ ) |
  192. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |void| | :ref:`font_set_data<class_TextServer_method_font_set_data>`\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  194. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |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>`\ ) |
  196. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |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>`\ ) |
  198. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |void| | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>`\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) |
  200. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |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>`\ ) |
  202. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |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>`\ ) |
  204. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |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>`\ ) |
  206. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |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>`\ ) |
  208. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |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>`\ ) |
  210. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |void| | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>`\ (\ oversampling\: :ref:`float<class_float>`\ ) |
  212. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |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>`\ ) |
  214. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |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>`\ ) |
  216. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |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>`\ ) |
  218. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |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>`\ ) |
  220. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |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>`\ ) |
  222. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |void| | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>`\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) |
  224. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |void| | :ref:`font_set_keep_rounding_remainders<class_TextServer_method_font_set_keep_rounding_remainders>`\ (\ font_rid\: :ref:`RID<class_RID>`, keep_rounding_remainders\: :ref:`bool<class_bool>`\ ) |
  226. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |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>`\ ) |
  228. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |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>`\ ) |
  230. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |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>`\ ) |
  232. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |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>`\ ) |
  234. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |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>`\ ) |
  236. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | |void| | :ref:`font_set_name<class_TextServer_method_font_set_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  238. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |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>`\ ) |
  240. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |void| | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) |
  242. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |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>`\ ) |
  244. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |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>`\ ) |
  246. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |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>`\ ) |
  248. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  250. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |void| | :ref:`font_set_style<class_TextServer_method_font_set_style>`\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) |
  252. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |void| | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  254. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |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>`\ ) |
  256. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |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>`\ ) |
  258. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |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>`\ ) |
  260. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |void| | :ref:`font_set_transform<class_TextServer_method_font_set_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  262. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |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>`\ ) |
  264. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |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>`\ ) |
  266. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | |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>`\ ) |
  268. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | |void| | :ref:`font_set_weight<class_TextServer_method_font_set_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  270. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  272. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  274. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  276. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | |void| | :ref:`free_rid<class_TextServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  278. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>`\ (\ ) |const| |
  280. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :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| |
  282. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>`\ (\ ) |const| |
  284. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`get_support_data<class_TextServer_method_get_support_data>`\ (\ ) |const| |
  286. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>`\ (\ ) |const| |
  288. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>`\ (\ ) |const| |
  290. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  292. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| |
  294. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>`\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| |
  296. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>`\ (\ locale\: :ref:`String<class_String>`\ ) |const| |
  298. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  300. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`bool<class_bool>` | :ref:`is_valid_letter<class_TextServer_method_is_valid_letter>`\ (\ unicode\: :ref:`int<class_int>`\ ) |const| |
  302. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |
  304. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>`\ (\ name\: :ref:`String<class_String>`\ ) |const| |
  306. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  308. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :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| |
  310. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>`\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| |
  312. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |const| |
  314. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  316. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :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| |
  318. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | |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>` = {}\ ) |
  320. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | :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\ ) |
  322. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | :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\ ) |
  324. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |void| | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  326. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | :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| |
  328. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | |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| |
  330. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |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| |
  332. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | :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\ ) |
  334. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  336. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | :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| |
  338. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  340. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`int<class_int>` | :ref:`shaped_text_get_custom_ellipsis<class_TextServer_method_shaped_text_get_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  342. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  344. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  346. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  348. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :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| |
  350. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :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| |
  352. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :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| |
  354. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  356. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  358. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :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| |
  360. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :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| |
  362. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :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| |
  364. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :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| |
  366. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :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| |
  368. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :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| |
  370. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | :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| |
  372. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | :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| |
  374. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  376. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  378. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  380. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  382. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  384. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  386. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :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| |
  388. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  390. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :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| |
  392. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  394. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  396. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  398. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  400. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :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| |
  402. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  404. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :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| |
  406. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :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| |
  408. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  410. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :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| |
  412. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :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| |
  414. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | |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\ ) |
  416. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | :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| |
  418. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | :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| |
  420. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | :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\ ) |
  422. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | |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>`\ ) |
  424. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | |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>`\ ) |
  426. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | |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>`\ ) |
  428. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | |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\ ) |
  430. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | |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\ ) |
  432. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | |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>`\ ) |
  434. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | |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>`\ ) |
  436. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | |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>`\ ) |
  438. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  440. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :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>`\ ) |
  442. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :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| |
  444. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :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>`\ ) |
  446. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  448. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :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| |
  450. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | :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| |
  452. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | :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| |
  454. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | :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| |
  456. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | :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| |
  458. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  460. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>`\ (\ tag\: :ref:`int<class_int>`\ ) |const| |
  462. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. .. rst-class:: classref-section-separator
  464. ----
  465. .. rst-class:: classref-descriptions-group
  466. Enumerations
  467. ------------
  468. .. _enum_TextServer_FontAntialiasing:
  469. .. rst-class:: classref-enumeration
  470. enum **FontAntialiasing**: :ref:`๐Ÿ”—<enum_TextServer_FontAntialiasing>`
  471. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  472. .. rst-class:: classref-enumeration-constant
  473. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  474. Font glyphs are rasterized as 1-bit bitmaps.
  475. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  476. .. rst-class:: classref-enumeration-constant
  477. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  478. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  479. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  480. .. rst-class:: classref-enumeration-constant
  481. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  482. Font glyphs are rasterized for LCD screens.
  483. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  484. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  485. .. rst-class:: classref-item-separator
  486. ----
  487. .. _enum_TextServer_FontLCDSubpixelLayout:
  488. .. rst-class:: classref-enumeration
  489. enum **FontLCDSubpixelLayout**: :ref:`๐Ÿ”—<enum_TextServer_FontLCDSubpixelLayout>`
  490. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  491. .. rst-class:: classref-enumeration-constant
  492. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  493. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  494. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  495. .. rst-class:: classref-enumeration-constant
  496. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  497. Horizontal RGB subpixel layout.
  498. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  499. .. rst-class:: classref-enumeration-constant
  500. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  501. Horizontal BGR subpixel layout.
  502. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  503. .. rst-class:: classref-enumeration-constant
  504. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  505. Vertical RGB subpixel layout.
  506. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  507. .. rst-class:: classref-enumeration-constant
  508. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  509. Vertical BGR subpixel layout.
  510. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  511. .. rst-class:: classref-enumeration-constant
  512. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  513. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  514. .. rst-class:: classref-item-separator
  515. ----
  516. .. _enum_TextServer_Direction:
  517. .. rst-class:: classref-enumeration
  518. enum **Direction**: :ref:`๐Ÿ”—<enum_TextServer_Direction>`
  519. .. _class_TextServer_constant_DIRECTION_AUTO:
  520. .. rst-class:: classref-enumeration-constant
  521. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  522. Text direction is determined based on contents and current locale.
  523. .. _class_TextServer_constant_DIRECTION_LTR:
  524. .. rst-class:: classref-enumeration-constant
  525. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  526. Text is written from left to right.
  527. .. _class_TextServer_constant_DIRECTION_RTL:
  528. .. rst-class:: classref-enumeration-constant
  529. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  530. Text is written from right to left.
  531. .. _class_TextServer_constant_DIRECTION_INHERITED:
  532. .. rst-class:: classref-enumeration-constant
  533. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  534. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  535. .. rst-class:: classref-item-separator
  536. ----
  537. .. _enum_TextServer_Orientation:
  538. .. rst-class:: classref-enumeration
  539. enum **Orientation**: :ref:`๐Ÿ”—<enum_TextServer_Orientation>`
  540. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  541. .. rst-class:: classref-enumeration-constant
  542. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  543. Text is written horizontally.
  544. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  545. .. rst-class:: classref-enumeration-constant
  546. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  547. Left to right text is written vertically from top to bottom.
  548. Right to left text is written vertically from bottom to top.
  549. .. rst-class:: classref-item-separator
  550. ----
  551. .. _enum_TextServer_JustificationFlag:
  552. .. rst-class:: classref-enumeration
  553. flags **JustificationFlag**: :ref:`๐Ÿ”—<enum_TextServer_JustificationFlag>`
  554. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  557. Do not justify text.
  558. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  559. .. rst-class:: classref-enumeration-constant
  560. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  561. Justify text by adding and removing kashidas.
  562. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  563. .. rst-class:: classref-enumeration-constant
  564. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  565. Justify text by changing width of the spaces between the words.
  566. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  567. .. rst-class:: classref-enumeration-constant
  568. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  569. Remove trailing and leading spaces from the justified text.
  570. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  571. .. rst-class:: classref-enumeration-constant
  572. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  573. Only apply justification to the part of the text after the last tab.
  574. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  575. .. rst-class:: classref-enumeration-constant
  576. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  577. Apply justification to the trimmed line with ellipsis.
  578. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  579. .. rst-class:: classref-enumeration-constant
  580. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  581. Do not apply justification to the last line of the paragraph.
  582. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  583. .. rst-class:: classref-enumeration-constant
  584. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  585. 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>`).
  586. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  587. .. rst-class:: classref-enumeration-constant
  588. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  589. 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).
  590. .. rst-class:: classref-item-separator
  591. ----
  592. .. _enum_TextServer_AutowrapMode:
  593. .. rst-class:: classref-enumeration
  594. enum **AutowrapMode**: :ref:`๐Ÿ”—<enum_TextServer_AutowrapMode>`
  595. .. _class_TextServer_constant_AUTOWRAP_OFF:
  596. .. rst-class:: classref-enumeration-constant
  597. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  598. Autowrap is disabled.
  599. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  600. .. rst-class:: classref-enumeration-constant
  601. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  602. 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.
  603. .. _class_TextServer_constant_AUTOWRAP_WORD:
  604. .. rst-class:: classref-enumeration-constant
  605. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  606. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  607. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  608. .. rst-class:: classref-enumeration-constant
  609. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  610. 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.
  611. .. rst-class:: classref-item-separator
  612. ----
  613. .. _enum_TextServer_LineBreakFlag:
  614. .. rst-class:: classref-enumeration
  615. flags **LineBreakFlag**: :ref:`๐Ÿ”—<enum_TextServer_LineBreakFlag>`
  616. .. _class_TextServer_constant_BREAK_NONE:
  617. .. rst-class:: classref-enumeration-constant
  618. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  619. Do not break the line.
  620. .. _class_TextServer_constant_BREAK_MANDATORY:
  621. .. rst-class:: classref-enumeration-constant
  622. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  623. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  624. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  625. .. rst-class:: classref-enumeration-constant
  626. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  627. Break the line between the words.
  628. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  629. .. rst-class:: classref-enumeration-constant
  630. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  631. Break the line between any unconnected graphemes.
  632. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  633. .. rst-class:: classref-enumeration-constant
  634. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  635. 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.
  636. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  637. .. rst-class:: classref-enumeration-constant
  638. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  639. Remove edge spaces from the broken line segments.
  640. .. _class_TextServer_constant_BREAK_TRIM_INDENT:
  641. .. rst-class:: classref-enumeration-constant
  642. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_INDENT** = ``32``
  643. Subtract first line indentation width from all lines after the first one.
  644. .. rst-class:: classref-item-separator
  645. ----
  646. .. _enum_TextServer_VisibleCharactersBehavior:
  647. .. rst-class:: classref-enumeration
  648. enum **VisibleCharactersBehavior**: :ref:`๐Ÿ”—<enum_TextServer_VisibleCharactersBehavior>`
  649. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  650. .. rst-class:: classref-enumeration-constant
  651. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  652. 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.
  653. \ **Note:** In this mode, trimmed text is not processed at all. It is not accounted for in line breaking and size calculations.
  654. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  655. .. rst-class:: classref-enumeration-constant
  656. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  657. 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.
  658. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  659. .. rst-class:: classref-enumeration-constant
  660. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  661. 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.
  662. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  663. .. rst-class:: classref-enumeration-constant
  664. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  665. 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.
  666. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  667. .. rst-class:: classref-enumeration-constant
  668. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  669. 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.
  670. .. rst-class:: classref-item-separator
  671. ----
  672. .. _enum_TextServer_OverrunBehavior:
  673. .. rst-class:: classref-enumeration
  674. enum **OverrunBehavior**: :ref:`๐Ÿ”—<enum_TextServer_OverrunBehavior>`
  675. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  676. .. rst-class:: classref-enumeration-constant
  677. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  678. No text trimming is performed.
  679. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  680. .. rst-class:: classref-enumeration-constant
  681. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  682. Trims the text per character.
  683. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  684. .. rst-class:: classref-enumeration-constant
  685. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  686. Trims the text per word.
  687. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  688. .. rst-class:: classref-enumeration-constant
  689. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  690. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  691. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  692. .. rst-class:: classref-enumeration-constant
  693. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  694. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  695. .. rst-class:: classref-item-separator
  696. ----
  697. .. _enum_TextServer_TextOverrunFlag:
  698. .. rst-class:: classref-enumeration
  699. flags **TextOverrunFlag**: :ref:`๐Ÿ”—<enum_TextServer_TextOverrunFlag>`
  700. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  701. .. rst-class:: classref-enumeration-constant
  702. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  703. No trimming is performed.
  704. .. _class_TextServer_constant_OVERRUN_TRIM:
  705. .. rst-class:: classref-enumeration-constant
  706. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  707. Trims the text when it exceeds the given width.
  708. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  709. .. rst-class:: classref-enumeration-constant
  710. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  711. Trims the text per word instead of per grapheme.
  712. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  713. .. rst-class:: classref-enumeration-constant
  714. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  715. Determines whether an ellipsis should be added at the end of the text.
  716. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  717. .. rst-class:: classref-enumeration-constant
  718. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  719. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  720. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  721. .. rst-class:: classref-enumeration-constant
  722. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  723. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  724. .. rst-class:: classref-item-separator
  725. ----
  726. .. _enum_TextServer_GraphemeFlag:
  727. .. rst-class:: classref-enumeration
  728. flags **GraphemeFlag**: :ref:`๐Ÿ”—<enum_TextServer_GraphemeFlag>`
  729. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  730. .. rst-class:: classref-enumeration-constant
  731. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  732. Grapheme is supported by the font, and can be drawn.
  733. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  734. .. rst-class:: classref-enumeration-constant
  735. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  736. Grapheme is part of right-to-left or bottom-to-top run.
  737. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  738. .. rst-class:: classref-enumeration-constant
  739. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  740. Grapheme is not part of source text, it was added by justification process.
  741. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  742. .. rst-class:: classref-enumeration-constant
  743. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  744. Grapheme is whitespace.
  745. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  746. .. rst-class:: classref-enumeration-constant
  747. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  748. Grapheme is mandatory break point (e.g. ``"\n"``).
  749. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  750. .. rst-class:: classref-enumeration-constant
  751. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  752. Grapheme is optional break point (e.g. space).
  753. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  754. .. rst-class:: classref-enumeration-constant
  755. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  756. Grapheme is the tabulation character.
  757. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  758. .. rst-class:: classref-enumeration-constant
  759. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  760. Grapheme is kashida.
  761. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  762. .. rst-class:: classref-enumeration-constant
  763. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  764. Grapheme is punctuation character.
  765. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  766. .. rst-class:: classref-enumeration-constant
  767. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  768. Grapheme is underscore character.
  769. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  770. .. rst-class:: classref-enumeration-constant
  771. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  772. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  773. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  774. .. rst-class:: classref-enumeration-constant
  775. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  776. It is safe to insert a U+0640 before this grapheme for elongation.
  777. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  778. .. rst-class:: classref-enumeration-constant
  779. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  780. Grapheme is an object replacement character for the embedded object.
  781. .. _class_TextServer_constant_GRAPHEME_IS_SOFT_HYPHEN:
  782. .. rst-class:: classref-enumeration-constant
  783. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SOFT_HYPHEN** = ``8192``
  784. Grapheme is a soft hyphen.
  785. .. rst-class:: classref-item-separator
  786. ----
  787. .. _enum_TextServer_Hinting:
  788. .. rst-class:: classref-enumeration
  789. enum **Hinting**: :ref:`๐Ÿ”—<enum_TextServer_Hinting>`
  790. .. _class_TextServer_constant_HINTING_NONE:
  791. .. rst-class:: classref-enumeration-constant
  792. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  793. Disables font hinting (smoother but less crisp).
  794. .. _class_TextServer_constant_HINTING_LIGHT:
  795. .. rst-class:: classref-enumeration-constant
  796. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  797. Use the light font hinting mode.
  798. .. _class_TextServer_constant_HINTING_NORMAL:
  799. .. rst-class:: classref-enumeration-constant
  800. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  801. Use the default font hinting mode (crisper but less smooth).
  802. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  803. .. rst-class:: classref-item-separator
  804. ----
  805. .. _enum_TextServer_SubpixelPositioning:
  806. .. rst-class:: classref-enumeration
  807. enum **SubpixelPositioning**: :ref:`๐Ÿ”—<enum_TextServer_SubpixelPositioning>`
  808. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  809. .. rst-class:: classref-enumeration-constant
  810. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  811. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  812. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  815. Glyph horizontal position is rounded based on font size.
  816. - 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>`.
  817. - 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>`.
  818. - To the whole pixel size for larger fonts.
  819. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  820. .. rst-class:: classref-enumeration-constant
  821. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  822. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  823. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  824. .. rst-class:: classref-enumeration-constant
  825. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  826. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  827. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  828. .. rst-class:: classref-enumeration-constant
  829. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  830. 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.
  831. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  832. .. rst-class:: classref-enumeration-constant
  833. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  834. 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.
  835. .. rst-class:: classref-item-separator
  836. ----
  837. .. _enum_TextServer_Feature:
  838. .. rst-class:: classref-enumeration
  839. enum **Feature**: :ref:`๐Ÿ”—<enum_TextServer_Feature>`
  840. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  841. .. rst-class:: classref-enumeration-constant
  842. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  843. TextServer supports simple text layouts.
  844. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  845. .. rst-class:: classref-enumeration-constant
  846. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  847. TextServer supports bidirectional text layouts.
  848. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  849. .. rst-class:: classref-enumeration-constant
  850. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  851. TextServer supports vertical layouts.
  852. .. _class_TextServer_constant_FEATURE_SHAPING:
  853. .. rst-class:: classref-enumeration-constant
  854. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  855. TextServer supports complex text shaping.
  856. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  857. .. rst-class:: classref-enumeration-constant
  858. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  859. TextServer supports justification using kashidas.
  860. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  861. .. rst-class:: classref-enumeration-constant
  862. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  863. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  864. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  865. .. rst-class:: classref-enumeration-constant
  866. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  867. TextServer supports loading bitmap fonts.
  868. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  869. .. rst-class:: classref-enumeration-constant
  870. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  871. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  872. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  873. .. rst-class:: classref-enumeration-constant
  874. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  875. TextServer supports multichannel signed distance field dynamic font rendering.
  876. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  877. .. rst-class:: classref-enumeration-constant
  878. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  879. TextServer supports loading system fonts.
  880. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  881. .. rst-class:: classref-enumeration-constant
  882. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  883. TextServer supports variable fonts.
  884. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  885. .. rst-class:: classref-enumeration-constant
  886. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  887. TextServer supports locale dependent and context sensitive case conversion.
  888. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  889. .. rst-class:: classref-enumeration-constant
  890. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  891. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  892. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  893. .. rst-class:: classref-enumeration-constant
  894. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  895. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  896. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  897. .. rst-class:: classref-enumeration-constant
  898. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  899. 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.
  900. .. rst-class:: classref-item-separator
  901. ----
  902. .. _enum_TextServer_ContourPointTag:
  903. .. rst-class:: classref-enumeration
  904. enum **ContourPointTag**: :ref:`๐Ÿ”—<enum_TextServer_ContourPointTag>`
  905. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  906. .. rst-class:: classref-enumeration-constant
  907. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  908. Contour point is on the curve.
  909. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  910. .. rst-class:: classref-enumeration-constant
  911. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  912. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bรฉzier arc.
  913. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  914. .. rst-class:: classref-enumeration-constant
  915. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  916. Contour point isn't on the curve, but serves as a control point for a cubic Bรฉzier arc.
  917. .. rst-class:: classref-item-separator
  918. ----
  919. .. _enum_TextServer_SpacingType:
  920. .. rst-class:: classref-enumeration
  921. enum **SpacingType**: :ref:`๐Ÿ”—<enum_TextServer_SpacingType>`
  922. .. _class_TextServer_constant_SPACING_GLYPH:
  923. .. rst-class:: classref-enumeration-constant
  924. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  925. Spacing for each glyph.
  926. .. _class_TextServer_constant_SPACING_SPACE:
  927. .. rst-class:: classref-enumeration-constant
  928. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  929. Spacing for the space character.
  930. .. _class_TextServer_constant_SPACING_TOP:
  931. .. rst-class:: classref-enumeration-constant
  932. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  933. Spacing at the top of the line.
  934. .. _class_TextServer_constant_SPACING_BOTTOM:
  935. .. rst-class:: classref-enumeration-constant
  936. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  937. Spacing at the bottom of the line.
  938. .. _class_TextServer_constant_SPACING_MAX:
  939. .. rst-class:: classref-enumeration-constant
  940. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  941. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  942. .. rst-class:: classref-item-separator
  943. ----
  944. .. _enum_TextServer_FontStyle:
  945. .. rst-class:: classref-enumeration
  946. flags **FontStyle**: :ref:`๐Ÿ”—<enum_TextServer_FontStyle>`
  947. .. _class_TextServer_constant_FONT_BOLD:
  948. .. rst-class:: classref-enumeration-constant
  949. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  950. Font is bold.
  951. .. _class_TextServer_constant_FONT_ITALIC:
  952. .. rst-class:: classref-enumeration-constant
  953. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  954. Font is italic or oblique.
  955. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  956. .. rst-class:: classref-enumeration-constant
  957. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  958. Font have fixed-width characters.
  959. .. rst-class:: classref-item-separator
  960. ----
  961. .. _enum_TextServer_StructuredTextParser:
  962. .. rst-class:: classref-enumeration
  963. enum **StructuredTextParser**: :ref:`๐Ÿ”—<enum_TextServer_StructuredTextParser>`
  964. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  965. .. rst-class:: classref-enumeration-constant
  966. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  967. Use default Unicode BiDi algorithm.
  968. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  969. .. rst-class:: classref-enumeration-constant
  970. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  971. BiDi override for URI.
  972. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  973. .. rst-class:: classref-enumeration-constant
  974. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  975. BiDi override for file path.
  976. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  977. .. rst-class:: classref-enumeration-constant
  978. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  979. BiDi override for email.
  980. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  981. .. rst-class:: classref-enumeration-constant
  982. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  983. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  984. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  985. .. rst-class:: classref-enumeration-constant
  986. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  987. BiDi override for GDScript.
  988. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  989. .. rst-class:: classref-enumeration-constant
  990. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  991. User defined structured text BiDi override function.
  992. .. rst-class:: classref-item-separator
  993. ----
  994. .. _enum_TextServer_FixedSizeScaleMode:
  995. .. rst-class:: classref-enumeration
  996. enum **FixedSizeScaleMode**: :ref:`๐Ÿ”—<enum_TextServer_FixedSizeScaleMode>`
  997. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  998. .. rst-class:: classref-enumeration-constant
  999. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  1000. Bitmap font is not scaled.
  1001. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  1002. .. rst-class:: classref-enumeration-constant
  1003. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  1004. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  1005. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  1006. .. rst-class:: classref-enumeration-constant
  1007. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  1008. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  1009. .. rst-class:: classref-section-separator
  1010. ----
  1011. .. rst-class:: classref-descriptions-group
  1012. Method Descriptions
  1013. -------------------
  1014. .. _class_TextServer_method_create_font:
  1015. .. rst-class:: classref-method
  1016. :ref:`RID<class_RID>` **create_font**\ (\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font>`
  1017. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  1018. .. rst-class:: classref-item-separator
  1019. ----
  1020. .. _class_TextServer_method_create_font_linked_variation:
  1021. .. rst-class:: classref-method
  1022. :ref:`RID<class_RID>` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font_linked_variation>`
  1023. 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.
  1024. .. rst-class:: classref-item-separator
  1025. ----
  1026. .. _class_TextServer_method_create_shaped_text:
  1027. .. rst-class:: classref-method
  1028. :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>`
  1029. 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.
  1030. \ **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>`).
  1031. \ **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>`).
  1032. .. rst-class:: classref-item-separator
  1033. ----
  1034. .. _class_TextServer_method_draw_hex_code_box:
  1035. .. rst-class:: classref-method
  1036. |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>`
  1037. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  1038. .. rst-class:: classref-item-separator
  1039. ----
  1040. .. _class_TextServer_method_font_clear_glyphs:
  1041. .. rst-class:: classref-method
  1042. |void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_glyphs>`
  1043. Removes all rendered glyph information from the cache entry.
  1044. \ **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.
  1045. .. rst-class:: classref-item-separator
  1046. ----
  1047. .. _class_TextServer_method_font_clear_kerning_map:
  1048. .. rst-class:: classref-method
  1049. |void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_kerning_map>`
  1050. Removes all kerning overrides.
  1051. .. rst-class:: classref-item-separator
  1052. ----
  1053. .. _class_TextServer_method_font_clear_size_cache:
  1054. .. rst-class:: classref-method
  1055. |void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_size_cache>`
  1056. Removes all font sizes from the cache entry.
  1057. .. rst-class:: classref-item-separator
  1058. ----
  1059. .. _class_TextServer_method_font_clear_textures:
  1060. .. rst-class:: classref-method
  1061. |void| **font_clear_textures**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_textures>`
  1062. Removes all textures from font cache entry.
  1063. \ **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.
  1064. .. rst-class:: classref-item-separator
  1065. ----
  1066. .. _class_TextServer_method_font_draw_glyph:
  1067. .. rst-class:: classref-method
  1068. |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>`
  1069. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1070. \ **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>`.
  1071. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1072. .. rst-class:: classref-item-separator
  1073. ----
  1074. .. _class_TextServer_method_font_draw_glyph_outline:
  1075. .. rst-class:: classref-method
  1076. |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>`
  1077. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1078. \ **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>`.
  1079. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1080. .. rst-class:: classref-item-separator
  1081. ----
  1082. .. _class_TextServer_method_font_get_antialiasing:
  1083. .. rst-class:: classref-method
  1084. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_antialiasing>`
  1085. Returns font anti-aliasing mode.
  1086. .. rst-class:: classref-item-separator
  1087. ----
  1088. .. _class_TextServer_method_font_get_ascent:
  1089. .. rst-class:: classref-method
  1090. :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>`
  1091. Returns the font ascent (number of pixels above the baseline).
  1092. .. rst-class:: classref-item-separator
  1093. ----
  1094. .. _class_TextServer_method_font_get_baseline_offset:
  1095. .. rst-class:: classref-method
  1096. :ref:`float<class_float>` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_baseline_offset>`
  1097. Returns extra baseline offset (as a fraction of font height).
  1098. .. rst-class:: classref-item-separator
  1099. ----
  1100. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1101. .. rst-class:: classref-method
  1102. :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>`
  1103. 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>`.
  1104. .. rst-class:: classref-item-separator
  1105. ----
  1106. .. _class_TextServer_method_font_get_descent:
  1107. .. rst-class:: classref-method
  1108. :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>`
  1109. Returns the font descent (number of pixels below the baseline).
  1110. .. rst-class:: classref-item-separator
  1111. ----
  1112. .. _class_TextServer_method_font_get_disable_embedded_bitmaps:
  1113. .. rst-class:: classref-method
  1114. :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>`
  1115. Returns whether the font's embedded bitmap loading is disabled.
  1116. .. rst-class:: classref-item-separator
  1117. ----
  1118. .. _class_TextServer_method_font_get_embolden:
  1119. .. rst-class:: classref-method
  1120. :ref:`float<class_float>` **font_get_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_embolden>`
  1121. Returns font embolden strength.
  1122. .. rst-class:: classref-item-separator
  1123. ----
  1124. .. _class_TextServer_method_font_get_face_count:
  1125. .. rst-class:: classref-method
  1126. :ref:`int<class_int>` **font_get_face_count**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_count>`
  1127. Returns number of faces in the TrueType / OpenType collection.
  1128. .. rst-class:: classref-item-separator
  1129. ----
  1130. .. _class_TextServer_method_font_get_face_index:
  1131. .. rst-class:: classref-method
  1132. :ref:`int<class_int>` **font_get_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_index>`
  1133. Returns an active face index in the TrueType / OpenType collection.
  1134. .. rst-class:: classref-item-separator
  1135. ----
  1136. .. _class_TextServer_method_font_get_fixed_size:
  1137. .. rst-class:: classref-method
  1138. :ref:`int<class_int>` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size>`
  1139. Returns bitmap font fixed size.
  1140. .. rst-class:: classref-item-separator
  1141. ----
  1142. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1143. .. rst-class:: classref-method
  1144. :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>`
  1145. Returns bitmap font scaling mode.
  1146. .. rst-class:: classref-item-separator
  1147. ----
  1148. .. _class_TextServer_method_font_get_generate_mipmaps:
  1149. .. rst-class:: classref-method
  1150. :ref:`bool<class_bool>` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_generate_mipmaps>`
  1151. Returns ``true`` if font texture mipmap generation is enabled.
  1152. .. rst-class:: classref-item-separator
  1153. ----
  1154. .. _class_TextServer_method_font_get_global_oversampling:
  1155. .. rst-class:: classref-method
  1156. :ref:`float<class_float>` **font_get_global_oversampling**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_global_oversampling>`
  1157. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _class_TextServer_method_font_get_glyph_advance:
  1161. .. rst-class:: classref-method
  1162. :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>`
  1163. Returns glyph advance (offset of the next glyph).
  1164. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1165. .. rst-class:: classref-item-separator
  1166. ----
  1167. .. _class_TextServer_method_font_get_glyph_contours:
  1168. .. rst-class:: classref-method
  1169. :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>`
  1170. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1171. \ ``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.
  1172. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1173. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1174. - Two successive :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicate a line segment.
  1175. - One :ref:`CONTOUR_CURVE_TAG_OFF_CONIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC>` point between two :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicates a single conic (quadratic) Bรฉzier arc.
  1176. - Two :ref:`CONTOUR_CURVE_TAG_OFF_CUBIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC>` points between two :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicate a single cubic Bรฉzier arc.
  1177. - Two successive :ref:`CONTOUR_CURVE_TAG_OFF_CONIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC>` points indicate two successive conic (quadratic) Bรฉzier arcs with a virtual :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` point at their middle.
  1178. - Each contour is closed. The last point of a contour uses the first point of a contour as its next point, and vice versa. The first point can be :ref:`CONTOUR_CURVE_TAG_OFF_CONIC<class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC>` point.
  1179. .. rst-class:: classref-item-separator
  1180. ----
  1181. .. _class_TextServer_method_font_get_glyph_index:
  1182. .. rst-class:: classref-method
  1183. :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>`
  1184. 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>`.
  1185. .. rst-class:: classref-item-separator
  1186. ----
  1187. .. _class_TextServer_method_font_get_glyph_list:
  1188. .. rst-class:: classref-method
  1189. :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>`
  1190. Returns list of rendered glyphs in the cache entry.
  1191. .. rst-class:: classref-item-separator
  1192. ----
  1193. .. _class_TextServer_method_font_get_glyph_offset:
  1194. .. rst-class:: classref-method
  1195. :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>`
  1196. Returns glyph offset from the baseline.
  1197. .. rst-class:: classref-item-separator
  1198. ----
  1199. .. _class_TextServer_method_font_get_glyph_size:
  1200. .. rst-class:: classref-method
  1201. :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>`
  1202. Returns size of the glyph.
  1203. .. rst-class:: classref-item-separator
  1204. ----
  1205. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1206. .. rst-class:: classref-method
  1207. :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>`
  1208. Returns index of the cache texture containing the glyph.
  1209. .. rst-class:: classref-item-separator
  1210. ----
  1211. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1212. .. rst-class:: classref-method
  1213. :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>`
  1214. Returns resource ID of the cache texture containing the glyph.
  1215. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1216. .. rst-class:: classref-item-separator
  1217. ----
  1218. .. _class_TextServer_method_font_get_glyph_texture_size:
  1219. .. rst-class:: classref-method
  1220. :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>`
  1221. Returns size of the cache texture containing the glyph.
  1222. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1223. .. rst-class:: classref-item-separator
  1224. ----
  1225. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1226. .. rst-class:: classref-method
  1227. :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>`
  1228. Returns rectangle in the cache texture containing the glyph.
  1229. .. rst-class:: classref-item-separator
  1230. ----
  1231. .. _class_TextServer_method_font_get_hinting:
  1232. .. rst-class:: classref-method
  1233. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_hinting>`
  1234. Returns the font hinting mode. Used by dynamic fonts only.
  1235. .. rst-class:: classref-item-separator
  1236. ----
  1237. .. _class_TextServer_method_font_get_keep_rounding_remainders:
  1238. .. rst-class:: classref-method
  1239. :ref:`bool<class_bool>` **font_get_keep_rounding_remainders**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_keep_rounding_remainders>`
  1240. Returns glyph position rounding behavior. If set to ``true``, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.
  1241. .. rst-class:: classref-item-separator
  1242. ----
  1243. .. _class_TextServer_method_font_get_kerning:
  1244. .. rst-class:: classref-method
  1245. :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>`
  1246. Returns kerning for the pair of glyphs.
  1247. .. rst-class:: classref-item-separator
  1248. ----
  1249. .. _class_TextServer_method_font_get_kerning_list:
  1250. .. rst-class:: classref-method
  1251. :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>`
  1252. Returns list of the kerning overrides.
  1253. .. rst-class:: classref-item-separator
  1254. ----
  1255. .. _class_TextServer_method_font_get_language_support_override:
  1256. .. rst-class:: classref-method
  1257. :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>`
  1258. Returns ``true`` if support override is enabled for the ``language``.
  1259. .. rst-class:: classref-item-separator
  1260. ----
  1261. .. _class_TextServer_method_font_get_language_support_overrides:
  1262. .. rst-class:: classref-method
  1263. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_overrides>`
  1264. Returns list of language support overrides.
  1265. .. rst-class:: classref-item-separator
  1266. ----
  1267. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1268. .. rst-class:: classref-method
  1269. :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>`
  1270. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1271. .. rst-class:: classref-item-separator
  1272. ----
  1273. .. _class_TextServer_method_font_get_msdf_size:
  1274. .. rst-class:: classref-method
  1275. :ref:`int<class_int>` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_size>`
  1276. Returns source font size used to generate MSDF textures.
  1277. .. rst-class:: classref-item-separator
  1278. ----
  1279. .. _class_TextServer_method_font_get_name:
  1280. .. rst-class:: classref-method
  1281. :ref:`String<class_String>` **font_get_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_name>`
  1282. Returns font family name.
  1283. .. rst-class:: classref-item-separator
  1284. ----
  1285. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1286. .. rst-class:: classref-method
  1287. :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>`
  1288. Returns font OpenType feature set override.
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _class_TextServer_method_font_get_ot_name_strings:
  1292. .. rst-class:: classref-method
  1293. :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>`
  1294. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1295. .. rst-class:: classref-item-separator
  1296. ----
  1297. .. _class_TextServer_method_font_get_oversampling:
  1298. .. rst-class:: classref-method
  1299. :ref:`float<class_float>` **font_get_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_oversampling>`
  1300. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1301. .. rst-class:: classref-item-separator
  1302. ----
  1303. .. _class_TextServer_method_font_get_scale:
  1304. .. rst-class:: classref-method
  1305. :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>`
  1306. Returns scaling factor of the color bitmap font.
  1307. .. rst-class:: classref-item-separator
  1308. ----
  1309. .. _class_TextServer_method_font_get_script_support_override:
  1310. .. rst-class:: classref-method
  1311. :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>`
  1312. Returns ``true`` if support override is enabled for the ``script``.
  1313. .. rst-class:: classref-item-separator
  1314. ----
  1315. .. _class_TextServer_method_font_get_script_support_overrides:
  1316. .. rst-class:: classref-method
  1317. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_overrides>`
  1318. Returns list of script support overrides.
  1319. .. rst-class:: classref-item-separator
  1320. ----
  1321. .. _class_TextServer_method_font_get_size_cache_list:
  1322. .. rst-class:: classref-method
  1323. :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>`
  1324. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1325. .. rst-class:: classref-item-separator
  1326. ----
  1327. .. _class_TextServer_method_font_get_spacing:
  1328. .. rst-class:: classref-method
  1329. :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>`
  1330. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1331. .. rst-class:: classref-item-separator
  1332. ----
  1333. .. _class_TextServer_method_font_get_stretch:
  1334. .. rst-class:: classref-method
  1335. :ref:`int<class_int>` **font_get_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_stretch>`
  1336. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1337. .. rst-class:: classref-item-separator
  1338. ----
  1339. .. _class_TextServer_method_font_get_style:
  1340. .. rst-class:: classref-method
  1341. |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **font_get_style**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style>`
  1342. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1343. .. rst-class:: classref-item-separator
  1344. ----
  1345. .. _class_TextServer_method_font_get_style_name:
  1346. .. rst-class:: classref-method
  1347. :ref:`String<class_String>` **font_get_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style_name>`
  1348. Returns font style name.
  1349. .. rst-class:: classref-item-separator
  1350. ----
  1351. .. _class_TextServer_method_font_get_subpixel_positioning:
  1352. .. rst-class:: classref-method
  1353. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_subpixel_positioning>`
  1354. Returns font subpixel glyph positioning mode.
  1355. .. rst-class:: classref-item-separator
  1356. ----
  1357. .. _class_TextServer_method_font_get_supported_chars:
  1358. .. rst-class:: classref-method
  1359. :ref:`String<class_String>` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_chars>`
  1360. Returns a string containing all the characters available in the font.
  1361. .. rst-class:: classref-item-separator
  1362. ----
  1363. .. _class_TextServer_method_font_get_supported_glyphs:
  1364. .. rst-class:: classref-method
  1365. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_supported_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_glyphs>`
  1366. Returns an array containing all glyph indices in the font.
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _class_TextServer_method_font_get_texture_count:
  1370. .. rst-class:: classref-method
  1371. :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>`
  1372. Returns number of textures used by font cache entry.
  1373. .. rst-class:: classref-item-separator
  1374. ----
  1375. .. _class_TextServer_method_font_get_texture_image:
  1376. .. rst-class:: classref-method
  1377. :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>`
  1378. Returns font cache texture image data.
  1379. .. rst-class:: classref-item-separator
  1380. ----
  1381. .. _class_TextServer_method_font_get_texture_offsets:
  1382. .. rst-class:: classref-method
  1383. :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>`
  1384. Returns array containing glyph packing data.
  1385. .. rst-class:: classref-item-separator
  1386. ----
  1387. .. _class_TextServer_method_font_get_transform:
  1388. .. rst-class:: classref-method
  1389. :ref:`Transform2D<class_Transform2D>` **font_get_transform**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_transform>`
  1390. Returns 2D transform applied to the font outlines.
  1391. .. rst-class:: classref-item-separator
  1392. ----
  1393. .. _class_TextServer_method_font_get_underline_position:
  1394. .. rst-class:: classref-method
  1395. :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>`
  1396. Returns pixel offset of the underline below the baseline.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _class_TextServer_method_font_get_underline_thickness:
  1400. .. rst-class:: classref-method
  1401. :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>`
  1402. Returns thickness of the underline in pixels.
  1403. .. rst-class:: classref-item-separator
  1404. ----
  1405. .. _class_TextServer_method_font_get_variation_coordinates:
  1406. .. rst-class:: classref-method
  1407. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_variation_coordinates>`
  1408. 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.
  1409. .. rst-class:: classref-item-separator
  1410. ----
  1411. .. _class_TextServer_method_font_get_weight:
  1412. .. rst-class:: classref-method
  1413. :ref:`int<class_int>` **font_get_weight**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_weight>`
  1414. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1415. .. rst-class:: classref-item-separator
  1416. ----
  1417. .. _class_TextServer_method_font_has_char:
  1418. .. rst-class:: classref-method
  1419. :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>`
  1420. Returns ``true`` if a Unicode ``char`` is available in the font.
  1421. .. rst-class:: classref-item-separator
  1422. ----
  1423. .. _class_TextServer_method_font_is_allow_system_fallback:
  1424. .. rst-class:: classref-method
  1425. :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>`
  1426. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1427. .. rst-class:: classref-item-separator
  1428. ----
  1429. .. _class_TextServer_method_font_is_force_autohinter:
  1430. .. rst-class:: classref-method
  1431. :ref:`bool<class_bool>` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_force_autohinter>`
  1432. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1433. .. rst-class:: classref-item-separator
  1434. ----
  1435. .. _class_TextServer_method_font_is_language_supported:
  1436. .. rst-class:: classref-method
  1437. :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>`
  1438. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1439. .. rst-class:: classref-item-separator
  1440. ----
  1441. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1442. .. rst-class:: classref-method
  1443. :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>`
  1444. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1445. .. rst-class:: classref-item-separator
  1446. ----
  1447. .. _class_TextServer_method_font_is_script_supported:
  1448. .. rst-class:: classref-method
  1449. :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>`
  1450. Returns ``true``, if font supports given script (ISO 15924 code).
  1451. .. rst-class:: classref-item-separator
  1452. ----
  1453. .. _class_TextServer_method_font_remove_glyph:
  1454. .. rst-class:: classref-method
  1455. |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>`
  1456. Removes specified rendered glyph information from the cache entry.
  1457. \ **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.
  1458. .. rst-class:: classref-item-separator
  1459. ----
  1460. .. _class_TextServer_method_font_remove_kerning:
  1461. .. rst-class:: classref-method
  1462. |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>`
  1463. Removes kerning override for the pair of glyphs.
  1464. .. rst-class:: classref-item-separator
  1465. ----
  1466. .. _class_TextServer_method_font_remove_language_support_override:
  1467. .. rst-class:: classref-method
  1468. |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>`
  1469. Remove language support override.
  1470. .. rst-class:: classref-item-separator
  1471. ----
  1472. .. _class_TextServer_method_font_remove_script_support_override:
  1473. .. rst-class:: classref-method
  1474. |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>`
  1475. Removes script support override.
  1476. .. rst-class:: classref-item-separator
  1477. ----
  1478. .. _class_TextServer_method_font_remove_size_cache:
  1479. .. rst-class:: classref-method
  1480. |void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_size_cache>`
  1481. Removes specified font size from the cache entry.
  1482. .. rst-class:: classref-item-separator
  1483. ----
  1484. .. _class_TextServer_method_font_remove_texture:
  1485. .. rst-class:: classref-method
  1486. |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>`
  1487. Removes specified texture from the cache entry.
  1488. \ **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>`.
  1489. .. rst-class:: classref-item-separator
  1490. ----
  1491. .. _class_TextServer_method_font_render_glyph:
  1492. .. rst-class:: classref-method
  1493. |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>`
  1494. Renders specified glyph to the font cache texture.
  1495. .. rst-class:: classref-item-separator
  1496. ----
  1497. .. _class_TextServer_method_font_render_range:
  1498. .. rst-class:: classref-method
  1499. |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>`
  1500. Renders the range of characters to the font cache texture.
  1501. .. rst-class:: classref-item-separator
  1502. ----
  1503. .. _class_TextServer_method_font_set_allow_system_fallback:
  1504. .. rst-class:: classref-method
  1505. |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>`
  1506. If set to ``true``, system fonts can be automatically used as fallbacks.
  1507. .. rst-class:: classref-item-separator
  1508. ----
  1509. .. _class_TextServer_method_font_set_antialiasing:
  1510. .. rst-class:: classref-method
  1511. |void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_antialiasing>`
  1512. Sets font anti-aliasing mode.
  1513. .. rst-class:: classref-item-separator
  1514. ----
  1515. .. _class_TextServer_method_font_set_ascent:
  1516. .. rst-class:: classref-method
  1517. |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>`
  1518. Sets the font ascent (number of pixels above the baseline).
  1519. .. rst-class:: classref-item-separator
  1520. ----
  1521. .. _class_TextServer_method_font_set_baseline_offset:
  1522. .. rst-class:: classref-method
  1523. |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>`
  1524. Sets extra baseline offset (as a fraction of font height).
  1525. .. rst-class:: classref-item-separator
  1526. ----
  1527. .. _class_TextServer_method_font_set_data:
  1528. .. rst-class:: classref-method
  1529. |void| **font_set_data**\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_data>`
  1530. Sets font source data, e.g contents of the dynamic font source file.
  1531. .. rst-class:: classref-item-separator
  1532. ----
  1533. .. _class_TextServer_method_font_set_descent:
  1534. .. rst-class:: classref-method
  1535. |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>`
  1536. Sets the font descent (number of pixels below the baseline).
  1537. .. rst-class:: classref-item-separator
  1538. ----
  1539. .. _class_TextServer_method_font_set_disable_embedded_bitmaps:
  1540. .. rst-class:: classref-method
  1541. |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>`
  1542. If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
  1543. .. rst-class:: classref-item-separator
  1544. ----
  1545. .. _class_TextServer_method_font_set_embolden:
  1546. .. rst-class:: classref-method
  1547. |void| **font_set_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_embolden>`
  1548. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1549. .. rst-class:: classref-item-separator
  1550. ----
  1551. .. _class_TextServer_method_font_set_face_index:
  1552. .. rst-class:: classref-method
  1553. |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>`
  1554. Sets an active face index in the TrueType / OpenType collection.
  1555. .. rst-class:: classref-item-separator
  1556. ----
  1557. .. _class_TextServer_method_font_set_fixed_size:
  1558. .. rst-class:: classref-method
  1559. |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>`
  1560. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1561. .. rst-class:: classref-item-separator
  1562. ----
  1563. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1564. .. rst-class:: classref-method
  1565. |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>`
  1566. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1567. .. rst-class:: classref-item-separator
  1568. ----
  1569. .. _class_TextServer_method_font_set_force_autohinter:
  1570. .. rst-class:: classref-method
  1571. |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>`
  1572. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1573. .. rst-class:: classref-item-separator
  1574. ----
  1575. .. _class_TextServer_method_font_set_generate_mipmaps:
  1576. .. rst-class:: classref-method
  1577. |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>`
  1578. If set to ``true`` font texture mipmap generation is enabled.
  1579. .. rst-class:: classref-item-separator
  1580. ----
  1581. .. _class_TextServer_method_font_set_global_oversampling:
  1582. .. rst-class:: classref-method
  1583. |void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_global_oversampling>`
  1584. Sets oversampling factor, shared by all font in the TextServer.
  1585. \ **Note:** This value can be automatically changed by display server.
  1586. .. rst-class:: classref-item-separator
  1587. ----
  1588. .. _class_TextServer_method_font_set_glyph_advance:
  1589. .. rst-class:: classref-method
  1590. |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>`
  1591. Sets glyph advance (offset of the next glyph).
  1592. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1593. .. rst-class:: classref-item-separator
  1594. ----
  1595. .. _class_TextServer_method_font_set_glyph_offset:
  1596. .. rst-class:: classref-method
  1597. |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>`
  1598. Sets glyph offset from the baseline.
  1599. .. rst-class:: classref-item-separator
  1600. ----
  1601. .. _class_TextServer_method_font_set_glyph_size:
  1602. .. rst-class:: classref-method
  1603. |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>`
  1604. Sets size of the glyph.
  1605. .. rst-class:: classref-item-separator
  1606. ----
  1607. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1608. .. rst-class:: classref-method
  1609. |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>`
  1610. Sets index of the cache texture containing the glyph.
  1611. .. rst-class:: classref-item-separator
  1612. ----
  1613. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1614. .. rst-class:: classref-method
  1615. |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>`
  1616. Sets rectangle in the cache texture containing the glyph.
  1617. .. rst-class:: classref-item-separator
  1618. ----
  1619. .. _class_TextServer_method_font_set_hinting:
  1620. .. rst-class:: classref-method
  1621. |void| **font_set_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_hinting>`
  1622. Sets font hinting mode. Used by dynamic fonts only.
  1623. .. rst-class:: classref-item-separator
  1624. ----
  1625. .. _class_TextServer_method_font_set_keep_rounding_remainders:
  1626. .. rst-class:: classref-method
  1627. |void| **font_set_keep_rounding_remainders**\ (\ font_rid\: :ref:`RID<class_RID>`, keep_rounding_remainders\: :ref:`bool<class_bool>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_keep_rounding_remainders>`
  1628. Sets glyph position rounding behavior. If set to ``true``, when aligning glyphs to the pixel boundaries rounding remainders are accumulated to ensure more uniform glyph distribution. This setting has no effect if subpixel positioning is enabled.
  1629. .. rst-class:: classref-item-separator
  1630. ----
  1631. .. _class_TextServer_method_font_set_kerning:
  1632. .. rst-class:: classref-method
  1633. |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>`
  1634. Sets kerning for the pair of glyphs.
  1635. .. rst-class:: classref-item-separator
  1636. ----
  1637. .. _class_TextServer_method_font_set_language_support_override:
  1638. .. rst-class:: classref-method
  1639. |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>`
  1640. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1641. .. rst-class:: classref-item-separator
  1642. ----
  1643. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1644. .. rst-class:: classref-method
  1645. |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>`
  1646. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1647. .. rst-class:: classref-item-separator
  1648. ----
  1649. .. _class_TextServer_method_font_set_msdf_size:
  1650. .. rst-class:: classref-method
  1651. |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>`
  1652. Sets source font size used to generate MSDF textures.
  1653. .. rst-class:: classref-item-separator
  1654. ----
  1655. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1656. .. rst-class:: classref-method
  1657. |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>`
  1658. 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.
  1659. \ **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.
  1660. .. rst-class:: classref-item-separator
  1661. ----
  1662. .. _class_TextServer_method_font_set_name:
  1663. .. rst-class:: classref-method
  1664. |void| **font_set_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_name>`
  1665. Sets the font family name.
  1666. .. rst-class:: classref-item-separator
  1667. ----
  1668. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1669. .. rst-class:: classref-method
  1670. |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>`
  1671. Sets font OpenType feature set override.
  1672. .. rst-class:: classref-item-separator
  1673. ----
  1674. .. _class_TextServer_method_font_set_oversampling:
  1675. .. rst-class:: classref-method
  1676. |void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_oversampling>`
  1677. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1678. .. rst-class:: classref-item-separator
  1679. ----
  1680. .. _class_TextServer_method_font_set_scale:
  1681. .. rst-class:: classref-method
  1682. |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>`
  1683. Sets scaling factor of the color bitmap font.
  1684. .. rst-class:: classref-item-separator
  1685. ----
  1686. .. _class_TextServer_method_font_set_script_support_override:
  1687. .. rst-class:: classref-method
  1688. |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>`
  1689. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1690. .. rst-class:: classref-item-separator
  1691. ----
  1692. .. _class_TextServer_method_font_set_spacing:
  1693. .. rst-class:: classref-method
  1694. |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>`
  1695. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1696. .. rst-class:: classref-item-separator
  1697. ----
  1698. .. _class_TextServer_method_font_set_stretch:
  1699. .. rst-class:: classref-method
  1700. |void| **font_set_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_stretch>`
  1701. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1702. \ **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.
  1703. .. rst-class:: classref-item-separator
  1704. ----
  1705. .. _class_TextServer_method_font_set_style:
  1706. .. rst-class:: classref-method
  1707. |void| **font_set_style**\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style>`
  1708. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1709. \ **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.
  1710. .. rst-class:: classref-item-separator
  1711. ----
  1712. .. _class_TextServer_method_font_set_style_name:
  1713. .. rst-class:: classref-method
  1714. |void| **font_set_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style_name>`
  1715. Sets the font style name.
  1716. .. rst-class:: classref-item-separator
  1717. ----
  1718. .. _class_TextServer_method_font_set_subpixel_positioning:
  1719. .. rst-class:: classref-method
  1720. |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>`
  1721. Sets font subpixel glyph positioning mode.
  1722. .. rst-class:: classref-item-separator
  1723. ----
  1724. .. _class_TextServer_method_font_set_texture_image:
  1725. .. rst-class:: classref-method
  1726. |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>`
  1727. Sets font cache texture image data.
  1728. .. rst-class:: classref-item-separator
  1729. ----
  1730. .. _class_TextServer_method_font_set_texture_offsets:
  1731. .. rst-class:: classref-method
  1732. |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>`
  1733. Sets array containing glyph packing data.
  1734. .. rst-class:: classref-item-separator
  1735. ----
  1736. .. _class_TextServer_method_font_set_transform:
  1737. .. rst-class:: classref-method
  1738. |void| **font_set_transform**\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_transform>`
  1739. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
  1740. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1741. .. rst-class:: classref-item-separator
  1742. ----
  1743. .. _class_TextServer_method_font_set_underline_position:
  1744. .. rst-class:: classref-method
  1745. |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>`
  1746. Sets pixel offset of the underline below the baseline.
  1747. .. rst-class:: classref-item-separator
  1748. ----
  1749. .. _class_TextServer_method_font_set_underline_thickness:
  1750. .. rst-class:: classref-method
  1751. |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>`
  1752. Sets thickness of the underline in pixels.
  1753. .. rst-class:: classref-item-separator
  1754. ----
  1755. .. _class_TextServer_method_font_set_variation_coordinates:
  1756. .. rst-class:: classref-method
  1757. |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>`
  1758. 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.
  1759. .. rst-class:: classref-item-separator
  1760. ----
  1761. .. _class_TextServer_method_font_set_weight:
  1762. .. rst-class:: classref-method
  1763. |void| **font_set_weight**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_weight>`
  1764. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1765. \ **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.
  1766. .. rst-class:: classref-item-separator
  1767. ----
  1768. .. _class_TextServer_method_font_supported_feature_list:
  1769. .. rst-class:: classref-method
  1770. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_feature_list>`
  1771. Returns the dictionary of the supported OpenType features.
  1772. .. rst-class:: classref-item-separator
  1773. ----
  1774. .. _class_TextServer_method_font_supported_variation_list:
  1775. .. rst-class:: classref-method
  1776. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_variation_list>`
  1777. Returns the dictionary of the supported OpenType variation coordinates.
  1778. .. rst-class:: classref-item-separator
  1779. ----
  1780. .. _class_TextServer_method_format_number:
  1781. .. rst-class:: classref-method
  1782. :ref:`String<class_String>` **format_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_format_number>`
  1783. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1784. If ``language`` is omitted, the active locale will be used.
  1785. .. rst-class:: classref-item-separator
  1786. ----
  1787. .. _class_TextServer_method_free_rid:
  1788. .. rst-class:: classref-method
  1789. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_free_rid>`
  1790. Frees an object created by this **TextServer**.
  1791. .. rst-class:: classref-item-separator
  1792. ----
  1793. .. _class_TextServer_method_get_features:
  1794. .. rst-class:: classref-method
  1795. :ref:`int<class_int>` **get_features**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_features>`
  1796. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1797. .. rst-class:: classref-item-separator
  1798. ----
  1799. .. _class_TextServer_method_get_hex_code_box_size:
  1800. .. rst-class:: classref-method
  1801. :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>`
  1802. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1803. .. rst-class:: classref-item-separator
  1804. ----
  1805. .. _class_TextServer_method_get_name:
  1806. .. rst-class:: classref-method
  1807. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_name>`
  1808. Returns the name of the server interface.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_TextServer_method_get_support_data:
  1812. .. rst-class:: classref-method
  1813. :ref:`PackedByteArray<class_PackedByteArray>` **get_support_data**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data>`
  1814. Returns default TextServer database (e.g. ICU break iterators and dictionaries).
  1815. .. rst-class:: classref-item-separator
  1816. ----
  1817. .. _class_TextServer_method_get_support_data_filename:
  1818. .. rst-class:: classref-method
  1819. :ref:`String<class_String>` **get_support_data_filename**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_filename>`
  1820. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1821. .. rst-class:: classref-item-separator
  1822. ----
  1823. .. _class_TextServer_method_get_support_data_info:
  1824. .. rst-class:: classref-method
  1825. :ref:`String<class_String>` **get_support_data_info**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_info>`
  1826. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1827. .. rst-class:: classref-item-separator
  1828. ----
  1829. .. _class_TextServer_method_has:
  1830. .. rst-class:: classref-method
  1831. :ref:`bool<class_bool>` **has**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_has>`
  1832. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1833. .. rst-class:: classref-item-separator
  1834. ----
  1835. .. _class_TextServer_method_has_feature:
  1836. .. rst-class:: classref-method
  1837. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_has_feature>`
  1838. Returns ``true`` if the server supports a feature.
  1839. .. rst-class:: classref-item-separator
  1840. ----
  1841. .. _class_TextServer_method_is_confusable:
  1842. .. rst-class:: classref-method
  1843. :ref:`int<class_int>` **is_confusable**\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_confusable>`
  1844. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1845. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1846. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1847. .. rst-class:: classref-item-separator
  1848. ----
  1849. .. _class_TextServer_method_is_locale_right_to_left:
  1850. .. rst-class:: classref-method
  1851. :ref:`bool<class_bool>` **is_locale_right_to_left**\ (\ locale\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_locale_right_to_left>`
  1852. Returns ``true`` if locale is right-to-left.
  1853. .. rst-class:: classref-item-separator
  1854. ----
  1855. .. _class_TextServer_method_is_valid_identifier:
  1856. .. rst-class:: classref-method
  1857. :ref:`bool<class_bool>` **is_valid_identifier**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_identifier>`
  1858. Returns ``true`` if ``string`` is a valid identifier.
  1859. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1860. - Conform to normalization form C.
  1861. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1862. - May contain Unicode characters of class XID_Continue in the other positions.
  1863. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1864. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1865. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1866. - May contain Unicode characters of class XID_Continue in the other positions.
  1867. .. rst-class:: classref-item-separator
  1868. ----
  1869. .. _class_TextServer_method_is_valid_letter:
  1870. .. rst-class:: classref-method
  1871. :ref:`bool<class_bool>` **is_valid_letter**\ (\ unicode\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_letter>`
  1872. Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L".
  1873. .. rst-class:: classref-item-separator
  1874. ----
  1875. .. _class_TextServer_method_load_support_data:
  1876. .. rst-class:: classref-method
  1877. :ref:`bool<class_bool>` **load_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_load_support_data>`
  1878. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1879. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1880. .. rst-class:: classref-item-separator
  1881. ----
  1882. .. _class_TextServer_method_name_to_tag:
  1883. .. rst-class:: classref-method
  1884. :ref:`int<class_int>` **name_to_tag**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_name_to_tag>`
  1885. Converts readable feature, variation, script, or language name to OpenType tag.
  1886. .. rst-class:: classref-item-separator
  1887. ----
  1888. .. _class_TextServer_method_parse_number:
  1889. .. rst-class:: classref-method
  1890. :ref:`String<class_String>` **parse_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_number>`
  1891. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1892. .. rst-class:: classref-item-separator
  1893. ----
  1894. .. _class_TextServer_method_parse_structured_text:
  1895. .. rst-class:: classref-method
  1896. :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>`
  1897. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1898. .. rst-class:: classref-item-separator
  1899. ----
  1900. .. _class_TextServer_method_percent_sign:
  1901. .. rst-class:: classref-method
  1902. :ref:`String<class_String>` **percent_sign**\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_percent_sign>`
  1903. Returns percent sign used in the ``language``.
  1904. .. rst-class:: classref-item-separator
  1905. ----
  1906. .. _class_TextServer_method_save_support_data:
  1907. .. rst-class:: classref-method
  1908. :ref:`bool<class_bool>` **save_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_save_support_data>`
  1909. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1910. \ **Note:** This function is used by during project export, to include TextServer database.
  1911. .. rst-class:: classref-item-separator
  1912. ----
  1913. .. _class_TextServer_method_shaped_get_span_count:
  1914. .. rst-class:: classref-method
  1915. :ref:`int<class_int>` **shaped_get_span_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_count>`
  1916. 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>`.
  1917. .. rst-class:: classref-item-separator
  1918. ----
  1919. .. _class_TextServer_method_shaped_get_span_meta:
  1920. .. rst-class:: classref-method
  1921. :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>`
  1922. Returns text span metadata.
  1923. .. rst-class:: classref-item-separator
  1924. ----
  1925. .. _class_TextServer_method_shaped_set_span_update_font:
  1926. .. rst-class:: classref-method
  1927. |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>`
  1928. Changes text span font, font size, and OpenType features, without changing the text.
  1929. .. rst-class:: classref-item-separator
  1930. ----
  1931. .. _class_TextServer_method_shaped_text_add_object:
  1932. .. rst-class:: classref-method
  1933. :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>`
  1934. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1935. .. rst-class:: classref-item-separator
  1936. ----
  1937. .. _class_TextServer_method_shaped_text_add_string:
  1938. .. rst-class:: classref-method
  1939. :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>`
  1940. Adds text span and font to draw it to the text buffer.
  1941. .. rst-class:: classref-item-separator
  1942. ----
  1943. .. _class_TextServer_method_shaped_text_clear:
  1944. .. rst-class:: classref-method
  1945. |void| **shaped_text_clear**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_clear>`
  1946. Clears text buffer (removes text and inline objects).
  1947. .. rst-class:: classref-item-separator
  1948. ----
  1949. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1950. .. rst-class:: classref-method
  1951. :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>`
  1952. Returns composite character position closest to the ``pos``.
  1953. .. rst-class:: classref-item-separator
  1954. ----
  1955. .. _class_TextServer_method_shaped_text_draw:
  1956. .. rst-class:: classref-method
  1957. |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>`
  1958. 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).
  1959. .. rst-class:: classref-item-separator
  1960. ----
  1961. .. _class_TextServer_method_shaped_text_draw_outline:
  1962. .. rst-class:: classref-method
  1963. |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>`
  1964. 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).
  1965. .. rst-class:: classref-item-separator
  1966. ----
  1967. .. _class_TextServer_method_shaped_text_fit_to_width:
  1968. .. rst-class:: classref-method
  1969. :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>`
  1970. Adjusts text width to fit to specified width, returns new text width.
  1971. .. rst-class:: classref-item-separator
  1972. ----
  1973. .. _class_TextServer_method_shaped_text_get_ascent:
  1974. .. rst-class:: classref-method
  1975. :ref:`float<class_float>` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ascent>`
  1976. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1977. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1978. .. rst-class:: classref-item-separator
  1979. ----
  1980. .. _class_TextServer_method_shaped_text_get_carets:
  1981. .. rst-class:: classref-method
  1982. :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>`
  1983. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1984. .. rst-class:: classref-item-separator
  1985. ----
  1986. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1987. .. rst-class:: classref-method
  1988. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_character_breaks>`
  1989. Returns array of the composite character boundaries.
  1990. .. rst-class:: classref-item-separator
  1991. ----
  1992. .. _class_TextServer_method_shaped_text_get_custom_ellipsis:
  1993. .. rst-class:: classref-method
  1994. :ref:`int<class_int>` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_ellipsis>`
  1995. Returns ellipsis character used for text clipping.
  1996. .. rst-class:: classref-item-separator
  1997. ----
  1998. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1999. .. rst-class:: classref-method
  2000. :ref:`String<class_String>` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_punctuation>`
  2001. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2002. .. rst-class:: classref-item-separator
  2003. ----
  2004. .. _class_TextServer_method_shaped_text_get_descent:
  2005. .. rst-class:: classref-method
  2006. :ref:`float<class_float>` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_descent>`
  2007. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  2008. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  2009. .. rst-class:: classref-item-separator
  2010. ----
  2011. .. _class_TextServer_method_shaped_text_get_direction:
  2012. .. rst-class:: classref-method
  2013. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_direction>`
  2014. Returns direction of the text.
  2015. .. rst-class:: classref-item-separator
  2016. ----
  2017. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  2018. .. rst-class:: classref-method
  2019. :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>`
  2020. Returns dominant direction of in the range of text.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  2024. .. rst-class:: classref-method
  2025. :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>`
  2026. Returns number of glyphs in the ellipsis.
  2027. .. rst-class:: classref-item-separator
  2028. ----
  2029. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  2030. .. rst-class:: classref-method
  2031. :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>`
  2032. Returns array of the glyphs in the ellipsis.
  2033. .. rst-class:: classref-item-separator
  2034. ----
  2035. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  2036. .. rst-class:: classref-method
  2037. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_pos>`
  2038. Returns position of the ellipsis.
  2039. .. rst-class:: classref-item-separator
  2040. ----
  2041. .. _class_TextServer_method_shaped_text_get_glyph_count:
  2042. .. rst-class:: classref-method
  2043. :ref:`int<class_int>` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyph_count>`
  2044. Returns number of glyphs in the buffer.
  2045. .. rst-class:: classref-item-separator
  2046. ----
  2047. .. _class_TextServer_method_shaped_text_get_glyphs:
  2048. .. rst-class:: classref-method
  2049. :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>`
  2050. Returns an array of glyphs in the visual order.
  2051. .. rst-class:: classref-item-separator
  2052. ----
  2053. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  2054. .. rst-class:: classref-method
  2055. :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>`
  2056. Returns composite character's bounds as offsets from the start of the line.
  2057. .. rst-class:: classref-item-separator
  2058. ----
  2059. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  2060. .. rst-class:: classref-method
  2061. :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>`
  2062. Returns direction of the text, inferred by the BiDi algorithm.
  2063. .. rst-class:: classref-item-separator
  2064. ----
  2065. .. _class_TextServer_method_shaped_text_get_line_breaks:
  2066. .. rst-class:: classref-method
  2067. :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>`
  2068. Breaks text to the lines and returns character ranges for each line.
  2069. .. rst-class:: classref-item-separator
  2070. ----
  2071. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  2072. .. rst-class:: classref-method
  2073. :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>`
  2074. Breaks text to the lines and columns. Returns character ranges for each segment.
  2075. .. rst-class:: classref-item-separator
  2076. ----
  2077. .. _class_TextServer_method_shaped_text_get_object_glyph:
  2078. .. rst-class:: classref-method
  2079. :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>`
  2080. Returns the glyph index of the inline object.
  2081. .. rst-class:: classref-item-separator
  2082. ----
  2083. .. _class_TextServer_method_shaped_text_get_object_range:
  2084. .. rst-class:: classref-method
  2085. :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>`
  2086. Returns the character range of the inline object.
  2087. .. rst-class:: classref-item-separator
  2088. ----
  2089. .. _class_TextServer_method_shaped_text_get_object_rect:
  2090. .. rst-class:: classref-method
  2091. :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>`
  2092. Returns bounding rectangle of the inline object.
  2093. .. rst-class:: classref-item-separator
  2094. ----
  2095. .. _class_TextServer_method_shaped_text_get_objects:
  2096. .. rst-class:: classref-method
  2097. :ref:`Array<class_Array>` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_objects>`
  2098. Returns array of inline objects.
  2099. .. rst-class:: classref-item-separator
  2100. ----
  2101. .. _class_TextServer_method_shaped_text_get_orientation:
  2102. .. rst-class:: classref-method
  2103. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_orientation>`
  2104. Returns text orientation.
  2105. .. rst-class:: classref-item-separator
  2106. ----
  2107. .. _class_TextServer_method_shaped_text_get_parent:
  2108. .. rst-class:: classref-method
  2109. :ref:`RID<class_RID>` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_parent>`
  2110. Returns the parent buffer from which the substring originates.
  2111. .. rst-class:: classref-item-separator
  2112. ----
  2113. .. _class_TextServer_method_shaped_text_get_preserve_control:
  2114. .. rst-class:: classref-method
  2115. :ref:`bool<class_bool>` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_control>`
  2116. Returns ``true`` if text buffer is configured to display control characters.
  2117. .. rst-class:: classref-item-separator
  2118. ----
  2119. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  2120. .. rst-class:: classref-method
  2121. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_invalid>`
  2122. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2123. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_TextServer_method_shaped_text_get_range:
  2127. .. rst-class:: classref-method
  2128. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_range>`
  2129. Returns substring buffer character range in the parent buffer.
  2130. .. rst-class:: classref-item-separator
  2131. ----
  2132. .. _class_TextServer_method_shaped_text_get_selection:
  2133. .. rst-class:: classref-method
  2134. :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>`
  2135. Returns selection rectangles for the specified character range.
  2136. .. rst-class:: classref-item-separator
  2137. ----
  2138. .. _class_TextServer_method_shaped_text_get_size:
  2139. .. rst-class:: classref-method
  2140. :ref:`Vector2<class_Vector2>` **shaped_text_get_size**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_size>`
  2141. Returns size of the text.
  2142. .. rst-class:: classref-item-separator
  2143. ----
  2144. .. _class_TextServer_method_shaped_text_get_spacing:
  2145. .. rst-class:: classref-method
  2146. :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>`
  2147. Returns extra spacing added between glyphs or lines in pixels.
  2148. .. rst-class:: classref-item-separator
  2149. ----
  2150. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2151. .. rst-class:: classref-method
  2152. :ref:`int<class_int>` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_trim_pos>`
  2153. Returns the position of the overrun trim.
  2154. .. rst-class:: classref-item-separator
  2155. ----
  2156. .. _class_TextServer_method_shaped_text_get_underline_position:
  2157. .. rst-class:: classref-method
  2158. :ref:`float<class_float>` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_position>`
  2159. Returns pixel offset of the underline below the baseline.
  2160. .. rst-class:: classref-item-separator
  2161. ----
  2162. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2163. .. rst-class:: classref-method
  2164. :ref:`float<class_float>` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_thickness>`
  2165. Returns thickness of the underline.
  2166. .. rst-class:: classref-item-separator
  2167. ----
  2168. .. _class_TextServer_method_shaped_text_get_width:
  2169. .. rst-class:: classref-method
  2170. :ref:`float<class_float>` **shaped_text_get_width**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_width>`
  2171. Returns width (for horizontal layout) or height (for vertical) of the text.
  2172. .. rst-class:: classref-item-separator
  2173. ----
  2174. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2175. .. rst-class:: classref-method
  2176. :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>`
  2177. 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>`).
  2178. .. rst-class:: classref-item-separator
  2179. ----
  2180. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2181. .. rst-class:: classref-method
  2182. :ref:`bool<class_bool>` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_has_visible_chars>`
  2183. Returns ``true`` if text buffer contains any visible characters.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2187. .. rst-class:: classref-method
  2188. :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>`
  2189. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2190. .. rst-class:: classref-item-separator
  2191. ----
  2192. .. _class_TextServer_method_shaped_text_hit_test_position:
  2193. .. rst-class:: classref-method
  2194. :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>`
  2195. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2196. .. rst-class:: classref-item-separator
  2197. ----
  2198. .. _class_TextServer_method_shaped_text_is_ready:
  2199. .. rst-class:: classref-method
  2200. :ref:`bool<class_bool>` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_is_ready>`
  2201. Returns ``true`` if buffer is successfully shaped.
  2202. .. rst-class:: classref-item-separator
  2203. ----
  2204. .. _class_TextServer_method_shaped_text_next_character_pos:
  2205. .. rst-class:: classref-method
  2206. :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>`
  2207. Returns composite character end position closest to the ``pos``.
  2208. .. rst-class:: classref-item-separator
  2209. ----
  2210. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2211. .. rst-class:: classref-method
  2212. :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>`
  2213. Returns grapheme end position closest to the ``pos``.
  2214. .. rst-class:: classref-item-separator
  2215. ----
  2216. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2217. .. rst-class:: classref-method
  2218. |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>`
  2219. Trims text if it exceeds the given width.
  2220. .. rst-class:: classref-item-separator
  2221. ----
  2222. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2223. .. rst-class:: classref-method
  2224. :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>`
  2225. Returns composite character start position closest to the ``pos``.
  2226. .. rst-class:: classref-item-separator
  2227. ----
  2228. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2229. .. rst-class:: classref-method
  2230. :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>`
  2231. Returns grapheme start position closest to the ``pos``.
  2232. .. rst-class:: classref-item-separator
  2233. ----
  2234. .. _class_TextServer_method_shaped_text_resize_object:
  2235. .. rst-class:: classref-method
  2236. :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>`
  2237. Sets new size and alignment of embedded object.
  2238. .. rst-class:: classref-item-separator
  2239. ----
  2240. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2241. .. rst-class:: classref-method
  2242. |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>`
  2243. Overrides BiDi for the structured text.
  2244. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2245. .. rst-class:: classref-item-separator
  2246. ----
  2247. .. _class_TextServer_method_shaped_text_set_custom_ellipsis:
  2248. .. rst-class:: classref-method
  2249. |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>`
  2250. Sets ellipsis character used for text clipping.
  2251. .. rst-class:: classref-item-separator
  2252. ----
  2253. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2254. .. rst-class:: classref-method
  2255. |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>`
  2256. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2257. .. rst-class:: classref-item-separator
  2258. ----
  2259. .. _class_TextServer_method_shaped_text_set_direction:
  2260. .. rst-class:: classref-method
  2261. |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>`
  2262. 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.
  2263. \ **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>`).
  2264. .. rst-class:: classref-item-separator
  2265. ----
  2266. .. _class_TextServer_method_shaped_text_set_orientation:
  2267. .. rst-class:: classref-method
  2268. |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>`
  2269. Sets desired text orientation.
  2270. \ **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>`).
  2271. .. rst-class:: classref-item-separator
  2272. ----
  2273. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2274. .. rst-class:: classref-method
  2275. |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>`
  2276. If set to ``true`` text buffer will display control characters.
  2277. .. rst-class:: classref-item-separator
  2278. ----
  2279. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2280. .. rst-class:: classref-method
  2281. |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>`
  2282. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2283. .. rst-class:: classref-item-separator
  2284. ----
  2285. .. _class_TextServer_method_shaped_text_set_spacing:
  2286. .. rst-class:: classref-method
  2287. |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>`
  2288. Sets extra spacing added between glyphs or lines in pixels.
  2289. .. rst-class:: classref-item-separator
  2290. ----
  2291. .. _class_TextServer_method_shaped_text_shape:
  2292. .. rst-class:: classref-method
  2293. :ref:`bool<class_bool>` **shaped_text_shape**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_shape>`
  2294. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2295. \ **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.
  2296. .. rst-class:: classref-item-separator
  2297. ----
  2298. .. _class_TextServer_method_shaped_text_sort_logical:
  2299. .. rst-class:: classref-method
  2300. :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>`
  2301. Returns text glyphs in the logical order.
  2302. .. rst-class:: classref-item-separator
  2303. ----
  2304. .. _class_TextServer_method_shaped_text_substr:
  2305. .. rst-class:: classref-method
  2306. :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>`
  2307. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2308. .. rst-class:: classref-item-separator
  2309. ----
  2310. .. _class_TextServer_method_shaped_text_tab_align:
  2311. .. rst-class:: classref-method
  2312. :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>`
  2313. Aligns shaped text to the given tab-stops.
  2314. .. rst-class:: classref-item-separator
  2315. ----
  2316. .. _class_TextServer_method_spoof_check:
  2317. .. rst-class:: classref-method
  2318. :ref:`bool<class_bool>` **spoof_check**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_spoof_check>`
  2319. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2320. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2321. .. rst-class:: classref-item-separator
  2322. ----
  2323. .. _class_TextServer_method_string_get_character_breaks:
  2324. .. rst-class:: classref-method
  2325. :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>`
  2326. Returns array of the composite character boundaries.
  2327. ::
  2328. var ts = TextServerManager.get_primary_interface()
  2329. print(ts.string_get_character_breaks("Test โค๏ธโ€๐Ÿ”ฅ Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2330. .. rst-class:: classref-item-separator
  2331. ----
  2332. .. _class_TextServer_method_string_get_word_breaks:
  2333. .. rst-class:: classref-method
  2334. :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>`
  2335. 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.
  2336. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2337. ::
  2338. var ts = TextServerManager.get_primary_interface()
  2339. 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"
  2340. 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"
  2341. 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"
  2342. .. rst-class:: classref-item-separator
  2343. ----
  2344. .. _class_TextServer_method_string_to_lower:
  2345. .. rst-class:: classref-method
  2346. :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>`
  2347. Returns the string converted to lowercase.
  2348. \ **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>`).
  2349. \ **Note:** The result may be longer or shorter than the original.
  2350. .. rst-class:: classref-item-separator
  2351. ----
  2352. .. _class_TextServer_method_string_to_title:
  2353. .. rst-class:: classref-method
  2354. :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>`
  2355. Returns the string converted to title case.
  2356. \ **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>`).
  2357. \ **Note:** The result may be longer or shorter than the original.
  2358. .. rst-class:: classref-item-separator
  2359. ----
  2360. .. _class_TextServer_method_string_to_upper:
  2361. .. rst-class:: classref-method
  2362. :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>`
  2363. Returns the string converted to uppercase.
  2364. \ **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>`).
  2365. \ **Note:** The result may be longer or shorter than the original.
  2366. .. rst-class:: classref-item-separator
  2367. ----
  2368. .. _class_TextServer_method_strip_diacritics:
  2369. .. rst-class:: classref-method
  2370. :ref:`String<class_String>` **strip_diacritics**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_strip_diacritics>`
  2371. Strips diacritics from the string.
  2372. \ **Note:** The result may be longer or shorter than the original.
  2373. .. rst-class:: classref-item-separator
  2374. ----
  2375. .. _class_TextServer_method_tag_to_name:
  2376. .. rst-class:: classref-method
  2377. :ref:`String<class_String>` **tag_to_name**\ (\ tag\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_tag_to_name>`
  2378. Converts OpenType tag to readable feature, variation, script, or language name.
  2379. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2380. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2381. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2382. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2383. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2384. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2385. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2386. .. |void| replace:: :abbr:`void (No return value.)`