class_textserver.rst 332 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338
  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_embedded_object<class_TextServer_method_shaped_get_span_embedded_object>`\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| |
  318. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | :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| |
  320. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | |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>` = {}\ ) |
  322. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | :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\ ) |
  324. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | :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\ ) |
  326. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | |void| | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  328. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | :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| |
  330. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | |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| |
  332. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | |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| |
  334. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | :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\ ) |
  336. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  338. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :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| |
  340. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  342. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :ref:`int<class_int>` | :ref:`shaped_text_get_custom_ellipsis<class_TextServer_method_shaped_text_get_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  344. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  346. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  348. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  350. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :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| |
  352. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :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| |
  354. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :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| |
  356. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  358. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  360. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :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| |
  362. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :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| |
  364. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :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| |
  366. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :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| |
  368. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :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| |
  370. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | :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| |
  372. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | :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| |
  374. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :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| |
  376. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  378. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  380. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  382. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  384. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  386. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  388. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :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| |
  390. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  392. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :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| |
  394. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  396. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  398. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  400. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  402. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :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| |
  404. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  406. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :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| |
  408. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | :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| |
  410. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  412. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :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| |
  414. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | :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| |
  416. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | |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\ ) |
  418. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | :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| |
  420. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | :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| |
  422. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | :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\ ) |
  424. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | |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>`\ ) |
  426. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | |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>`\ ) |
  428. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | |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>`\ ) |
  430. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | |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\ ) |
  432. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | |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\ ) |
  434. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | |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>`\ ) |
  436. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | |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>`\ ) |
  438. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | |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>`\ ) |
  440. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  442. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :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>`\ ) |
  444. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :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| |
  446. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :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>`\ ) |
  448. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  450. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | :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| |
  452. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | :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| |
  454. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | :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| |
  456. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. | :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| |
  458. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  459. | :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| |
  460. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  461. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  462. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  463. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>`\ (\ tag\: :ref:`int<class_int>`\ ) |const| |
  464. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  465. .. rst-class:: classref-section-separator
  466. ----
  467. .. rst-class:: classref-descriptions-group
  468. Enumerations
  469. ------------
  470. .. _enum_TextServer_FontAntialiasing:
  471. .. rst-class:: classref-enumeration
  472. enum **FontAntialiasing**: :ref:`๐Ÿ”—<enum_TextServer_FontAntialiasing>`
  473. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  474. .. rst-class:: classref-enumeration-constant
  475. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  476. Font glyphs are rasterized as 1-bit bitmaps.
  477. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  478. .. rst-class:: classref-enumeration-constant
  479. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  480. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  481. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  482. .. rst-class:: classref-enumeration-constant
  483. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  484. Font glyphs are rasterized for LCD screens.
  485. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  486. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  487. .. rst-class:: classref-item-separator
  488. ----
  489. .. _enum_TextServer_FontLCDSubpixelLayout:
  490. .. rst-class:: classref-enumeration
  491. enum **FontLCDSubpixelLayout**: :ref:`๐Ÿ”—<enum_TextServer_FontLCDSubpixelLayout>`
  492. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  495. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  496. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  497. .. rst-class:: classref-enumeration-constant
  498. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  499. Horizontal RGB subpixel layout.
  500. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  501. .. rst-class:: classref-enumeration-constant
  502. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  503. Horizontal BGR subpixel layout.
  504. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  505. .. rst-class:: classref-enumeration-constant
  506. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  507. Vertical RGB subpixel layout.
  508. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  509. .. rst-class:: classref-enumeration-constant
  510. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  511. Vertical BGR subpixel layout.
  512. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  513. .. rst-class:: classref-enumeration-constant
  514. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  515. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  516. .. rst-class:: classref-item-separator
  517. ----
  518. .. _enum_TextServer_Direction:
  519. .. rst-class:: classref-enumeration
  520. enum **Direction**: :ref:`๐Ÿ”—<enum_TextServer_Direction>`
  521. .. _class_TextServer_constant_DIRECTION_AUTO:
  522. .. rst-class:: classref-enumeration-constant
  523. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  524. Text direction is determined based on contents and current locale.
  525. .. _class_TextServer_constant_DIRECTION_LTR:
  526. .. rst-class:: classref-enumeration-constant
  527. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  528. Text is written from left to right.
  529. .. _class_TextServer_constant_DIRECTION_RTL:
  530. .. rst-class:: classref-enumeration-constant
  531. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  532. Text is written from right to left.
  533. .. _class_TextServer_constant_DIRECTION_INHERITED:
  534. .. rst-class:: classref-enumeration-constant
  535. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  536. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  537. .. rst-class:: classref-item-separator
  538. ----
  539. .. _enum_TextServer_Orientation:
  540. .. rst-class:: classref-enumeration
  541. enum **Orientation**: :ref:`๐Ÿ”—<enum_TextServer_Orientation>`
  542. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  545. Text is written horizontally.
  546. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  549. Left to right text is written vertically from top to bottom.
  550. Right to left text is written vertically from bottom to top.
  551. .. rst-class:: classref-item-separator
  552. ----
  553. .. _enum_TextServer_JustificationFlag:
  554. .. rst-class:: classref-enumeration
  555. flags **JustificationFlag**: :ref:`๐Ÿ”—<enum_TextServer_JustificationFlag>`
  556. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  557. .. rst-class:: classref-enumeration-constant
  558. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  559. Do not justify text.
  560. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  561. .. rst-class:: classref-enumeration-constant
  562. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  563. Justify text by adding and removing kashidas.
  564. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  565. .. rst-class:: classref-enumeration-constant
  566. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  567. Justify text by changing width of the spaces between the words.
  568. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  569. .. rst-class:: classref-enumeration-constant
  570. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  571. Remove trailing and leading spaces from the justified text.
  572. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  573. .. rst-class:: classref-enumeration-constant
  574. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  575. Only apply justification to the part of the text after the last tab.
  576. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  577. .. rst-class:: classref-enumeration-constant
  578. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  579. Apply justification to the trimmed line with ellipsis.
  580. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  581. .. rst-class:: classref-enumeration-constant
  582. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  583. Do not apply justification to the last line of the paragraph.
  584. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  585. .. rst-class:: classref-enumeration-constant
  586. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  587. 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>`).
  588. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  589. .. rst-class:: classref-enumeration-constant
  590. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  591. 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).
  592. .. rst-class:: classref-item-separator
  593. ----
  594. .. _enum_TextServer_AutowrapMode:
  595. .. rst-class:: classref-enumeration
  596. enum **AutowrapMode**: :ref:`๐Ÿ”—<enum_TextServer_AutowrapMode>`
  597. .. _class_TextServer_constant_AUTOWRAP_OFF:
  598. .. rst-class:: classref-enumeration-constant
  599. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  600. Autowrap is disabled.
  601. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  602. .. rst-class:: classref-enumeration-constant
  603. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  604. 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.
  605. .. _class_TextServer_constant_AUTOWRAP_WORD:
  606. .. rst-class:: classref-enumeration-constant
  607. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  608. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  609. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  610. .. rst-class:: classref-enumeration-constant
  611. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  612. 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.
  613. .. rst-class:: classref-item-separator
  614. ----
  615. .. _enum_TextServer_LineBreakFlag:
  616. .. rst-class:: classref-enumeration
  617. flags **LineBreakFlag**: :ref:`๐Ÿ”—<enum_TextServer_LineBreakFlag>`
  618. .. _class_TextServer_constant_BREAK_NONE:
  619. .. rst-class:: classref-enumeration-constant
  620. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  621. Do not break the line.
  622. .. _class_TextServer_constant_BREAK_MANDATORY:
  623. .. rst-class:: classref-enumeration-constant
  624. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  625. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  626. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  627. .. rst-class:: classref-enumeration-constant
  628. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  629. Break the line between the words.
  630. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  631. .. rst-class:: classref-enumeration-constant
  632. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  633. Break the line between any unconnected graphemes.
  634. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  635. .. rst-class:: classref-enumeration-constant
  636. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  637. 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.
  638. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  639. .. rst-class:: classref-enumeration-constant
  640. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  641. Remove edge spaces from the broken line segments.
  642. .. _class_TextServer_constant_BREAK_TRIM_INDENT:
  643. .. rst-class:: classref-enumeration-constant
  644. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_INDENT** = ``32``
  645. Subtract first line indentation width from all lines after the first one.
  646. .. rst-class:: classref-item-separator
  647. ----
  648. .. _enum_TextServer_VisibleCharactersBehavior:
  649. .. rst-class:: classref-enumeration
  650. enum **VisibleCharactersBehavior**: :ref:`๐Ÿ”—<enum_TextServer_VisibleCharactersBehavior>`
  651. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  652. .. rst-class:: classref-enumeration-constant
  653. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  654. 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.
  655. \ **Note:** In this mode, trimmed text is not processed at all. It is not accounted for in line breaking and size calculations.
  656. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  657. .. rst-class:: classref-enumeration-constant
  658. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  659. 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.
  660. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  661. .. rst-class:: classref-enumeration-constant
  662. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  663. 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.
  664. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  665. .. rst-class:: classref-enumeration-constant
  666. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  667. 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.
  668. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  671. 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.
  672. .. rst-class:: classref-item-separator
  673. ----
  674. .. _enum_TextServer_OverrunBehavior:
  675. .. rst-class:: classref-enumeration
  676. enum **OverrunBehavior**: :ref:`๐Ÿ”—<enum_TextServer_OverrunBehavior>`
  677. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  678. .. rst-class:: classref-enumeration-constant
  679. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  680. No text trimming is performed.
  681. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  682. .. rst-class:: classref-enumeration-constant
  683. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  684. Trims the text per character.
  685. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  686. .. rst-class:: classref-enumeration-constant
  687. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  688. Trims the text per word.
  689. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  690. .. rst-class:: classref-enumeration-constant
  691. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  692. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  693. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  696. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  697. .. rst-class:: classref-item-separator
  698. ----
  699. .. _enum_TextServer_TextOverrunFlag:
  700. .. rst-class:: classref-enumeration
  701. flags **TextOverrunFlag**: :ref:`๐Ÿ”—<enum_TextServer_TextOverrunFlag>`
  702. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  703. .. rst-class:: classref-enumeration-constant
  704. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  705. No trimming is performed.
  706. .. _class_TextServer_constant_OVERRUN_TRIM:
  707. .. rst-class:: classref-enumeration-constant
  708. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  709. Trims the text when it exceeds the given width.
  710. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  711. .. rst-class:: classref-enumeration-constant
  712. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  713. Trims the text per word instead of per grapheme.
  714. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  715. .. rst-class:: classref-enumeration-constant
  716. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  717. Determines whether an ellipsis should be added at the end of the text.
  718. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  719. .. rst-class:: classref-enumeration-constant
  720. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  721. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  722. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  723. .. rst-class:: classref-enumeration-constant
  724. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  725. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  726. .. rst-class:: classref-item-separator
  727. ----
  728. .. _enum_TextServer_GraphemeFlag:
  729. .. rst-class:: classref-enumeration
  730. flags **GraphemeFlag**: :ref:`๐Ÿ”—<enum_TextServer_GraphemeFlag>`
  731. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  732. .. rst-class:: classref-enumeration-constant
  733. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  734. Grapheme is supported by the font, and can be drawn.
  735. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  736. .. rst-class:: classref-enumeration-constant
  737. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  738. Grapheme is part of right-to-left or bottom-to-top run.
  739. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  740. .. rst-class:: classref-enumeration-constant
  741. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  742. Grapheme is not part of source text, it was added by justification process.
  743. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  744. .. rst-class:: classref-enumeration-constant
  745. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  746. Grapheme is whitespace.
  747. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  748. .. rst-class:: classref-enumeration-constant
  749. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  750. Grapheme is mandatory break point (e.g. ``"\n"``).
  751. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  752. .. rst-class:: classref-enumeration-constant
  753. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  754. Grapheme is optional break point (e.g. space).
  755. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  756. .. rst-class:: classref-enumeration-constant
  757. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  758. Grapheme is the tabulation character.
  759. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  760. .. rst-class:: classref-enumeration-constant
  761. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  762. Grapheme is kashida.
  763. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  764. .. rst-class:: classref-enumeration-constant
  765. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  766. Grapheme is punctuation character.
  767. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  768. .. rst-class:: classref-enumeration-constant
  769. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  770. Grapheme is underscore character.
  771. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  772. .. rst-class:: classref-enumeration-constant
  773. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  774. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  775. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  776. .. rst-class:: classref-enumeration-constant
  777. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  778. It is safe to insert a U+0640 before this grapheme for elongation.
  779. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  780. .. rst-class:: classref-enumeration-constant
  781. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  782. Grapheme is an object replacement character for the embedded object.
  783. .. _class_TextServer_constant_GRAPHEME_IS_SOFT_HYPHEN:
  784. .. rst-class:: classref-enumeration-constant
  785. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SOFT_HYPHEN** = ``8192``
  786. Grapheme is a soft hyphen.
  787. .. rst-class:: classref-item-separator
  788. ----
  789. .. _enum_TextServer_Hinting:
  790. .. rst-class:: classref-enumeration
  791. enum **Hinting**: :ref:`๐Ÿ”—<enum_TextServer_Hinting>`
  792. .. _class_TextServer_constant_HINTING_NONE:
  793. .. rst-class:: classref-enumeration-constant
  794. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  795. Disables font hinting (smoother but less crisp).
  796. .. _class_TextServer_constant_HINTING_LIGHT:
  797. .. rst-class:: classref-enumeration-constant
  798. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  799. Use the light font hinting mode.
  800. .. _class_TextServer_constant_HINTING_NORMAL:
  801. .. rst-class:: classref-enumeration-constant
  802. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  803. Use the default font hinting mode (crisper but less smooth).
  804. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  805. .. rst-class:: classref-item-separator
  806. ----
  807. .. _enum_TextServer_SubpixelPositioning:
  808. .. rst-class:: classref-enumeration
  809. enum **SubpixelPositioning**: :ref:`๐Ÿ”—<enum_TextServer_SubpixelPositioning>`
  810. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  811. .. rst-class:: classref-enumeration-constant
  812. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  813. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  814. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  815. .. rst-class:: classref-enumeration-constant
  816. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  817. Glyph horizontal position is rounded based on font size.
  818. - 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>`.
  819. - 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>`.
  820. - To the whole pixel size for larger fonts.
  821. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  822. .. rst-class:: classref-enumeration-constant
  823. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  824. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  825. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  826. .. rst-class:: classref-enumeration-constant
  827. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  828. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  829. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  830. .. rst-class:: classref-enumeration-constant
  831. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  832. 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.
  833. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  834. .. rst-class:: classref-enumeration-constant
  835. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  836. 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.
  837. .. rst-class:: classref-item-separator
  838. ----
  839. .. _enum_TextServer_Feature:
  840. .. rst-class:: classref-enumeration
  841. enum **Feature**: :ref:`๐Ÿ”—<enum_TextServer_Feature>`
  842. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  845. TextServer supports simple text layouts.
  846. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  849. TextServer supports bidirectional text layouts.
  850. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  853. TextServer supports vertical layouts.
  854. .. _class_TextServer_constant_FEATURE_SHAPING:
  855. .. rst-class:: classref-enumeration-constant
  856. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  857. TextServer supports complex text shaping.
  858. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  859. .. rst-class:: classref-enumeration-constant
  860. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  861. TextServer supports justification using kashidas.
  862. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  863. .. rst-class:: classref-enumeration-constant
  864. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  865. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  866. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  867. .. rst-class:: classref-enumeration-constant
  868. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  869. TextServer supports loading bitmap fonts.
  870. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  871. .. rst-class:: classref-enumeration-constant
  872. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  873. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  874. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  875. .. rst-class:: classref-enumeration-constant
  876. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  877. TextServer supports multichannel signed distance field dynamic font rendering.
  878. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  879. .. rst-class:: classref-enumeration-constant
  880. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  881. TextServer supports loading system fonts.
  882. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  883. .. rst-class:: classref-enumeration-constant
  884. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  885. TextServer supports variable fonts.
  886. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  887. .. rst-class:: classref-enumeration-constant
  888. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  889. TextServer supports locale dependent and context sensitive case conversion.
  890. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  891. .. rst-class:: classref-enumeration-constant
  892. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  893. TextServer require external data file for some features, see :ref:`load_support_data()<class_TextServer_method_load_support_data>`.
  894. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  895. .. rst-class:: classref-enumeration-constant
  896. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  897. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier()<class_TextServer_method_is_valid_identifier>`.
  898. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  899. .. rst-class:: classref-enumeration-constant
  900. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  901. 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.
  902. .. rst-class:: classref-item-separator
  903. ----
  904. .. _enum_TextServer_ContourPointTag:
  905. .. rst-class:: classref-enumeration
  906. enum **ContourPointTag**: :ref:`๐Ÿ”—<enum_TextServer_ContourPointTag>`
  907. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  908. .. rst-class:: classref-enumeration-constant
  909. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  910. Contour point is on the curve.
  911. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  912. .. rst-class:: classref-enumeration-constant
  913. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  914. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bรฉzier arc.
  915. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  916. .. rst-class:: classref-enumeration-constant
  917. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  918. Contour point isn't on the curve, but serves as a control point for a cubic Bรฉzier arc.
  919. .. rst-class:: classref-item-separator
  920. ----
  921. .. _enum_TextServer_SpacingType:
  922. .. rst-class:: classref-enumeration
  923. enum **SpacingType**: :ref:`๐Ÿ”—<enum_TextServer_SpacingType>`
  924. .. _class_TextServer_constant_SPACING_GLYPH:
  925. .. rst-class:: classref-enumeration-constant
  926. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  927. Spacing for each glyph.
  928. .. _class_TextServer_constant_SPACING_SPACE:
  929. .. rst-class:: classref-enumeration-constant
  930. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  931. Spacing for the space character.
  932. .. _class_TextServer_constant_SPACING_TOP:
  933. .. rst-class:: classref-enumeration-constant
  934. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  935. Spacing at the top of the line.
  936. .. _class_TextServer_constant_SPACING_BOTTOM:
  937. .. rst-class:: classref-enumeration-constant
  938. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  939. Spacing at the bottom of the line.
  940. .. _class_TextServer_constant_SPACING_MAX:
  941. .. rst-class:: classref-enumeration-constant
  942. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  943. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  944. .. rst-class:: classref-item-separator
  945. ----
  946. .. _enum_TextServer_FontStyle:
  947. .. rst-class:: classref-enumeration
  948. flags **FontStyle**: :ref:`๐Ÿ”—<enum_TextServer_FontStyle>`
  949. .. _class_TextServer_constant_FONT_BOLD:
  950. .. rst-class:: classref-enumeration-constant
  951. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  952. Font is bold.
  953. .. _class_TextServer_constant_FONT_ITALIC:
  954. .. rst-class:: classref-enumeration-constant
  955. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  956. Font is italic or oblique.
  957. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  958. .. rst-class:: classref-enumeration-constant
  959. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  960. Font have fixed-width characters.
  961. .. rst-class:: classref-item-separator
  962. ----
  963. .. _enum_TextServer_StructuredTextParser:
  964. .. rst-class:: classref-enumeration
  965. enum **StructuredTextParser**: :ref:`๐Ÿ”—<enum_TextServer_StructuredTextParser>`
  966. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  967. .. rst-class:: classref-enumeration-constant
  968. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  969. Use default Unicode BiDi algorithm.
  970. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  971. .. rst-class:: classref-enumeration-constant
  972. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  973. BiDi override for URI.
  974. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  975. .. rst-class:: classref-enumeration-constant
  976. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  977. BiDi override for file path.
  978. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  979. .. rst-class:: classref-enumeration-constant
  980. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  981. BiDi override for email.
  982. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  983. .. rst-class:: classref-enumeration-constant
  984. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  985. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  986. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  987. .. rst-class:: classref-enumeration-constant
  988. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  989. BiDi override for GDScript.
  990. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  991. .. rst-class:: classref-enumeration-constant
  992. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  993. User defined structured text BiDi override function.
  994. .. rst-class:: classref-item-separator
  995. ----
  996. .. _enum_TextServer_FixedSizeScaleMode:
  997. .. rst-class:: classref-enumeration
  998. enum **FixedSizeScaleMode**: :ref:`๐Ÿ”—<enum_TextServer_FixedSizeScaleMode>`
  999. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  1000. .. rst-class:: classref-enumeration-constant
  1001. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  1002. Bitmap font is not scaled.
  1003. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  1004. .. rst-class:: classref-enumeration-constant
  1005. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  1006. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  1007. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  1008. .. rst-class:: classref-enumeration-constant
  1009. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  1010. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  1011. .. rst-class:: classref-section-separator
  1012. ----
  1013. .. rst-class:: classref-descriptions-group
  1014. Method Descriptions
  1015. -------------------
  1016. .. _class_TextServer_method_create_font:
  1017. .. rst-class:: classref-method
  1018. :ref:`RID<class_RID>` **create_font**\ (\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font>`
  1019. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid()<class_TextServer_method_free_rid>` method.
  1020. .. rst-class:: classref-item-separator
  1021. ----
  1022. .. _class_TextServer_method_create_font_linked_variation:
  1023. .. rst-class:: classref-method
  1024. :ref:`RID<class_RID>` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font_linked_variation>`
  1025. 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.
  1026. .. rst-class:: classref-item-separator
  1027. ----
  1028. .. _class_TextServer_method_create_shaped_text:
  1029. .. rst-class:: classref-method
  1030. :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>`
  1031. 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.
  1032. \ **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>`).
  1033. \ **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>`).
  1034. .. rst-class:: classref-item-separator
  1035. ----
  1036. .. _class_TextServer_method_draw_hex_code_box:
  1037. .. rst-class:: classref-method
  1038. |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>`
  1039. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  1040. .. rst-class:: classref-item-separator
  1041. ----
  1042. .. _class_TextServer_method_font_clear_glyphs:
  1043. .. rst-class:: classref-method
  1044. |void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_glyphs>`
  1045. Removes all rendered glyph information from the cache entry.
  1046. \ **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.
  1047. .. rst-class:: classref-item-separator
  1048. ----
  1049. .. _class_TextServer_method_font_clear_kerning_map:
  1050. .. rst-class:: classref-method
  1051. |void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_kerning_map>`
  1052. Removes all kerning overrides.
  1053. .. rst-class:: classref-item-separator
  1054. ----
  1055. .. _class_TextServer_method_font_clear_size_cache:
  1056. .. rst-class:: classref-method
  1057. |void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_size_cache>`
  1058. Removes all font sizes from the cache entry.
  1059. .. rst-class:: classref-item-separator
  1060. ----
  1061. .. _class_TextServer_method_font_clear_textures:
  1062. .. rst-class:: classref-method
  1063. |void| **font_clear_textures**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_textures>`
  1064. Removes all textures from font cache entry.
  1065. \ **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.
  1066. .. rst-class:: classref-item-separator
  1067. ----
  1068. .. _class_TextServer_method_font_draw_glyph:
  1069. .. rst-class:: classref-method
  1070. |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>`
  1071. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1072. \ **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>`.
  1073. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1074. .. rst-class:: classref-item-separator
  1075. ----
  1076. .. _class_TextServer_method_font_draw_glyph_outline:
  1077. .. rst-class:: classref-method
  1078. |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>`
  1079. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1080. \ **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>`.
  1081. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1082. .. rst-class:: classref-item-separator
  1083. ----
  1084. .. _class_TextServer_method_font_get_antialiasing:
  1085. .. rst-class:: classref-method
  1086. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_antialiasing>`
  1087. Returns font anti-aliasing mode.
  1088. .. rst-class:: classref-item-separator
  1089. ----
  1090. .. _class_TextServer_method_font_get_ascent:
  1091. .. rst-class:: classref-method
  1092. :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>`
  1093. Returns the font ascent (number of pixels above the baseline).
  1094. .. rst-class:: classref-item-separator
  1095. ----
  1096. .. _class_TextServer_method_font_get_baseline_offset:
  1097. .. rst-class:: classref-method
  1098. :ref:`float<class_float>` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_baseline_offset>`
  1099. Returns extra baseline offset (as a fraction of font height).
  1100. .. rst-class:: classref-item-separator
  1101. ----
  1102. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1103. .. rst-class:: classref-method
  1104. :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>`
  1105. 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>`.
  1106. .. rst-class:: classref-item-separator
  1107. ----
  1108. .. _class_TextServer_method_font_get_descent:
  1109. .. rst-class:: classref-method
  1110. :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>`
  1111. Returns the font descent (number of pixels below the baseline).
  1112. .. rst-class:: classref-item-separator
  1113. ----
  1114. .. _class_TextServer_method_font_get_disable_embedded_bitmaps:
  1115. .. rst-class:: classref-method
  1116. :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>`
  1117. Returns whether the font's embedded bitmap loading is disabled.
  1118. .. rst-class:: classref-item-separator
  1119. ----
  1120. .. _class_TextServer_method_font_get_embolden:
  1121. .. rst-class:: classref-method
  1122. :ref:`float<class_float>` **font_get_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_embolden>`
  1123. Returns font embolden strength.
  1124. .. rst-class:: classref-item-separator
  1125. ----
  1126. .. _class_TextServer_method_font_get_face_count:
  1127. .. rst-class:: classref-method
  1128. :ref:`int<class_int>` **font_get_face_count**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_count>`
  1129. Returns number of faces in the TrueType / OpenType collection.
  1130. .. rst-class:: classref-item-separator
  1131. ----
  1132. .. _class_TextServer_method_font_get_face_index:
  1133. .. rst-class:: classref-method
  1134. :ref:`int<class_int>` **font_get_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_index>`
  1135. Returns an active face index in the TrueType / OpenType collection.
  1136. .. rst-class:: classref-item-separator
  1137. ----
  1138. .. _class_TextServer_method_font_get_fixed_size:
  1139. .. rst-class:: classref-method
  1140. :ref:`int<class_int>` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size>`
  1141. Returns bitmap font fixed size.
  1142. .. rst-class:: classref-item-separator
  1143. ----
  1144. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1145. .. rst-class:: classref-method
  1146. :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>`
  1147. Returns bitmap font scaling mode.
  1148. .. rst-class:: classref-item-separator
  1149. ----
  1150. .. _class_TextServer_method_font_get_generate_mipmaps:
  1151. .. rst-class:: classref-method
  1152. :ref:`bool<class_bool>` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_generate_mipmaps>`
  1153. Returns ``true`` if font texture mipmap generation is enabled.
  1154. .. rst-class:: classref-item-separator
  1155. ----
  1156. .. _class_TextServer_method_font_get_global_oversampling:
  1157. .. rst-class:: classref-method
  1158. :ref:`float<class_float>` **font_get_global_oversampling**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_global_oversampling>`
  1159. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1160. .. rst-class:: classref-item-separator
  1161. ----
  1162. .. _class_TextServer_method_font_get_glyph_advance:
  1163. .. rst-class:: classref-method
  1164. :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>`
  1165. Returns glyph advance (offset of the next glyph).
  1166. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1167. .. rst-class:: classref-item-separator
  1168. ----
  1169. .. _class_TextServer_method_font_get_glyph_contours:
  1170. .. rst-class:: classref-method
  1171. :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>`
  1172. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1173. \ ``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.
  1174. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1175. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1176. - Two successive :ref:`CONTOUR_CURVE_TAG_ON<class_TextServer_constant_CONTOUR_CURVE_TAG_ON>` points indicate a line segment.
  1177. - 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.
  1178. - 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.
  1179. - 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.
  1180. - 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.
  1181. .. rst-class:: classref-item-separator
  1182. ----
  1183. .. _class_TextServer_method_font_get_glyph_index:
  1184. .. rst-class:: classref-method
  1185. :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>`
  1186. 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>`.
  1187. .. rst-class:: classref-item-separator
  1188. ----
  1189. .. _class_TextServer_method_font_get_glyph_list:
  1190. .. rst-class:: classref-method
  1191. :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>`
  1192. Returns list of rendered glyphs in the cache entry.
  1193. .. rst-class:: classref-item-separator
  1194. ----
  1195. .. _class_TextServer_method_font_get_glyph_offset:
  1196. .. rst-class:: classref-method
  1197. :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>`
  1198. Returns glyph offset from the baseline.
  1199. .. rst-class:: classref-item-separator
  1200. ----
  1201. .. _class_TextServer_method_font_get_glyph_size:
  1202. .. rst-class:: classref-method
  1203. :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>`
  1204. Returns size of the glyph.
  1205. .. rst-class:: classref-item-separator
  1206. ----
  1207. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1208. .. rst-class:: classref-method
  1209. :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>`
  1210. Returns index of the cache texture containing the glyph.
  1211. .. rst-class:: classref-item-separator
  1212. ----
  1213. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1214. .. rst-class:: classref-method
  1215. :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>`
  1216. Returns resource ID of the cache texture containing the glyph.
  1217. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1218. .. rst-class:: classref-item-separator
  1219. ----
  1220. .. _class_TextServer_method_font_get_glyph_texture_size:
  1221. .. rst-class:: classref-method
  1222. :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>`
  1223. Returns size of the cache texture containing the glyph.
  1224. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1225. .. rst-class:: classref-item-separator
  1226. ----
  1227. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1228. .. rst-class:: classref-method
  1229. :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>`
  1230. Returns rectangle in the cache texture containing the glyph.
  1231. .. rst-class:: classref-item-separator
  1232. ----
  1233. .. _class_TextServer_method_font_get_hinting:
  1234. .. rst-class:: classref-method
  1235. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_hinting>`
  1236. Returns the font hinting mode. Used by dynamic fonts only.
  1237. .. rst-class:: classref-item-separator
  1238. ----
  1239. .. _class_TextServer_method_font_get_keep_rounding_remainders:
  1240. .. rst-class:: classref-method
  1241. :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>`
  1242. 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.
  1243. .. rst-class:: classref-item-separator
  1244. ----
  1245. .. _class_TextServer_method_font_get_kerning:
  1246. .. rst-class:: classref-method
  1247. :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>`
  1248. Returns kerning for the pair of glyphs.
  1249. .. rst-class:: classref-item-separator
  1250. ----
  1251. .. _class_TextServer_method_font_get_kerning_list:
  1252. .. rst-class:: classref-method
  1253. :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>`
  1254. Returns list of the kerning overrides.
  1255. .. rst-class:: classref-item-separator
  1256. ----
  1257. .. _class_TextServer_method_font_get_language_support_override:
  1258. .. rst-class:: classref-method
  1259. :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>`
  1260. Returns ``true`` if support override is enabled for the ``language``.
  1261. .. rst-class:: classref-item-separator
  1262. ----
  1263. .. _class_TextServer_method_font_get_language_support_overrides:
  1264. .. rst-class:: classref-method
  1265. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_overrides>`
  1266. Returns list of language support overrides.
  1267. .. rst-class:: classref-item-separator
  1268. ----
  1269. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1270. .. rst-class:: classref-method
  1271. :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>`
  1272. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1273. .. rst-class:: classref-item-separator
  1274. ----
  1275. .. _class_TextServer_method_font_get_msdf_size:
  1276. .. rst-class:: classref-method
  1277. :ref:`int<class_int>` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_size>`
  1278. Returns source font size used to generate MSDF textures.
  1279. .. rst-class:: classref-item-separator
  1280. ----
  1281. .. _class_TextServer_method_font_get_name:
  1282. .. rst-class:: classref-method
  1283. :ref:`String<class_String>` **font_get_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_name>`
  1284. Returns font family name.
  1285. .. rst-class:: classref-item-separator
  1286. ----
  1287. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1288. .. rst-class:: classref-method
  1289. :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>`
  1290. Returns font OpenType feature set override.
  1291. .. rst-class:: classref-item-separator
  1292. ----
  1293. .. _class_TextServer_method_font_get_ot_name_strings:
  1294. .. rst-class:: classref-method
  1295. :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>`
  1296. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1297. .. rst-class:: classref-item-separator
  1298. ----
  1299. .. _class_TextServer_method_font_get_oversampling:
  1300. .. rst-class:: classref-method
  1301. :ref:`float<class_float>` **font_get_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_oversampling>`
  1302. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1303. .. rst-class:: classref-item-separator
  1304. ----
  1305. .. _class_TextServer_method_font_get_scale:
  1306. .. rst-class:: classref-method
  1307. :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>`
  1308. Returns scaling factor of the color bitmap font.
  1309. .. rst-class:: classref-item-separator
  1310. ----
  1311. .. _class_TextServer_method_font_get_script_support_override:
  1312. .. rst-class:: classref-method
  1313. :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>`
  1314. Returns ``true`` if support override is enabled for the ``script``.
  1315. .. rst-class:: classref-item-separator
  1316. ----
  1317. .. _class_TextServer_method_font_get_script_support_overrides:
  1318. .. rst-class:: classref-method
  1319. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_overrides>`
  1320. Returns list of script support overrides.
  1321. .. rst-class:: classref-item-separator
  1322. ----
  1323. .. _class_TextServer_method_font_get_size_cache_list:
  1324. .. rst-class:: classref-method
  1325. :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>`
  1326. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1327. .. rst-class:: classref-item-separator
  1328. ----
  1329. .. _class_TextServer_method_font_get_spacing:
  1330. .. rst-class:: classref-method
  1331. :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>`
  1332. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1333. .. rst-class:: classref-item-separator
  1334. ----
  1335. .. _class_TextServer_method_font_get_stretch:
  1336. .. rst-class:: classref-method
  1337. :ref:`int<class_int>` **font_get_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_stretch>`
  1338. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1339. .. rst-class:: classref-item-separator
  1340. ----
  1341. .. _class_TextServer_method_font_get_style:
  1342. .. rst-class:: classref-method
  1343. |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **font_get_style**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style>`
  1344. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1345. .. rst-class:: classref-item-separator
  1346. ----
  1347. .. _class_TextServer_method_font_get_style_name:
  1348. .. rst-class:: classref-method
  1349. :ref:`String<class_String>` **font_get_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style_name>`
  1350. Returns font style name.
  1351. .. rst-class:: classref-item-separator
  1352. ----
  1353. .. _class_TextServer_method_font_get_subpixel_positioning:
  1354. .. rst-class:: classref-method
  1355. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_subpixel_positioning>`
  1356. Returns font subpixel glyph positioning mode.
  1357. .. rst-class:: classref-item-separator
  1358. ----
  1359. .. _class_TextServer_method_font_get_supported_chars:
  1360. .. rst-class:: classref-method
  1361. :ref:`String<class_String>` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_chars>`
  1362. Returns a string containing all the characters available in the font.
  1363. .. rst-class:: classref-item-separator
  1364. ----
  1365. .. _class_TextServer_method_font_get_supported_glyphs:
  1366. .. rst-class:: classref-method
  1367. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_supported_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_glyphs>`
  1368. Returns an array containing all glyph indices in the font.
  1369. .. rst-class:: classref-item-separator
  1370. ----
  1371. .. _class_TextServer_method_font_get_texture_count:
  1372. .. rst-class:: classref-method
  1373. :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>`
  1374. Returns number of textures used by font cache entry.
  1375. .. rst-class:: classref-item-separator
  1376. ----
  1377. .. _class_TextServer_method_font_get_texture_image:
  1378. .. rst-class:: classref-method
  1379. :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>`
  1380. Returns font cache texture image data.
  1381. .. rst-class:: classref-item-separator
  1382. ----
  1383. .. _class_TextServer_method_font_get_texture_offsets:
  1384. .. rst-class:: classref-method
  1385. :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>`
  1386. Returns array containing glyph packing data.
  1387. .. rst-class:: classref-item-separator
  1388. ----
  1389. .. _class_TextServer_method_font_get_transform:
  1390. .. rst-class:: classref-method
  1391. :ref:`Transform2D<class_Transform2D>` **font_get_transform**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_transform>`
  1392. Returns 2D transform applied to the font outlines.
  1393. .. rst-class:: classref-item-separator
  1394. ----
  1395. .. _class_TextServer_method_font_get_underline_position:
  1396. .. rst-class:: classref-method
  1397. :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>`
  1398. Returns pixel offset of the underline below the baseline.
  1399. .. rst-class:: classref-item-separator
  1400. ----
  1401. .. _class_TextServer_method_font_get_underline_thickness:
  1402. .. rst-class:: classref-method
  1403. :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>`
  1404. Returns thickness of the underline in pixels.
  1405. .. rst-class:: classref-item-separator
  1406. ----
  1407. .. _class_TextServer_method_font_get_variation_coordinates:
  1408. .. rst-class:: classref-method
  1409. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_variation_coordinates>`
  1410. 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.
  1411. .. rst-class:: classref-item-separator
  1412. ----
  1413. .. _class_TextServer_method_font_get_weight:
  1414. .. rst-class:: classref-method
  1415. :ref:`int<class_int>` **font_get_weight**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_weight>`
  1416. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1417. .. rst-class:: classref-item-separator
  1418. ----
  1419. .. _class_TextServer_method_font_has_char:
  1420. .. rst-class:: classref-method
  1421. :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>`
  1422. Returns ``true`` if a Unicode ``char`` is available in the font.
  1423. .. rst-class:: classref-item-separator
  1424. ----
  1425. .. _class_TextServer_method_font_is_allow_system_fallback:
  1426. .. rst-class:: classref-method
  1427. :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>`
  1428. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1429. .. rst-class:: classref-item-separator
  1430. ----
  1431. .. _class_TextServer_method_font_is_force_autohinter:
  1432. .. rst-class:: classref-method
  1433. :ref:`bool<class_bool>` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_force_autohinter>`
  1434. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1435. .. rst-class:: classref-item-separator
  1436. ----
  1437. .. _class_TextServer_method_font_is_language_supported:
  1438. .. rst-class:: classref-method
  1439. :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>`
  1440. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1441. .. rst-class:: classref-item-separator
  1442. ----
  1443. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1444. .. rst-class:: classref-method
  1445. :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>`
  1446. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1447. .. rst-class:: classref-item-separator
  1448. ----
  1449. .. _class_TextServer_method_font_is_script_supported:
  1450. .. rst-class:: classref-method
  1451. :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>`
  1452. Returns ``true``, if font supports given script (ISO 15924 code).
  1453. .. rst-class:: classref-item-separator
  1454. ----
  1455. .. _class_TextServer_method_font_remove_glyph:
  1456. .. rst-class:: classref-method
  1457. |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>`
  1458. Removes specified rendered glyph information from the cache entry.
  1459. \ **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.
  1460. .. rst-class:: classref-item-separator
  1461. ----
  1462. .. _class_TextServer_method_font_remove_kerning:
  1463. .. rst-class:: classref-method
  1464. |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>`
  1465. Removes kerning override for the pair of glyphs.
  1466. .. rst-class:: classref-item-separator
  1467. ----
  1468. .. _class_TextServer_method_font_remove_language_support_override:
  1469. .. rst-class:: classref-method
  1470. |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>`
  1471. Remove language support override.
  1472. .. rst-class:: classref-item-separator
  1473. ----
  1474. .. _class_TextServer_method_font_remove_script_support_override:
  1475. .. rst-class:: classref-method
  1476. |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>`
  1477. Removes script support override.
  1478. .. rst-class:: classref-item-separator
  1479. ----
  1480. .. _class_TextServer_method_font_remove_size_cache:
  1481. .. rst-class:: classref-method
  1482. |void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_size_cache>`
  1483. Removes specified font size from the cache entry.
  1484. .. rst-class:: classref-item-separator
  1485. ----
  1486. .. _class_TextServer_method_font_remove_texture:
  1487. .. rst-class:: classref-method
  1488. |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>`
  1489. Removes specified texture from the cache entry.
  1490. \ **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>`.
  1491. .. rst-class:: classref-item-separator
  1492. ----
  1493. .. _class_TextServer_method_font_render_glyph:
  1494. .. rst-class:: classref-method
  1495. |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>`
  1496. Renders specified glyph to the font cache texture.
  1497. .. rst-class:: classref-item-separator
  1498. ----
  1499. .. _class_TextServer_method_font_render_range:
  1500. .. rst-class:: classref-method
  1501. |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>`
  1502. Renders the range of characters to the font cache texture.
  1503. .. rst-class:: classref-item-separator
  1504. ----
  1505. .. _class_TextServer_method_font_set_allow_system_fallback:
  1506. .. rst-class:: classref-method
  1507. |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>`
  1508. If set to ``true``, system fonts can be automatically used as fallbacks.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _class_TextServer_method_font_set_antialiasing:
  1512. .. rst-class:: classref-method
  1513. |void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_antialiasing>`
  1514. Sets font anti-aliasing mode.
  1515. .. rst-class:: classref-item-separator
  1516. ----
  1517. .. _class_TextServer_method_font_set_ascent:
  1518. .. rst-class:: classref-method
  1519. |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>`
  1520. Sets the font ascent (number of pixels above the baseline).
  1521. .. rst-class:: classref-item-separator
  1522. ----
  1523. .. _class_TextServer_method_font_set_baseline_offset:
  1524. .. rst-class:: classref-method
  1525. |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>`
  1526. Sets extra baseline offset (as a fraction of font height).
  1527. .. rst-class:: classref-item-separator
  1528. ----
  1529. .. _class_TextServer_method_font_set_data:
  1530. .. rst-class:: classref-method
  1531. |void| **font_set_data**\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_data>`
  1532. Sets font source data, e.g contents of the dynamic font source file.
  1533. .. rst-class:: classref-item-separator
  1534. ----
  1535. .. _class_TextServer_method_font_set_descent:
  1536. .. rst-class:: classref-method
  1537. |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>`
  1538. Sets the font descent (number of pixels below the baseline).
  1539. .. rst-class:: classref-item-separator
  1540. ----
  1541. .. _class_TextServer_method_font_set_disable_embedded_bitmaps:
  1542. .. rst-class:: classref-method
  1543. |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>`
  1544. If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
  1545. .. rst-class:: classref-item-separator
  1546. ----
  1547. .. _class_TextServer_method_font_set_embolden:
  1548. .. rst-class:: classref-method
  1549. |void| **font_set_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_embolden>`
  1550. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1551. .. rst-class:: classref-item-separator
  1552. ----
  1553. .. _class_TextServer_method_font_set_face_index:
  1554. .. rst-class:: classref-method
  1555. |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>`
  1556. Sets an active face index in the TrueType / OpenType collection.
  1557. .. rst-class:: classref-item-separator
  1558. ----
  1559. .. _class_TextServer_method_font_set_fixed_size:
  1560. .. rst-class:: classref-method
  1561. |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>`
  1562. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1563. .. rst-class:: classref-item-separator
  1564. ----
  1565. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1566. .. rst-class:: classref-method
  1567. |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>`
  1568. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1569. .. rst-class:: classref-item-separator
  1570. ----
  1571. .. _class_TextServer_method_font_set_force_autohinter:
  1572. .. rst-class:: classref-method
  1573. |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>`
  1574. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1575. .. rst-class:: classref-item-separator
  1576. ----
  1577. .. _class_TextServer_method_font_set_generate_mipmaps:
  1578. .. rst-class:: classref-method
  1579. |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>`
  1580. If set to ``true`` font texture mipmap generation is enabled.
  1581. .. rst-class:: classref-item-separator
  1582. ----
  1583. .. _class_TextServer_method_font_set_global_oversampling:
  1584. .. rst-class:: classref-method
  1585. |void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_global_oversampling>`
  1586. Sets oversampling factor, shared by all font in the TextServer.
  1587. \ **Note:** This value can be automatically changed by display server.
  1588. .. rst-class:: classref-item-separator
  1589. ----
  1590. .. _class_TextServer_method_font_set_glyph_advance:
  1591. .. rst-class:: classref-method
  1592. |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>`
  1593. Sets glyph advance (offset of the next glyph).
  1594. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1595. .. rst-class:: classref-item-separator
  1596. ----
  1597. .. _class_TextServer_method_font_set_glyph_offset:
  1598. .. rst-class:: classref-method
  1599. |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>`
  1600. Sets glyph offset from the baseline.
  1601. .. rst-class:: classref-item-separator
  1602. ----
  1603. .. _class_TextServer_method_font_set_glyph_size:
  1604. .. rst-class:: classref-method
  1605. |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>`
  1606. Sets size of the glyph.
  1607. .. rst-class:: classref-item-separator
  1608. ----
  1609. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1610. .. rst-class:: classref-method
  1611. |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>`
  1612. Sets index of the cache texture containing the glyph.
  1613. .. rst-class:: classref-item-separator
  1614. ----
  1615. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1616. .. rst-class:: classref-method
  1617. |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>`
  1618. Sets rectangle in the cache texture containing the glyph.
  1619. .. rst-class:: classref-item-separator
  1620. ----
  1621. .. _class_TextServer_method_font_set_hinting:
  1622. .. rst-class:: classref-method
  1623. |void| **font_set_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_hinting>`
  1624. Sets font hinting mode. Used by dynamic fonts only.
  1625. .. rst-class:: classref-item-separator
  1626. ----
  1627. .. _class_TextServer_method_font_set_keep_rounding_remainders:
  1628. .. rst-class:: classref-method
  1629. |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>`
  1630. 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.
  1631. .. rst-class:: classref-item-separator
  1632. ----
  1633. .. _class_TextServer_method_font_set_kerning:
  1634. .. rst-class:: classref-method
  1635. |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>`
  1636. Sets kerning for the pair of glyphs.
  1637. .. rst-class:: classref-item-separator
  1638. ----
  1639. .. _class_TextServer_method_font_set_language_support_override:
  1640. .. rst-class:: classref-method
  1641. |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>`
  1642. Adds override for :ref:`font_is_language_supported()<class_TextServer_method_font_is_language_supported>`.
  1643. .. rst-class:: classref-item-separator
  1644. ----
  1645. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1646. .. rst-class:: classref-method
  1647. |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>`
  1648. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1649. .. rst-class:: classref-item-separator
  1650. ----
  1651. .. _class_TextServer_method_font_set_msdf_size:
  1652. .. rst-class:: classref-method
  1653. |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>`
  1654. Sets source font size used to generate MSDF textures.
  1655. .. rst-class:: classref-item-separator
  1656. ----
  1657. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1658. .. rst-class:: classref-method
  1659. |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>`
  1660. 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.
  1661. \ **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.
  1662. .. rst-class:: classref-item-separator
  1663. ----
  1664. .. _class_TextServer_method_font_set_name:
  1665. .. rst-class:: classref-method
  1666. |void| **font_set_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_name>`
  1667. Sets the font family name.
  1668. .. rst-class:: classref-item-separator
  1669. ----
  1670. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1671. .. rst-class:: classref-method
  1672. |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>`
  1673. Sets font OpenType feature set override.
  1674. .. rst-class:: classref-item-separator
  1675. ----
  1676. .. _class_TextServer_method_font_set_oversampling:
  1677. .. rst-class:: classref-method
  1678. |void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_oversampling>`
  1679. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1680. .. rst-class:: classref-item-separator
  1681. ----
  1682. .. _class_TextServer_method_font_set_scale:
  1683. .. rst-class:: classref-method
  1684. |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>`
  1685. Sets scaling factor of the color bitmap font.
  1686. .. rst-class:: classref-item-separator
  1687. ----
  1688. .. _class_TextServer_method_font_set_script_support_override:
  1689. .. rst-class:: classref-method
  1690. |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>`
  1691. Adds override for :ref:`font_is_script_supported()<class_TextServer_method_font_is_script_supported>`.
  1692. .. rst-class:: classref-item-separator
  1693. ----
  1694. .. _class_TextServer_method_font_set_spacing:
  1695. .. rst-class:: classref-method
  1696. |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>`
  1697. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1698. .. rst-class:: classref-item-separator
  1699. ----
  1700. .. _class_TextServer_method_font_set_stretch:
  1701. .. rst-class:: classref-method
  1702. |void| **font_set_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_stretch>`
  1703. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1704. \ **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.
  1705. .. rst-class:: classref-item-separator
  1706. ----
  1707. .. _class_TextServer_method_font_set_style:
  1708. .. rst-class:: classref-method
  1709. |void| **font_set_style**\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style>`
  1710. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1711. \ **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.
  1712. .. rst-class:: classref-item-separator
  1713. ----
  1714. .. _class_TextServer_method_font_set_style_name:
  1715. .. rst-class:: classref-method
  1716. |void| **font_set_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style_name>`
  1717. Sets the font style name.
  1718. .. rst-class:: classref-item-separator
  1719. ----
  1720. .. _class_TextServer_method_font_set_subpixel_positioning:
  1721. .. rst-class:: classref-method
  1722. |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>`
  1723. Sets font subpixel glyph positioning mode.
  1724. .. rst-class:: classref-item-separator
  1725. ----
  1726. .. _class_TextServer_method_font_set_texture_image:
  1727. .. rst-class:: classref-method
  1728. |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>`
  1729. Sets font cache texture image data.
  1730. .. rst-class:: classref-item-separator
  1731. ----
  1732. .. _class_TextServer_method_font_set_texture_offsets:
  1733. .. rst-class:: classref-method
  1734. |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>`
  1735. Sets array containing glyph packing data.
  1736. .. rst-class:: classref-item-separator
  1737. ----
  1738. .. _class_TextServer_method_font_set_transform:
  1739. .. rst-class:: classref-method
  1740. |void| **font_set_transform**\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_transform>`
  1741. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
  1742. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1743. .. rst-class:: classref-item-separator
  1744. ----
  1745. .. _class_TextServer_method_font_set_underline_position:
  1746. .. rst-class:: classref-method
  1747. |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>`
  1748. Sets pixel offset of the underline below the baseline.
  1749. .. rst-class:: classref-item-separator
  1750. ----
  1751. .. _class_TextServer_method_font_set_underline_thickness:
  1752. .. rst-class:: classref-method
  1753. |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>`
  1754. Sets thickness of the underline in pixels.
  1755. .. rst-class:: classref-item-separator
  1756. ----
  1757. .. _class_TextServer_method_font_set_variation_coordinates:
  1758. .. rst-class:: classref-method
  1759. |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>`
  1760. 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.
  1761. .. rst-class:: classref-item-separator
  1762. ----
  1763. .. _class_TextServer_method_font_set_weight:
  1764. .. rst-class:: classref-method
  1765. |void| **font_set_weight**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_weight>`
  1766. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1767. \ **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.
  1768. .. rst-class:: classref-item-separator
  1769. ----
  1770. .. _class_TextServer_method_font_supported_feature_list:
  1771. .. rst-class:: classref-method
  1772. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_feature_list>`
  1773. Returns the dictionary of the supported OpenType features.
  1774. .. rst-class:: classref-item-separator
  1775. ----
  1776. .. _class_TextServer_method_font_supported_variation_list:
  1777. .. rst-class:: classref-method
  1778. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_variation_list>`
  1779. Returns the dictionary of the supported OpenType variation coordinates.
  1780. .. rst-class:: classref-item-separator
  1781. ----
  1782. .. _class_TextServer_method_format_number:
  1783. .. rst-class:: classref-method
  1784. :ref:`String<class_String>` **format_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_format_number>`
  1785. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1786. If ``language`` is omitted, the active locale will be used.
  1787. .. rst-class:: classref-item-separator
  1788. ----
  1789. .. _class_TextServer_method_free_rid:
  1790. .. rst-class:: classref-method
  1791. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_free_rid>`
  1792. Frees an object created by this **TextServer**.
  1793. .. rst-class:: classref-item-separator
  1794. ----
  1795. .. _class_TextServer_method_get_features:
  1796. .. rst-class:: classref-method
  1797. :ref:`int<class_int>` **get_features**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_features>`
  1798. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1799. .. rst-class:: classref-item-separator
  1800. ----
  1801. .. _class_TextServer_method_get_hex_code_box_size:
  1802. .. rst-class:: classref-method
  1803. :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>`
  1804. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1805. .. rst-class:: classref-item-separator
  1806. ----
  1807. .. _class_TextServer_method_get_name:
  1808. .. rst-class:: classref-method
  1809. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_name>`
  1810. Returns the name of the server interface.
  1811. .. rst-class:: classref-item-separator
  1812. ----
  1813. .. _class_TextServer_method_get_support_data:
  1814. .. rst-class:: classref-method
  1815. :ref:`PackedByteArray<class_PackedByteArray>` **get_support_data**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data>`
  1816. Returns default TextServer database (e.g. ICU break iterators and dictionaries).
  1817. .. rst-class:: classref-item-separator
  1818. ----
  1819. .. _class_TextServer_method_get_support_data_filename:
  1820. .. rst-class:: classref-method
  1821. :ref:`String<class_String>` **get_support_data_filename**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_filename>`
  1822. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _class_TextServer_method_get_support_data_info:
  1826. .. rst-class:: classref-method
  1827. :ref:`String<class_String>` **get_support_data_info**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_info>`
  1828. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1829. .. rst-class:: classref-item-separator
  1830. ----
  1831. .. _class_TextServer_method_has:
  1832. .. rst-class:: classref-method
  1833. :ref:`bool<class_bool>` **has**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_has>`
  1834. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1835. .. rst-class:: classref-item-separator
  1836. ----
  1837. .. _class_TextServer_method_has_feature:
  1838. .. rst-class:: classref-method
  1839. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_has_feature>`
  1840. Returns ``true`` if the server supports a feature.
  1841. .. rst-class:: classref-item-separator
  1842. ----
  1843. .. _class_TextServer_method_is_confusable:
  1844. .. rst-class:: classref-method
  1845. :ref:`int<class_int>` **is_confusable**\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_confusable>`
  1846. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1847. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check()<class_TextServer_method_spoof_check>`.
  1848. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1849. .. rst-class:: classref-item-separator
  1850. ----
  1851. .. _class_TextServer_method_is_locale_right_to_left:
  1852. .. rst-class:: classref-method
  1853. :ref:`bool<class_bool>` **is_locale_right_to_left**\ (\ locale\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_locale_right_to_left>`
  1854. Returns ``true`` if locale is right-to-left.
  1855. .. rst-class:: classref-item-separator
  1856. ----
  1857. .. _class_TextServer_method_is_valid_identifier:
  1858. .. rst-class:: classref-method
  1859. :ref:`bool<class_bool>` **is_valid_identifier**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_identifier>`
  1860. Returns ``true`` if ``string`` is a valid identifier.
  1861. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1862. - Conform to normalization form C.
  1863. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1864. - May contain Unicode characters of class XID_Continue in the other positions.
  1865. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1866. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1867. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1868. - May contain Unicode characters of class XID_Continue in the other positions.
  1869. .. rst-class:: classref-item-separator
  1870. ----
  1871. .. _class_TextServer_method_is_valid_letter:
  1872. .. rst-class:: classref-method
  1873. :ref:`bool<class_bool>` **is_valid_letter**\ (\ unicode\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_letter>`
  1874. Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L".
  1875. .. rst-class:: classref-item-separator
  1876. ----
  1877. .. _class_TextServer_method_load_support_data:
  1878. .. rst-class:: classref-method
  1879. :ref:`bool<class_bool>` **load_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_load_support_data>`
  1880. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1881. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1882. .. rst-class:: classref-item-separator
  1883. ----
  1884. .. _class_TextServer_method_name_to_tag:
  1885. .. rst-class:: classref-method
  1886. :ref:`int<class_int>` **name_to_tag**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_name_to_tag>`
  1887. Converts readable feature, variation, script, or language name to OpenType tag.
  1888. .. rst-class:: classref-item-separator
  1889. ----
  1890. .. _class_TextServer_method_parse_number:
  1891. .. rst-class:: classref-method
  1892. :ref:`String<class_String>` **parse_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_number>`
  1893. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1894. .. rst-class:: classref-item-separator
  1895. ----
  1896. .. _class_TextServer_method_parse_structured_text:
  1897. .. rst-class:: classref-method
  1898. :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>`
  1899. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1900. .. rst-class:: classref-item-separator
  1901. ----
  1902. .. _class_TextServer_method_percent_sign:
  1903. .. rst-class:: classref-method
  1904. :ref:`String<class_String>` **percent_sign**\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_percent_sign>`
  1905. Returns percent sign used in the ``language``.
  1906. .. rst-class:: classref-item-separator
  1907. ----
  1908. .. _class_TextServer_method_save_support_data:
  1909. .. rst-class:: classref-method
  1910. :ref:`bool<class_bool>` **save_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_save_support_data>`
  1911. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1912. \ **Note:** This function is used by during project export, to include TextServer database.
  1913. .. rst-class:: classref-item-separator
  1914. ----
  1915. .. _class_TextServer_method_shaped_get_span_count:
  1916. .. rst-class:: classref-method
  1917. :ref:`int<class_int>` **shaped_get_span_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_count>`
  1918. 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>`.
  1919. .. rst-class:: classref-item-separator
  1920. ----
  1921. .. _class_TextServer_method_shaped_get_span_embedded_object:
  1922. .. rst-class:: classref-method
  1923. :ref:`Variant<class_Variant>` **shaped_get_span_embedded_object**\ (\ shaped\: :ref:`RID<class_RID>`, index\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_embedded_object>`
  1924. Returns text embedded object key.
  1925. .. rst-class:: classref-item-separator
  1926. ----
  1927. .. _class_TextServer_method_shaped_get_span_meta:
  1928. .. rst-class:: classref-method
  1929. :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>`
  1930. Returns text span metadata.
  1931. .. rst-class:: classref-item-separator
  1932. ----
  1933. .. _class_TextServer_method_shaped_set_span_update_font:
  1934. .. rst-class:: classref-method
  1935. |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>`
  1936. Changes text span font, font size, and OpenType features, without changing the text.
  1937. .. rst-class:: classref-item-separator
  1938. ----
  1939. .. _class_TextServer_method_shaped_text_add_object:
  1940. .. rst-class:: classref-method
  1941. :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>`
  1942. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1943. .. rst-class:: classref-item-separator
  1944. ----
  1945. .. _class_TextServer_method_shaped_text_add_string:
  1946. .. rst-class:: classref-method
  1947. :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>`
  1948. Adds text span and font to draw it to the text buffer.
  1949. .. rst-class:: classref-item-separator
  1950. ----
  1951. .. _class_TextServer_method_shaped_text_clear:
  1952. .. rst-class:: classref-method
  1953. |void| **shaped_text_clear**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_clear>`
  1954. Clears text buffer (removes text and inline objects).
  1955. .. rst-class:: classref-item-separator
  1956. ----
  1957. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1958. .. rst-class:: classref-method
  1959. :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>`
  1960. Returns composite character position closest to the ``pos``.
  1961. .. rst-class:: classref-item-separator
  1962. ----
  1963. .. _class_TextServer_method_shaped_text_draw:
  1964. .. rst-class:: classref-method
  1965. |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>`
  1966. 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).
  1967. .. rst-class:: classref-item-separator
  1968. ----
  1969. .. _class_TextServer_method_shaped_text_draw_outline:
  1970. .. rst-class:: classref-method
  1971. |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>`
  1972. 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).
  1973. .. rst-class:: classref-item-separator
  1974. ----
  1975. .. _class_TextServer_method_shaped_text_fit_to_width:
  1976. .. rst-class:: classref-method
  1977. :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>`
  1978. Adjusts text width to fit to specified width, returns new text width.
  1979. .. rst-class:: classref-item-separator
  1980. ----
  1981. .. _class_TextServer_method_shaped_text_get_ascent:
  1982. .. rst-class:: classref-method
  1983. :ref:`float<class_float>` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ascent>`
  1984. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1985. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1986. .. rst-class:: classref-item-separator
  1987. ----
  1988. .. _class_TextServer_method_shaped_text_get_carets:
  1989. .. rst-class:: classref-method
  1990. :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>`
  1991. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1992. .. rst-class:: classref-item-separator
  1993. ----
  1994. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1995. .. rst-class:: classref-method
  1996. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_character_breaks>`
  1997. Returns array of the composite character boundaries.
  1998. .. rst-class:: classref-item-separator
  1999. ----
  2000. .. _class_TextServer_method_shaped_text_get_custom_ellipsis:
  2001. .. rst-class:: classref-method
  2002. :ref:`int<class_int>` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_ellipsis>`
  2003. Returns ellipsis character used for text clipping.
  2004. .. rst-class:: classref-item-separator
  2005. ----
  2006. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  2007. .. rst-class:: classref-method
  2008. :ref:`String<class_String>` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_punctuation>`
  2009. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2010. .. rst-class:: classref-item-separator
  2011. ----
  2012. .. _class_TextServer_method_shaped_text_get_descent:
  2013. .. rst-class:: classref-method
  2014. :ref:`float<class_float>` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_descent>`
  2015. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  2016. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  2017. .. rst-class:: classref-item-separator
  2018. ----
  2019. .. _class_TextServer_method_shaped_text_get_direction:
  2020. .. rst-class:: classref-method
  2021. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_direction>`
  2022. Returns direction of the text.
  2023. .. rst-class:: classref-item-separator
  2024. ----
  2025. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  2026. .. rst-class:: classref-method
  2027. :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>`
  2028. Returns dominant direction of in the range of text.
  2029. .. rst-class:: classref-item-separator
  2030. ----
  2031. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  2032. .. rst-class:: classref-method
  2033. :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>`
  2034. Returns number of glyphs in the ellipsis.
  2035. .. rst-class:: classref-item-separator
  2036. ----
  2037. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  2038. .. rst-class:: classref-method
  2039. :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>`
  2040. Returns array of the glyphs in the ellipsis.
  2041. .. rst-class:: classref-item-separator
  2042. ----
  2043. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  2044. .. rst-class:: classref-method
  2045. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_pos>`
  2046. Returns position of the ellipsis.
  2047. .. rst-class:: classref-item-separator
  2048. ----
  2049. .. _class_TextServer_method_shaped_text_get_glyph_count:
  2050. .. rst-class:: classref-method
  2051. :ref:`int<class_int>` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyph_count>`
  2052. Returns number of glyphs in the buffer.
  2053. .. rst-class:: classref-item-separator
  2054. ----
  2055. .. _class_TextServer_method_shaped_text_get_glyphs:
  2056. .. rst-class:: classref-method
  2057. :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>`
  2058. Returns an array of glyphs in the visual order.
  2059. .. rst-class:: classref-item-separator
  2060. ----
  2061. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  2062. .. rst-class:: classref-method
  2063. :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>`
  2064. Returns composite character's bounds as offsets from the start of the line.
  2065. .. rst-class:: classref-item-separator
  2066. ----
  2067. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  2068. .. rst-class:: classref-method
  2069. :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>`
  2070. Returns direction of the text, inferred by the BiDi algorithm.
  2071. .. rst-class:: classref-item-separator
  2072. ----
  2073. .. _class_TextServer_method_shaped_text_get_line_breaks:
  2074. .. rst-class:: classref-method
  2075. :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>`
  2076. Breaks text to the lines and returns character ranges for each line.
  2077. .. rst-class:: classref-item-separator
  2078. ----
  2079. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  2080. .. rst-class:: classref-method
  2081. :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>`
  2082. Breaks text to the lines and columns. Returns character ranges for each segment.
  2083. .. rst-class:: classref-item-separator
  2084. ----
  2085. .. _class_TextServer_method_shaped_text_get_object_glyph:
  2086. .. rst-class:: classref-method
  2087. :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>`
  2088. Returns the glyph index of the inline object.
  2089. .. rst-class:: classref-item-separator
  2090. ----
  2091. .. _class_TextServer_method_shaped_text_get_object_range:
  2092. .. rst-class:: classref-method
  2093. :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>`
  2094. Returns the character range of the inline object.
  2095. .. rst-class:: classref-item-separator
  2096. ----
  2097. .. _class_TextServer_method_shaped_text_get_object_rect:
  2098. .. rst-class:: classref-method
  2099. :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>`
  2100. Returns bounding rectangle of the inline object.
  2101. .. rst-class:: classref-item-separator
  2102. ----
  2103. .. _class_TextServer_method_shaped_text_get_objects:
  2104. .. rst-class:: classref-method
  2105. :ref:`Array<class_Array>` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_objects>`
  2106. Returns array of inline objects.
  2107. .. rst-class:: classref-item-separator
  2108. ----
  2109. .. _class_TextServer_method_shaped_text_get_orientation:
  2110. .. rst-class:: classref-method
  2111. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_orientation>`
  2112. Returns text orientation.
  2113. .. rst-class:: classref-item-separator
  2114. ----
  2115. .. _class_TextServer_method_shaped_text_get_parent:
  2116. .. rst-class:: classref-method
  2117. :ref:`RID<class_RID>` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_parent>`
  2118. Returns the parent buffer from which the substring originates.
  2119. .. rst-class:: classref-item-separator
  2120. ----
  2121. .. _class_TextServer_method_shaped_text_get_preserve_control:
  2122. .. rst-class:: classref-method
  2123. :ref:`bool<class_bool>` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_control>`
  2124. Returns ``true`` if text buffer is configured to display control characters.
  2125. .. rst-class:: classref-item-separator
  2126. ----
  2127. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  2128. .. rst-class:: classref-method
  2129. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_invalid>`
  2130. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2131. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2132. .. rst-class:: classref-item-separator
  2133. ----
  2134. .. _class_TextServer_method_shaped_text_get_range:
  2135. .. rst-class:: classref-method
  2136. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_range>`
  2137. Returns substring buffer character range in the parent buffer.
  2138. .. rst-class:: classref-item-separator
  2139. ----
  2140. .. _class_TextServer_method_shaped_text_get_selection:
  2141. .. rst-class:: classref-method
  2142. :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>`
  2143. Returns selection rectangles for the specified character range.
  2144. .. rst-class:: classref-item-separator
  2145. ----
  2146. .. _class_TextServer_method_shaped_text_get_size:
  2147. .. rst-class:: classref-method
  2148. :ref:`Vector2<class_Vector2>` **shaped_text_get_size**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_size>`
  2149. Returns size of the text.
  2150. .. rst-class:: classref-item-separator
  2151. ----
  2152. .. _class_TextServer_method_shaped_text_get_spacing:
  2153. .. rst-class:: classref-method
  2154. :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>`
  2155. Returns extra spacing added between glyphs or lines in pixels.
  2156. .. rst-class:: classref-item-separator
  2157. ----
  2158. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2159. .. rst-class:: classref-method
  2160. :ref:`int<class_int>` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_trim_pos>`
  2161. Returns the position of the overrun trim.
  2162. .. rst-class:: classref-item-separator
  2163. ----
  2164. .. _class_TextServer_method_shaped_text_get_underline_position:
  2165. .. rst-class:: classref-method
  2166. :ref:`float<class_float>` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_position>`
  2167. Returns pixel offset of the underline below the baseline.
  2168. .. rst-class:: classref-item-separator
  2169. ----
  2170. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2171. .. rst-class:: classref-method
  2172. :ref:`float<class_float>` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_thickness>`
  2173. Returns thickness of the underline.
  2174. .. rst-class:: classref-item-separator
  2175. ----
  2176. .. _class_TextServer_method_shaped_text_get_width:
  2177. .. rst-class:: classref-method
  2178. :ref:`float<class_float>` **shaped_text_get_width**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_width>`
  2179. Returns width (for horizontal layout) or height (for vertical) of the text.
  2180. .. rst-class:: classref-item-separator
  2181. ----
  2182. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2183. .. rst-class:: classref-method
  2184. :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>`
  2185. 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>`).
  2186. .. rst-class:: classref-item-separator
  2187. ----
  2188. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2189. .. rst-class:: classref-method
  2190. :ref:`bool<class_bool>` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_has_visible_chars>`
  2191. Returns ``true`` if text buffer contains any visible characters.
  2192. .. rst-class:: classref-item-separator
  2193. ----
  2194. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2195. .. rst-class:: classref-method
  2196. :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>`
  2197. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2198. .. rst-class:: classref-item-separator
  2199. ----
  2200. .. _class_TextServer_method_shaped_text_hit_test_position:
  2201. .. rst-class:: classref-method
  2202. :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>`
  2203. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2204. .. rst-class:: classref-item-separator
  2205. ----
  2206. .. _class_TextServer_method_shaped_text_is_ready:
  2207. .. rst-class:: classref-method
  2208. :ref:`bool<class_bool>` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_is_ready>`
  2209. Returns ``true`` if buffer is successfully shaped.
  2210. .. rst-class:: classref-item-separator
  2211. ----
  2212. .. _class_TextServer_method_shaped_text_next_character_pos:
  2213. .. rst-class:: classref-method
  2214. :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>`
  2215. Returns composite character end position closest to the ``pos``.
  2216. .. rst-class:: classref-item-separator
  2217. ----
  2218. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2219. .. rst-class:: classref-method
  2220. :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>`
  2221. Returns grapheme end position closest to the ``pos``.
  2222. .. rst-class:: classref-item-separator
  2223. ----
  2224. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2225. .. rst-class:: classref-method
  2226. |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>`
  2227. Trims text if it exceeds the given width.
  2228. .. rst-class:: classref-item-separator
  2229. ----
  2230. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2231. .. rst-class:: classref-method
  2232. :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>`
  2233. Returns composite character start position closest to the ``pos``.
  2234. .. rst-class:: classref-item-separator
  2235. ----
  2236. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2237. .. rst-class:: classref-method
  2238. :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>`
  2239. Returns grapheme start position closest to the ``pos``.
  2240. .. rst-class:: classref-item-separator
  2241. ----
  2242. .. _class_TextServer_method_shaped_text_resize_object:
  2243. .. rst-class:: classref-method
  2244. :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>`
  2245. Sets new size and alignment of embedded object.
  2246. .. rst-class:: classref-item-separator
  2247. ----
  2248. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2249. .. rst-class:: classref-method
  2250. |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>`
  2251. Overrides BiDi for the structured text.
  2252. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2253. .. rst-class:: classref-item-separator
  2254. ----
  2255. .. _class_TextServer_method_shaped_text_set_custom_ellipsis:
  2256. .. rst-class:: classref-method
  2257. |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>`
  2258. Sets ellipsis character used for text clipping.
  2259. .. rst-class:: classref-item-separator
  2260. ----
  2261. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2262. .. rst-class:: classref-method
  2263. |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>`
  2264. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2265. .. rst-class:: classref-item-separator
  2266. ----
  2267. .. _class_TextServer_method_shaped_text_set_direction:
  2268. .. rst-class:: classref-method
  2269. |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>`
  2270. 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.
  2271. \ **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>`).
  2272. .. rst-class:: classref-item-separator
  2273. ----
  2274. .. _class_TextServer_method_shaped_text_set_orientation:
  2275. .. rst-class:: classref-method
  2276. |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>`
  2277. Sets desired text orientation.
  2278. \ **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>`).
  2279. .. rst-class:: classref-item-separator
  2280. ----
  2281. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2282. .. rst-class:: classref-method
  2283. |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>`
  2284. If set to ``true`` text buffer will display control characters.
  2285. .. rst-class:: classref-item-separator
  2286. ----
  2287. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2288. .. rst-class:: classref-method
  2289. |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>`
  2290. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2291. .. rst-class:: classref-item-separator
  2292. ----
  2293. .. _class_TextServer_method_shaped_text_set_spacing:
  2294. .. rst-class:: classref-method
  2295. |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>`
  2296. Sets extra spacing added between glyphs or lines in pixels.
  2297. .. rst-class:: classref-item-separator
  2298. ----
  2299. .. _class_TextServer_method_shaped_text_shape:
  2300. .. rst-class:: classref-method
  2301. :ref:`bool<class_bool>` **shaped_text_shape**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_shape>`
  2302. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2303. \ **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.
  2304. .. rst-class:: classref-item-separator
  2305. ----
  2306. .. _class_TextServer_method_shaped_text_sort_logical:
  2307. .. rst-class:: classref-method
  2308. :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>`
  2309. Returns text glyphs in the logical order.
  2310. .. rst-class:: classref-item-separator
  2311. ----
  2312. .. _class_TextServer_method_shaped_text_substr:
  2313. .. rst-class:: classref-method
  2314. :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>`
  2315. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2316. .. rst-class:: classref-item-separator
  2317. ----
  2318. .. _class_TextServer_method_shaped_text_tab_align:
  2319. .. rst-class:: classref-method
  2320. :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>`
  2321. Aligns shaped text to the given tab-stops.
  2322. .. rst-class:: classref-item-separator
  2323. ----
  2324. .. _class_TextServer_method_spoof_check:
  2325. .. rst-class:: classref-method
  2326. :ref:`bool<class_bool>` **spoof_check**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_spoof_check>`
  2327. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2328. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2329. .. rst-class:: classref-item-separator
  2330. ----
  2331. .. _class_TextServer_method_string_get_character_breaks:
  2332. .. rst-class:: classref-method
  2333. :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>`
  2334. Returns array of the composite character boundaries.
  2335. ::
  2336. var ts = TextServerManager.get_primary_interface()
  2337. print(ts.string_get_character_breaks("Test โค๏ธโ€๐Ÿ”ฅ Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2338. .. rst-class:: classref-item-separator
  2339. ----
  2340. .. _class_TextServer_method_string_get_word_breaks:
  2341. .. rst-class:: classref-method
  2342. :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>`
  2343. 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.
  2344. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2345. ::
  2346. var ts = TextServerManager.get_primary_interface()
  2347. # Corresponds to the substrings "The", "Godot", "Engine", and "4".
  2348. print(ts.string_get_word_breaks("The Godot Engine, 4")) # Prints [0, 3, 4, 9, 10, 16, 18, 19]
  2349. # Corresponds to the substrings "The", "Godot", "Engin", and "e, 4".
  2350. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 5)) # Prints [0, 3, 4, 9, 10, 15, 15, 19]
  2351. # Corresponds to the substrings "The Godot" and "Engine, 4".
  2352. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 10)) # Prints [0, 9, 10, 19]
  2353. .. rst-class:: classref-item-separator
  2354. ----
  2355. .. _class_TextServer_method_string_to_lower:
  2356. .. rst-class:: classref-method
  2357. :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>`
  2358. Returns the string converted to lowercase.
  2359. \ **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>`).
  2360. \ **Note:** The result may be longer or shorter than the original.
  2361. .. rst-class:: classref-item-separator
  2362. ----
  2363. .. _class_TextServer_method_string_to_title:
  2364. .. rst-class:: classref-method
  2365. :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>`
  2366. Returns the string converted to title case.
  2367. \ **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>`).
  2368. \ **Note:** The result may be longer or shorter than the original.
  2369. .. rst-class:: classref-item-separator
  2370. ----
  2371. .. _class_TextServer_method_string_to_upper:
  2372. .. rst-class:: classref-method
  2373. :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>`
  2374. Returns the string converted to uppercase.
  2375. \ **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>`).
  2376. \ **Note:** The result may be longer or shorter than the original.
  2377. .. rst-class:: classref-item-separator
  2378. ----
  2379. .. _class_TextServer_method_strip_diacritics:
  2380. .. rst-class:: classref-method
  2381. :ref:`String<class_String>` **strip_diacritics**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_strip_diacritics>`
  2382. Strips diacritics from the string.
  2383. \ **Note:** The result may be longer or shorter than the original.
  2384. .. rst-class:: classref-item-separator
  2385. ----
  2386. .. _class_TextServer_method_tag_to_name:
  2387. .. rst-class:: classref-method
  2388. :ref:`String<class_String>` **tag_to_name**\ (\ tag\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_tag_to_name>`
  2389. Converts OpenType tag to readable feature, variation, script, or language name.
  2390. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2391. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2392. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2393. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2394. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2395. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2396. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2397. .. |void| replace:: :abbr:`void (No return value.)`