class_textserver.rst 326 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266
  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:`Vector2<class_Vector2>` | :ref:`font_get_kerning<class_TextServer_method_font_get_kerning>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`, glyph_pair\: :ref:`Vector2i<class_Vector2i>`\ ) |const| |
  98. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  99. | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  100. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  101. | :ref:`bool<class_bool>` | :ref:`font_get_language_support_override<class_TextServer_method_font_get_language_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, language\: :ref:`String<class_String>`\ ) |
  102. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  103. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  104. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  105. | :ref:`int<class_int>` | :ref:`font_get_msdf_pixel_range<class_TextServer_method_font_get_msdf_pixel_range>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  106. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  107. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  108. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  109. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  110. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  111. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_opentype_feature_overrides<class_TextServer_method_font_get_opentype_feature_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  112. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  113. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_ot_name_strings<class_TextServer_method_font_get_ot_name_strings>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  114. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  115. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  116. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  117. | :ref:`float<class_float>` | :ref:`font_get_scale<class_TextServer_method_font_get_scale>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) |const| |
  118. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  119. | :ref:`bool<class_bool>` | :ref:`font_get_script_support_override<class_TextServer_method_font_get_script_support_override>`\ (\ font_rid\: :ref:`RID<class_RID>`, script\: :ref:`String<class_String>`\ ) |
  120. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  121. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |
  122. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  123. | :ref:`Array<class_Array>`\[:ref:`Vector2i<class_Vector2i>`\] | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  124. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  125. | :ref:`int<class_int>` | :ref:`font_get_spacing<class_TextServer_method_font_get_spacing>`\ (\ font_rid\: :ref:`RID<class_RID>`, spacing\: :ref:`SpacingType<enum_TextServer_SpacingType>`\ ) |const| |
  126. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  127. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  128. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  129. | |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] | :ref:`font_get_style<class_TextServer_method_font_get_style>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  130. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  131. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  132. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  133. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  134. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  135. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  136. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  137. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_supported_glyphs<class_TextServer_method_font_get_supported_glyphs>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  138. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  139. | :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| |
  140. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  141. | :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| |
  142. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  143. | :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| |
  144. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  145. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  146. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  147. | :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| |
  148. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  149. | :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| |
  150. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  151. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  152. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  153. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  154. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  155. | :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| |
  156. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  157. | :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| |
  158. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  159. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  160. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  161. | :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| |
  162. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  163. | :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| |
  164. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  165. | :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| |
  166. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  167. | |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>`\ ) |
  168. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  169. | |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>`\ ) |
  170. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  171. | |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>`\ ) |
  172. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  173. | |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>`\ ) |
  174. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  175. | |void| | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>`\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) |
  176. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  177. | |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>`\ ) |
  178. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  179. | |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>`\ ) |
  180. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  181. | |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>`\ ) |
  182. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  183. | |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>`\ ) |
  184. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  185. | |void| | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>`\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) |
  186. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  187. | |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>`\ ) |
  188. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  189. | |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>`\ ) |
  190. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  191. | |void| | :ref:`font_set_data<class_TextServer_method_font_set_data>`\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) |
  192. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  193. | |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>`\ ) |
  194. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  195. | |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>`\ ) |
  196. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  197. | |void| | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>`\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) |
  198. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  199. | |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>`\ ) |
  200. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  201. | |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>`\ ) |
  202. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  203. | |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>`\ ) |
  204. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  205. | |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>`\ ) |
  206. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  207. | |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>`\ ) |
  208. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  209. | |void| | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>`\ (\ oversampling\: :ref:`float<class_float>`\ ) |
  210. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  211. | |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>`\ ) |
  212. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  213. | |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>`\ ) |
  214. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  215. | |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>`\ ) |
  216. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  217. | |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>`\ ) |
  218. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  219. | |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>`\ ) |
  220. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  221. | |void| | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>`\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) |
  222. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  223. | |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>`\ ) |
  224. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  225. | |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>`\ ) |
  226. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  227. | |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>`\ ) |
  228. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  229. | |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>`\ ) |
  230. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  231. | |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>`\ ) |
  232. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  233. | |void| | :ref:`font_set_name<class_TextServer_method_font_set_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  234. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  235. | |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>`\ ) |
  236. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  237. | |void| | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>`\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) |
  238. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  239. | |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>`\ ) |
  240. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  241. | |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>`\ ) |
  242. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  243. | |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>`\ ) |
  244. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  245. | |void| | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  246. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  247. | |void| | :ref:`font_set_style<class_TextServer_method_font_set_style>`\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) |
  248. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  249. | |void| | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>`\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) |
  250. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  251. | |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>`\ ) |
  252. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  253. | |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>`\ ) |
  254. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  255. | |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>`\ ) |
  256. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  257. | |void| | :ref:`font_set_transform<class_TextServer_method_font_set_transform>`\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) |
  258. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  259. | |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>`\ ) |
  260. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  261. | |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>`\ ) |
  262. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  263. | |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>`\ ) |
  264. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  265. | |void| | :ref:`font_set_weight<class_TextServer_method_font_set_weight>`\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) |
  266. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  267. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  268. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  269. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>`\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| |
  270. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  271. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  272. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  273. | |void| | :ref:`free_rid<class_TextServer_method_free_rid>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  274. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  275. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>`\ (\ ) |const| |
  276. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  277. | :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| |
  278. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  279. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>`\ (\ ) |const| |
  280. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  281. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>`\ (\ ) |const| |
  282. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  283. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>`\ (\ ) |const| |
  284. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  285. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  286. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  287. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>`\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| |
  288. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  289. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>`\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| |
  290. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  291. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>`\ (\ locale\: :ref:`String<class_String>`\ ) |const| |
  292. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  293. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  294. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  295. | :ref:`bool<class_bool>` | :ref:`is_valid_letter<class_TextServer_method_is_valid_letter>`\ (\ unicode\: :ref:`int<class_int>`\ ) |const| |
  296. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  297. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |
  298. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  299. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>`\ (\ name\: :ref:`String<class_String>`\ ) |const| |
  300. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  301. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>`\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| |
  302. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  303. | :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| |
  304. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  305. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>`\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| |
  306. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  307. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>`\ (\ filename\: :ref:`String<class_String>`\ ) |const| |
  308. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  309. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  310. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  311. | :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| |
  312. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  313. | |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>` = {}\ ) |
  314. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  315. | :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\ ) |
  316. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  317. | :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\ ) |
  318. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  319. | |void| | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>`\ (\ rid\: :ref:`RID<class_RID>`\ ) |
  320. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  321. | :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| |
  322. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  323. | |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| |
  324. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  325. | |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| |
  326. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  327. | :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\ ) |
  328. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  329. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  330. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  331. | :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| |
  332. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  333. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  334. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  335. | :ref:`int<class_int>` | :ref:`shaped_text_get_custom_ellipsis<class_TextServer_method_shaped_text_get_custom_ellipsis>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  336. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  337. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  338. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  339. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  340. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  341. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  342. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  343. | :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| |
  344. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  345. | :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| |
  346. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  347. | :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| |
  348. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  349. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  350. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  351. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  352. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  353. | :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| |
  354. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  355. | :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| |
  356. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  357. | :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| |
  358. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  359. | :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| |
  360. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  361. | :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| |
  362. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  363. | :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| |
  364. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  365. | :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| |
  366. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  367. | :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| |
  368. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  369. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  370. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  371. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  372. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  373. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  374. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  375. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  376. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  377. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  378. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  379. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  380. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  381. | :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| |
  382. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  383. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  384. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  385. | :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| |
  386. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  387. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  388. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  389. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  390. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  391. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  392. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  393. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  394. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  395. | :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| |
  396. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  397. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  398. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  399. | :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| |
  400. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  401. | :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| |
  402. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  403. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| |
  404. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  405. | :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| |
  406. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  407. | :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| |
  408. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  409. | |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\ ) |
  410. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  411. | :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| |
  412. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  413. | :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| |
  414. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  415. | :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\ ) |
  416. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  417. | |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>`\ ) |
  418. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  419. | |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>`\ ) |
  420. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  421. | |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>`\ ) |
  422. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  423. | |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\ ) |
  424. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  425. | |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\ ) |
  426. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  427. | |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>`\ ) |
  428. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  429. | |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>`\ ) |
  430. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  431. | |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>`\ ) |
  432. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  433. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>`\ (\ shaped\: :ref:`RID<class_RID>`\ ) |
  434. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  435. | :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>`\ ) |
  436. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  437. | :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| |
  438. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  439. | :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>`\ ) |
  440. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  441. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  442. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  443. | :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| |
  444. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  445. | :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| |
  446. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  447. | :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| |
  448. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  449. | :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| |
  450. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  451. | :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| |
  452. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  453. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>`\ (\ string\: :ref:`String<class_String>`\ ) |const| |
  454. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  455. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>`\ (\ tag\: :ref:`int<class_int>`\ ) |const| |
  456. +------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  457. .. rst-class:: classref-section-separator
  458. ----
  459. .. rst-class:: classref-descriptions-group
  460. Enumerations
  461. ------------
  462. .. _enum_TextServer_FontAntialiasing:
  463. .. rst-class:: classref-enumeration
  464. enum **FontAntialiasing**: :ref:`๐Ÿ”—<enum_TextServer_FontAntialiasing>`
  465. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  466. .. rst-class:: classref-enumeration-constant
  467. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  468. Font glyphs are rasterized as 1-bit bitmaps.
  469. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  470. .. rst-class:: classref-enumeration-constant
  471. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  472. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  473. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  474. .. rst-class:: classref-enumeration-constant
  475. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  476. Font glyphs are rasterized for LCD screens.
  477. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  478. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  479. .. rst-class:: classref-item-separator
  480. ----
  481. .. _enum_TextServer_FontLCDSubpixelLayout:
  482. .. rst-class:: classref-enumeration
  483. enum **FontLCDSubpixelLayout**: :ref:`๐Ÿ”—<enum_TextServer_FontLCDSubpixelLayout>`
  484. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  485. .. rst-class:: classref-enumeration-constant
  486. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  487. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  488. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  489. .. rst-class:: classref-enumeration-constant
  490. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  491. Horizontal RGB subpixel layout.
  492. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  493. .. rst-class:: classref-enumeration-constant
  494. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  495. Horizontal BGR subpixel layout.
  496. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  497. .. rst-class:: classref-enumeration-constant
  498. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  499. Vertical RGB subpixel layout.
  500. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  501. .. rst-class:: classref-enumeration-constant
  502. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  503. Vertical BGR subpixel layout.
  504. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  505. .. rst-class:: classref-enumeration-constant
  506. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  507. Represents the size of the :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` enum.
  508. .. rst-class:: classref-item-separator
  509. ----
  510. .. _enum_TextServer_Direction:
  511. .. rst-class:: classref-enumeration
  512. enum **Direction**: :ref:`๐Ÿ”—<enum_TextServer_Direction>`
  513. .. _class_TextServer_constant_DIRECTION_AUTO:
  514. .. rst-class:: classref-enumeration-constant
  515. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  516. Text direction is determined based on contents and current locale.
  517. .. _class_TextServer_constant_DIRECTION_LTR:
  518. .. rst-class:: classref-enumeration-constant
  519. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  520. Text is written from left to right.
  521. .. _class_TextServer_constant_DIRECTION_RTL:
  522. .. rst-class:: classref-enumeration-constant
  523. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  524. Text is written from right to left.
  525. .. _class_TextServer_constant_DIRECTION_INHERITED:
  526. .. rst-class:: classref-enumeration-constant
  527. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  528. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  529. .. rst-class:: classref-item-separator
  530. ----
  531. .. _enum_TextServer_Orientation:
  532. .. rst-class:: classref-enumeration
  533. enum **Orientation**: :ref:`๐Ÿ”—<enum_TextServer_Orientation>`
  534. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  537. Text is written horizontally.
  538. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  541. Left to right text is written vertically from top to bottom.
  542. Right to left text is written vertically from bottom to top.
  543. .. rst-class:: classref-item-separator
  544. ----
  545. .. _enum_TextServer_JustificationFlag:
  546. .. rst-class:: classref-enumeration
  547. flags **JustificationFlag**: :ref:`๐Ÿ”—<enum_TextServer_JustificationFlag>`
  548. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  549. .. rst-class:: classref-enumeration-constant
  550. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  551. Do not justify text.
  552. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  553. .. rst-class:: classref-enumeration-constant
  554. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  555. Justify text by adding and removing kashidas.
  556. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  557. .. rst-class:: classref-enumeration-constant
  558. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  559. Justify text by changing width of the spaces between the words.
  560. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  561. .. rst-class:: classref-enumeration-constant
  562. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  563. Remove trailing and leading spaces from the justified text.
  564. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  565. .. rst-class:: classref-enumeration-constant
  566. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  567. Only apply justification to the part of the text after the last tab.
  568. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  569. .. rst-class:: classref-enumeration-constant
  570. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  571. Apply justification to the trimmed line with ellipsis.
  572. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  573. .. rst-class:: classref-enumeration-constant
  574. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  575. Do not apply justification to the last line of the paragraph.
  576. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  577. .. rst-class:: classref-enumeration-constant
  578. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  579. 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>`).
  580. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  581. .. rst-class:: classref-enumeration-constant
  582. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  583. 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).
  584. .. rst-class:: classref-item-separator
  585. ----
  586. .. _enum_TextServer_AutowrapMode:
  587. .. rst-class:: classref-enumeration
  588. enum **AutowrapMode**: :ref:`๐Ÿ”—<enum_TextServer_AutowrapMode>`
  589. .. _class_TextServer_constant_AUTOWRAP_OFF:
  590. .. rst-class:: classref-enumeration-constant
  591. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  592. Autowrap is disabled.
  593. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  594. .. rst-class:: classref-enumeration-constant
  595. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  596. 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.
  597. .. _class_TextServer_constant_AUTOWRAP_WORD:
  598. .. rst-class:: classref-enumeration-constant
  599. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  600. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  601. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  602. .. rst-class:: classref-enumeration-constant
  603. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  604. 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.
  605. .. rst-class:: classref-item-separator
  606. ----
  607. .. _enum_TextServer_LineBreakFlag:
  608. .. rst-class:: classref-enumeration
  609. flags **LineBreakFlag**: :ref:`๐Ÿ”—<enum_TextServer_LineBreakFlag>`
  610. .. _class_TextServer_constant_BREAK_NONE:
  611. .. rst-class:: classref-enumeration-constant
  612. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  613. Do not break the line.
  614. .. _class_TextServer_constant_BREAK_MANDATORY:
  615. .. rst-class:: classref-enumeration-constant
  616. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  617. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  618. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  619. .. rst-class:: classref-enumeration-constant
  620. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  621. Break the line between the words.
  622. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  623. .. rst-class:: classref-enumeration-constant
  624. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  625. Break the line between any unconnected graphemes.
  626. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  627. .. rst-class:: classref-enumeration-constant
  628. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  629. 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.
  630. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  631. .. rst-class:: classref-enumeration-constant
  632. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  633. Remove edge spaces from the broken line segments.
  634. .. _class_TextServer_constant_BREAK_TRIM_INDENT:
  635. .. rst-class:: classref-enumeration-constant
  636. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_INDENT** = ``32``
  637. Subtract first line indentation width from all lines after the first one.
  638. .. rst-class:: classref-item-separator
  639. ----
  640. .. _enum_TextServer_VisibleCharactersBehavior:
  641. .. rst-class:: classref-enumeration
  642. enum **VisibleCharactersBehavior**: :ref:`๐Ÿ”—<enum_TextServer_VisibleCharactersBehavior>`
  643. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  644. .. rst-class:: classref-enumeration-constant
  645. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  646. 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.
  647. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  648. .. rst-class:: classref-enumeration-constant
  649. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  650. 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.
  651. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  652. .. rst-class:: classref-enumeration-constant
  653. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  654. 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.
  655. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  656. .. rst-class:: classref-enumeration-constant
  657. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  658. 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.
  659. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  660. .. rst-class:: classref-enumeration-constant
  661. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  662. 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.
  663. .. rst-class:: classref-item-separator
  664. ----
  665. .. _enum_TextServer_OverrunBehavior:
  666. .. rst-class:: classref-enumeration
  667. enum **OverrunBehavior**: :ref:`๐Ÿ”—<enum_TextServer_OverrunBehavior>`
  668. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  669. .. rst-class:: classref-enumeration-constant
  670. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  671. No text trimming is performed.
  672. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  673. .. rst-class:: classref-enumeration-constant
  674. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  675. Trims the text per character.
  676. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  677. .. rst-class:: classref-enumeration-constant
  678. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  679. Trims the text per word.
  680. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  681. .. rst-class:: classref-enumeration-constant
  682. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  683. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  684. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  685. .. rst-class:: classref-enumeration-constant
  686. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  687. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  688. .. rst-class:: classref-item-separator
  689. ----
  690. .. _enum_TextServer_TextOverrunFlag:
  691. .. rst-class:: classref-enumeration
  692. flags **TextOverrunFlag**: :ref:`๐Ÿ”—<enum_TextServer_TextOverrunFlag>`
  693. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  694. .. rst-class:: classref-enumeration-constant
  695. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  696. No trimming is performed.
  697. .. _class_TextServer_constant_OVERRUN_TRIM:
  698. .. rst-class:: classref-enumeration-constant
  699. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  700. Trims the text when it exceeds the given width.
  701. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  702. .. rst-class:: classref-enumeration-constant
  703. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  704. Trims the text per word instead of per grapheme.
  705. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  706. .. rst-class:: classref-enumeration-constant
  707. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  708. Determines whether an ellipsis should be added at the end of the text.
  709. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  710. .. rst-class:: classref-enumeration-constant
  711. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  712. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  713. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  714. .. rst-class:: classref-enumeration-constant
  715. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  716. Accounts for the text being justified before attempting to trim it (see :ref:`JustificationFlag<enum_TextServer_JustificationFlag>`).
  717. .. rst-class:: classref-item-separator
  718. ----
  719. .. _enum_TextServer_GraphemeFlag:
  720. .. rst-class:: classref-enumeration
  721. flags **GraphemeFlag**: :ref:`๐Ÿ”—<enum_TextServer_GraphemeFlag>`
  722. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  723. .. rst-class:: classref-enumeration-constant
  724. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  725. Grapheme is supported by the font, and can be drawn.
  726. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  727. .. rst-class:: classref-enumeration-constant
  728. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  729. Grapheme is part of right-to-left or bottom-to-top run.
  730. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  731. .. rst-class:: classref-enumeration-constant
  732. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  733. Grapheme is not part of source text, it was added by justification process.
  734. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  735. .. rst-class:: classref-enumeration-constant
  736. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  737. Grapheme is whitespace.
  738. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  739. .. rst-class:: classref-enumeration-constant
  740. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  741. Grapheme is mandatory break point (e.g. ``"\n"``).
  742. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  743. .. rst-class:: classref-enumeration-constant
  744. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  745. Grapheme is optional break point (e.g. space).
  746. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  747. .. rst-class:: classref-enumeration-constant
  748. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  749. Grapheme is the tabulation character.
  750. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  751. .. rst-class:: classref-enumeration-constant
  752. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  753. Grapheme is kashida.
  754. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  755. .. rst-class:: classref-enumeration-constant
  756. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  757. Grapheme is punctuation character.
  758. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  759. .. rst-class:: classref-enumeration-constant
  760. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  761. Grapheme is underscore character.
  762. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  763. .. rst-class:: classref-enumeration-constant
  764. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  765. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  766. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  767. .. rst-class:: classref-enumeration-constant
  768. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  769. It is safe to insert a U+0640 before this grapheme for elongation.
  770. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  771. .. rst-class:: classref-enumeration-constant
  772. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  773. Grapheme is an object replacement character for the embedded object.
  774. .. _class_TextServer_constant_GRAPHEME_IS_SOFT_HYPHEN:
  775. .. rst-class:: classref-enumeration-constant
  776. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SOFT_HYPHEN** = ``8192``
  777. Grapheme is a soft hyphen.
  778. .. rst-class:: classref-item-separator
  779. ----
  780. .. _enum_TextServer_Hinting:
  781. .. rst-class:: classref-enumeration
  782. enum **Hinting**: :ref:`๐Ÿ”—<enum_TextServer_Hinting>`
  783. .. _class_TextServer_constant_HINTING_NONE:
  784. .. rst-class:: classref-enumeration-constant
  785. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  786. Disables font hinting (smoother but less crisp).
  787. .. _class_TextServer_constant_HINTING_LIGHT:
  788. .. rst-class:: classref-enumeration-constant
  789. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  790. Use the light font hinting mode.
  791. .. _class_TextServer_constant_HINTING_NORMAL:
  792. .. rst-class:: classref-enumeration-constant
  793. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  794. Use the default font hinting mode (crisper but less smooth).
  795. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  796. .. rst-class:: classref-item-separator
  797. ----
  798. .. _enum_TextServer_SubpixelPositioning:
  799. .. rst-class:: classref-enumeration
  800. enum **SubpixelPositioning**: :ref:`๐Ÿ”—<enum_TextServer_SubpixelPositioning>`
  801. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  802. .. rst-class:: classref-enumeration-constant
  803. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  804. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  805. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  806. .. rst-class:: classref-enumeration-constant
  807. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  808. Glyph horizontal position is rounded based on font size.
  809. - 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>`.
  810. - 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>`.
  811. - To the whole pixel size for larger fonts.
  812. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  813. .. rst-class:: classref-enumeration-constant
  814. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  815. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  816. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  817. .. rst-class:: classref-enumeration-constant
  818. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  819. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  820. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  821. .. rst-class:: classref-enumeration-constant
  822. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  823. 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.
  824. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  825. .. rst-class:: classref-enumeration-constant
  826. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  827. 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.
  828. .. rst-class:: classref-item-separator
  829. ----
  830. .. _enum_TextServer_Feature:
  831. .. rst-class:: classref-enumeration
  832. enum **Feature**: :ref:`๐Ÿ”—<enum_TextServer_Feature>`
  833. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  834. .. rst-class:: classref-enumeration-constant
  835. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  836. TextServer supports simple text layouts.
  837. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  838. .. rst-class:: classref-enumeration-constant
  839. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  840. TextServer supports bidirectional text layouts.
  841. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  842. .. rst-class:: classref-enumeration-constant
  843. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  844. TextServer supports vertical layouts.
  845. .. _class_TextServer_constant_FEATURE_SHAPING:
  846. .. rst-class:: classref-enumeration-constant
  847. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  848. TextServer supports complex text shaping.
  849. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  850. .. rst-class:: classref-enumeration-constant
  851. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  852. TextServer supports justification using kashidas.
  853. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  854. .. rst-class:: classref-enumeration-constant
  855. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  856. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  857. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  858. .. rst-class:: classref-enumeration-constant
  859. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  860. TextServer supports loading bitmap fonts.
  861. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  862. .. rst-class:: classref-enumeration-constant
  863. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  864. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  865. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  866. .. rst-class:: classref-enumeration-constant
  867. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  868. TextServer supports multichannel signed distance field dynamic font rendering.
  869. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  870. .. rst-class:: classref-enumeration-constant
  871. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  872. TextServer supports loading system fonts.
  873. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  874. .. rst-class:: classref-enumeration-constant
  875. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  876. TextServer supports variable fonts.
  877. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  878. .. rst-class:: classref-enumeration-constant
  879. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  880. TextServer supports locale dependent and context sensitive case conversion.
  881. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  882. .. rst-class:: classref-enumeration-constant
  883. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  884. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  885. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  886. .. rst-class:: classref-enumeration-constant
  887. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  888. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  889. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  890. .. rst-class:: classref-enumeration-constant
  891. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  892. 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.
  893. .. rst-class:: classref-item-separator
  894. ----
  895. .. _enum_TextServer_ContourPointTag:
  896. .. rst-class:: classref-enumeration
  897. enum **ContourPointTag**: :ref:`๐Ÿ”—<enum_TextServer_ContourPointTag>`
  898. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  899. .. rst-class:: classref-enumeration-constant
  900. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  901. Contour point is on the curve.
  902. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  903. .. rst-class:: classref-enumeration-constant
  904. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  905. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bรฉzier arc.
  906. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  907. .. rst-class:: classref-enumeration-constant
  908. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  909. Contour point isn't on the curve, but serves as a control point for a cubic Bรฉzier arc.
  910. .. rst-class:: classref-item-separator
  911. ----
  912. .. _enum_TextServer_SpacingType:
  913. .. rst-class:: classref-enumeration
  914. enum **SpacingType**: :ref:`๐Ÿ”—<enum_TextServer_SpacingType>`
  915. .. _class_TextServer_constant_SPACING_GLYPH:
  916. .. rst-class:: classref-enumeration-constant
  917. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  918. Spacing for each glyph.
  919. .. _class_TextServer_constant_SPACING_SPACE:
  920. .. rst-class:: classref-enumeration-constant
  921. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  922. Spacing for the space character.
  923. .. _class_TextServer_constant_SPACING_TOP:
  924. .. rst-class:: classref-enumeration-constant
  925. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  926. Spacing at the top of the line.
  927. .. _class_TextServer_constant_SPACING_BOTTOM:
  928. .. rst-class:: classref-enumeration-constant
  929. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  930. Spacing at the bottom of the line.
  931. .. _class_TextServer_constant_SPACING_MAX:
  932. .. rst-class:: classref-enumeration-constant
  933. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  934. Represents the size of the :ref:`SpacingType<enum_TextServer_SpacingType>` enum.
  935. .. rst-class:: classref-item-separator
  936. ----
  937. .. _enum_TextServer_FontStyle:
  938. .. rst-class:: classref-enumeration
  939. flags **FontStyle**: :ref:`๐Ÿ”—<enum_TextServer_FontStyle>`
  940. .. _class_TextServer_constant_FONT_BOLD:
  941. .. rst-class:: classref-enumeration-constant
  942. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  943. Font is bold.
  944. .. _class_TextServer_constant_FONT_ITALIC:
  945. .. rst-class:: classref-enumeration-constant
  946. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  947. Font is italic or oblique.
  948. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  949. .. rst-class:: classref-enumeration-constant
  950. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  951. Font have fixed-width characters.
  952. .. rst-class:: classref-item-separator
  953. ----
  954. .. _enum_TextServer_StructuredTextParser:
  955. .. rst-class:: classref-enumeration
  956. enum **StructuredTextParser**: :ref:`๐Ÿ”—<enum_TextServer_StructuredTextParser>`
  957. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  958. .. rst-class:: classref-enumeration-constant
  959. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  960. Use default Unicode BiDi algorithm.
  961. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  962. .. rst-class:: classref-enumeration-constant
  963. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  964. BiDi override for URI.
  965. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  966. .. rst-class:: classref-enumeration-constant
  967. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  968. BiDi override for file path.
  969. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  970. .. rst-class:: classref-enumeration-constant
  971. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  972. BiDi override for email.
  973. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  974. .. rst-class:: classref-enumeration-constant
  975. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  976. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  977. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  978. .. rst-class:: classref-enumeration-constant
  979. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  980. BiDi override for GDScript.
  981. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  982. .. rst-class:: classref-enumeration-constant
  983. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  984. User defined structured text BiDi override function.
  985. .. rst-class:: classref-item-separator
  986. ----
  987. .. _enum_TextServer_FixedSizeScaleMode:
  988. .. rst-class:: classref-enumeration
  989. enum **FixedSizeScaleMode**: :ref:`๐Ÿ”—<enum_TextServer_FixedSizeScaleMode>`
  990. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  991. .. rst-class:: classref-enumeration-constant
  992. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  993. Bitmap font is not scaled.
  994. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  995. .. rst-class:: classref-enumeration-constant
  996. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  997. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  998. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  999. .. rst-class:: classref-enumeration-constant
  1000. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  1001. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  1002. .. rst-class:: classref-section-separator
  1003. ----
  1004. .. rst-class:: classref-descriptions-group
  1005. Method Descriptions
  1006. -------------------
  1007. .. _class_TextServer_method_create_font:
  1008. .. rst-class:: classref-method
  1009. :ref:`RID<class_RID>` **create_font**\ (\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font>`
  1010. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  1011. .. rst-class:: classref-item-separator
  1012. ----
  1013. .. _class_TextServer_method_create_font_linked_variation:
  1014. .. rst-class:: classref-method
  1015. :ref:`RID<class_RID>` **create_font_linked_variation**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_create_font_linked_variation>`
  1016. 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.
  1017. .. rst-class:: classref-item-separator
  1018. ----
  1019. .. _class_TextServer_method_create_shaped_text:
  1020. .. rst-class:: classref-method
  1021. :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>`
  1022. 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.
  1023. \ **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>`).
  1024. \ **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>`).
  1025. .. rst-class:: classref-item-separator
  1026. ----
  1027. .. _class_TextServer_method_draw_hex_code_box:
  1028. .. rst-class:: classref-method
  1029. |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>`
  1030. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  1031. .. rst-class:: classref-item-separator
  1032. ----
  1033. .. _class_TextServer_method_font_clear_glyphs:
  1034. .. rst-class:: classref-method
  1035. |void| **font_clear_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_glyphs>`
  1036. Removes all rendered glyph information from the cache entry.
  1037. \ **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.
  1038. .. rst-class:: classref-item-separator
  1039. ----
  1040. .. _class_TextServer_method_font_clear_kerning_map:
  1041. .. rst-class:: classref-method
  1042. |void| **font_clear_kerning_map**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_kerning_map>`
  1043. Removes all kerning overrides.
  1044. .. rst-class:: classref-item-separator
  1045. ----
  1046. .. _class_TextServer_method_font_clear_size_cache:
  1047. .. rst-class:: classref-method
  1048. |void| **font_clear_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_size_cache>`
  1049. Removes all font sizes from the cache entry.
  1050. .. rst-class:: classref-item-separator
  1051. ----
  1052. .. _class_TextServer_method_font_clear_textures:
  1053. .. rst-class:: classref-method
  1054. |void| **font_clear_textures**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_clear_textures>`
  1055. Removes all textures from font cache entry.
  1056. \ **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.
  1057. .. rst-class:: classref-item-separator
  1058. ----
  1059. .. _class_TextServer_method_font_draw_glyph:
  1060. .. rst-class:: classref-method
  1061. |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>`
  1062. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1063. \ **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>`.
  1064. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1065. .. rst-class:: classref-item-separator
  1066. ----
  1067. .. _class_TextServer_method_font_draw_glyph_outline:
  1068. .. rst-class:: classref-method
  1069. |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>`
  1070. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1071. \ **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>`.
  1072. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1073. .. rst-class:: classref-item-separator
  1074. ----
  1075. .. _class_TextServer_method_font_get_antialiasing:
  1076. .. rst-class:: classref-method
  1077. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_antialiasing>`
  1078. Returns font anti-aliasing mode.
  1079. .. rst-class:: classref-item-separator
  1080. ----
  1081. .. _class_TextServer_method_font_get_ascent:
  1082. .. rst-class:: classref-method
  1083. :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>`
  1084. Returns the font ascent (number of pixels above the baseline).
  1085. .. rst-class:: classref-item-separator
  1086. ----
  1087. .. _class_TextServer_method_font_get_baseline_offset:
  1088. .. rst-class:: classref-method
  1089. :ref:`float<class_float>` **font_get_baseline_offset**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_baseline_offset>`
  1090. Returns extra baseline offset (as a fraction of font height).
  1091. .. rst-class:: classref-item-separator
  1092. ----
  1093. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1094. .. rst-class:: classref-method
  1095. :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>`
  1096. 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>`.
  1097. .. rst-class:: classref-item-separator
  1098. ----
  1099. .. _class_TextServer_method_font_get_descent:
  1100. .. rst-class:: classref-method
  1101. :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>`
  1102. Returns the font descent (number of pixels below the baseline).
  1103. .. rst-class:: classref-item-separator
  1104. ----
  1105. .. _class_TextServer_method_font_get_disable_embedded_bitmaps:
  1106. .. rst-class:: classref-method
  1107. :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>`
  1108. Returns whether the font's embedded bitmap loading is disabled.
  1109. .. rst-class:: classref-item-separator
  1110. ----
  1111. .. _class_TextServer_method_font_get_embolden:
  1112. .. rst-class:: classref-method
  1113. :ref:`float<class_float>` **font_get_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_embolden>`
  1114. Returns font embolden strength.
  1115. .. rst-class:: classref-item-separator
  1116. ----
  1117. .. _class_TextServer_method_font_get_face_count:
  1118. .. rst-class:: classref-method
  1119. :ref:`int<class_int>` **font_get_face_count**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_count>`
  1120. Returns number of faces in the TrueType / OpenType collection.
  1121. .. rst-class:: classref-item-separator
  1122. ----
  1123. .. _class_TextServer_method_font_get_face_index:
  1124. .. rst-class:: classref-method
  1125. :ref:`int<class_int>` **font_get_face_index**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_face_index>`
  1126. Returns an active face index in the TrueType / OpenType collection.
  1127. .. rst-class:: classref-item-separator
  1128. ----
  1129. .. _class_TextServer_method_font_get_fixed_size:
  1130. .. rst-class:: classref-method
  1131. :ref:`int<class_int>` **font_get_fixed_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_fixed_size>`
  1132. Returns bitmap font fixed size.
  1133. .. rst-class:: classref-item-separator
  1134. ----
  1135. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1136. .. rst-class:: classref-method
  1137. :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>`
  1138. Returns bitmap font scaling mode.
  1139. .. rst-class:: classref-item-separator
  1140. ----
  1141. .. _class_TextServer_method_font_get_generate_mipmaps:
  1142. .. rst-class:: classref-method
  1143. :ref:`bool<class_bool>` **font_get_generate_mipmaps**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_generate_mipmaps>`
  1144. Returns ``true`` if font texture mipmap generation is enabled.
  1145. .. rst-class:: classref-item-separator
  1146. ----
  1147. .. _class_TextServer_method_font_get_global_oversampling:
  1148. .. rst-class:: classref-method
  1149. :ref:`float<class_float>` **font_get_global_oversampling**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_global_oversampling>`
  1150. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1151. .. rst-class:: classref-item-separator
  1152. ----
  1153. .. _class_TextServer_method_font_get_glyph_advance:
  1154. .. rst-class:: classref-method
  1155. :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>`
  1156. Returns glyph advance (offset of the next glyph).
  1157. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1158. .. rst-class:: classref-item-separator
  1159. ----
  1160. .. _class_TextServer_method_font_get_glyph_contours:
  1161. .. rst-class:: classref-method
  1162. :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>`
  1163. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1164. \ ``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.
  1165. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1166. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1167. .. rst-class:: classref-item-separator
  1168. ----
  1169. .. _class_TextServer_method_font_get_glyph_index:
  1170. .. rst-class:: classref-method
  1171. :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>`
  1172. 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>`.
  1173. .. rst-class:: classref-item-separator
  1174. ----
  1175. .. _class_TextServer_method_font_get_glyph_list:
  1176. .. rst-class:: classref-method
  1177. :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>`
  1178. Returns list of rendered glyphs in the cache entry.
  1179. .. rst-class:: classref-item-separator
  1180. ----
  1181. .. _class_TextServer_method_font_get_glyph_offset:
  1182. .. rst-class:: classref-method
  1183. :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>`
  1184. Returns glyph offset from the baseline.
  1185. .. rst-class:: classref-item-separator
  1186. ----
  1187. .. _class_TextServer_method_font_get_glyph_size:
  1188. .. rst-class:: classref-method
  1189. :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>`
  1190. Returns size of the glyph.
  1191. .. rst-class:: classref-item-separator
  1192. ----
  1193. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1194. .. rst-class:: classref-method
  1195. :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>`
  1196. Returns index of the cache texture containing the glyph.
  1197. .. rst-class:: classref-item-separator
  1198. ----
  1199. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1200. .. rst-class:: classref-method
  1201. :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>`
  1202. Returns resource ID of the cache texture containing the glyph.
  1203. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1204. .. rst-class:: classref-item-separator
  1205. ----
  1206. .. _class_TextServer_method_font_get_glyph_texture_size:
  1207. .. rst-class:: classref-method
  1208. :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>`
  1209. Returns size of the cache texture containing the glyph.
  1210. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1211. .. rst-class:: classref-item-separator
  1212. ----
  1213. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1214. .. rst-class:: classref-method
  1215. :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>`
  1216. Returns rectangle in the cache texture containing the glyph.
  1217. .. rst-class:: classref-item-separator
  1218. ----
  1219. .. _class_TextServer_method_font_get_hinting:
  1220. .. rst-class:: classref-method
  1221. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_hinting>`
  1222. Returns the font hinting mode. Used by dynamic fonts only.
  1223. .. rst-class:: classref-item-separator
  1224. ----
  1225. .. _class_TextServer_method_font_get_kerning:
  1226. .. rst-class:: classref-method
  1227. :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>`
  1228. Returns kerning for the pair of glyphs.
  1229. .. rst-class:: classref-item-separator
  1230. ----
  1231. .. _class_TextServer_method_font_get_kerning_list:
  1232. .. rst-class:: classref-method
  1233. :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>`
  1234. Returns list of the kerning overrides.
  1235. .. rst-class:: classref-item-separator
  1236. ----
  1237. .. _class_TextServer_method_font_get_language_support_override:
  1238. .. rst-class:: classref-method
  1239. :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>`
  1240. Returns ``true`` if support override is enabled for the ``language``.
  1241. .. rst-class:: classref-item-separator
  1242. ----
  1243. .. _class_TextServer_method_font_get_language_support_overrides:
  1244. .. rst-class:: classref-method
  1245. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_language_support_overrides>`
  1246. Returns list of language support overrides.
  1247. .. rst-class:: classref-item-separator
  1248. ----
  1249. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1250. .. rst-class:: classref-method
  1251. :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>`
  1252. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1253. .. rst-class:: classref-item-separator
  1254. ----
  1255. .. _class_TextServer_method_font_get_msdf_size:
  1256. .. rst-class:: classref-method
  1257. :ref:`int<class_int>` **font_get_msdf_size**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_msdf_size>`
  1258. Returns source font size used to generate MSDF textures.
  1259. .. rst-class:: classref-item-separator
  1260. ----
  1261. .. _class_TextServer_method_font_get_name:
  1262. .. rst-class:: classref-method
  1263. :ref:`String<class_String>` **font_get_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_name>`
  1264. Returns font family name.
  1265. .. rst-class:: classref-item-separator
  1266. ----
  1267. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1268. .. rst-class:: classref-method
  1269. :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>`
  1270. Returns font OpenType feature set override.
  1271. .. rst-class:: classref-item-separator
  1272. ----
  1273. .. _class_TextServer_method_font_get_ot_name_strings:
  1274. .. rst-class:: classref-method
  1275. :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>`
  1276. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1277. .. rst-class:: classref-item-separator
  1278. ----
  1279. .. _class_TextServer_method_font_get_oversampling:
  1280. .. rst-class:: classref-method
  1281. :ref:`float<class_float>` **font_get_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_oversampling>`
  1282. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1283. .. rst-class:: classref-item-separator
  1284. ----
  1285. .. _class_TextServer_method_font_get_scale:
  1286. .. rst-class:: classref-method
  1287. :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>`
  1288. Returns scaling factor of the color bitmap font.
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _class_TextServer_method_font_get_script_support_override:
  1292. .. rst-class:: classref-method
  1293. :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>`
  1294. Returns ``true`` if support override is enabled for the ``script``.
  1295. .. rst-class:: classref-item-separator
  1296. ----
  1297. .. _class_TextServer_method_font_get_script_support_overrides:
  1298. .. rst-class:: classref-method
  1299. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_get_script_support_overrides>`
  1300. Returns list of script support overrides.
  1301. .. rst-class:: classref-item-separator
  1302. ----
  1303. .. _class_TextServer_method_font_get_size_cache_list:
  1304. .. rst-class:: classref-method
  1305. :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>`
  1306. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1307. .. rst-class:: classref-item-separator
  1308. ----
  1309. .. _class_TextServer_method_font_get_spacing:
  1310. .. rst-class:: classref-method
  1311. :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>`
  1312. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1313. .. rst-class:: classref-item-separator
  1314. ----
  1315. .. _class_TextServer_method_font_get_stretch:
  1316. .. rst-class:: classref-method
  1317. :ref:`int<class_int>` **font_get_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_stretch>`
  1318. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1319. .. rst-class:: classref-item-separator
  1320. ----
  1321. .. _class_TextServer_method_font_get_style:
  1322. .. rst-class:: classref-method
  1323. |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\] **font_get_style**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style>`
  1324. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1325. .. rst-class:: classref-item-separator
  1326. ----
  1327. .. _class_TextServer_method_font_get_style_name:
  1328. .. rst-class:: classref-method
  1329. :ref:`String<class_String>` **font_get_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_style_name>`
  1330. Returns font style name.
  1331. .. rst-class:: classref-item-separator
  1332. ----
  1333. .. _class_TextServer_method_font_get_subpixel_positioning:
  1334. .. rst-class:: classref-method
  1335. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_subpixel_positioning>`
  1336. Returns font subpixel glyph positioning mode.
  1337. .. rst-class:: classref-item-separator
  1338. ----
  1339. .. _class_TextServer_method_font_get_supported_chars:
  1340. .. rst-class:: classref-method
  1341. :ref:`String<class_String>` **font_get_supported_chars**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_chars>`
  1342. Returns a string containing all the characters available in the font.
  1343. .. rst-class:: classref-item-separator
  1344. ----
  1345. .. _class_TextServer_method_font_get_supported_glyphs:
  1346. .. rst-class:: classref-method
  1347. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_supported_glyphs**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_supported_glyphs>`
  1348. Returns an array containing all glyph indices in the font.
  1349. .. rst-class:: classref-item-separator
  1350. ----
  1351. .. _class_TextServer_method_font_get_texture_count:
  1352. .. rst-class:: classref-method
  1353. :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>`
  1354. Returns number of textures used by font cache entry.
  1355. .. rst-class:: classref-item-separator
  1356. ----
  1357. .. _class_TextServer_method_font_get_texture_image:
  1358. .. rst-class:: classref-method
  1359. :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>`
  1360. Returns font cache texture image data.
  1361. .. rst-class:: classref-item-separator
  1362. ----
  1363. .. _class_TextServer_method_font_get_texture_offsets:
  1364. .. rst-class:: classref-method
  1365. :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>`
  1366. Returns array containing glyph packing data.
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _class_TextServer_method_font_get_transform:
  1370. .. rst-class:: classref-method
  1371. :ref:`Transform2D<class_Transform2D>` **font_get_transform**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_transform>`
  1372. Returns 2D transform applied to the font outlines.
  1373. .. rst-class:: classref-item-separator
  1374. ----
  1375. .. _class_TextServer_method_font_get_underline_position:
  1376. .. rst-class:: classref-method
  1377. :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>`
  1378. Returns pixel offset of the underline below the baseline.
  1379. .. rst-class:: classref-item-separator
  1380. ----
  1381. .. _class_TextServer_method_font_get_underline_thickness:
  1382. .. rst-class:: classref-method
  1383. :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>`
  1384. Returns thickness of the underline in pixels.
  1385. .. rst-class:: classref-item-separator
  1386. ----
  1387. .. _class_TextServer_method_font_get_variation_coordinates:
  1388. .. rst-class:: classref-method
  1389. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_variation_coordinates>`
  1390. 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.
  1391. .. rst-class:: classref-item-separator
  1392. ----
  1393. .. _class_TextServer_method_font_get_weight:
  1394. .. rst-class:: classref-method
  1395. :ref:`int<class_int>` **font_get_weight**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_get_weight>`
  1396. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1397. .. rst-class:: classref-item-separator
  1398. ----
  1399. .. _class_TextServer_method_font_has_char:
  1400. .. rst-class:: classref-method
  1401. :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>`
  1402. Returns ``true`` if a Unicode ``char`` is available in the font.
  1403. .. rst-class:: classref-item-separator
  1404. ----
  1405. .. _class_TextServer_method_font_is_allow_system_fallback:
  1406. .. rst-class:: classref-method
  1407. :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>`
  1408. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1409. .. rst-class:: classref-item-separator
  1410. ----
  1411. .. _class_TextServer_method_font_is_force_autohinter:
  1412. .. rst-class:: classref-method
  1413. :ref:`bool<class_bool>` **font_is_force_autohinter**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_is_force_autohinter>`
  1414. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1415. .. rst-class:: classref-item-separator
  1416. ----
  1417. .. _class_TextServer_method_font_is_language_supported:
  1418. .. rst-class:: classref-method
  1419. :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>`
  1420. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1421. .. rst-class:: classref-item-separator
  1422. ----
  1423. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1424. .. rst-class:: classref-method
  1425. :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>`
  1426. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1427. .. rst-class:: classref-item-separator
  1428. ----
  1429. .. _class_TextServer_method_font_is_script_supported:
  1430. .. rst-class:: classref-method
  1431. :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>`
  1432. Returns ``true``, if font supports given script (ISO 15924 code).
  1433. .. rst-class:: classref-item-separator
  1434. ----
  1435. .. _class_TextServer_method_font_remove_glyph:
  1436. .. rst-class:: classref-method
  1437. |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>`
  1438. Removes specified rendered glyph information from the cache entry.
  1439. \ **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.
  1440. .. rst-class:: classref-item-separator
  1441. ----
  1442. .. _class_TextServer_method_font_remove_kerning:
  1443. .. rst-class:: classref-method
  1444. |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>`
  1445. Removes kerning override for the pair of glyphs.
  1446. .. rst-class:: classref-item-separator
  1447. ----
  1448. .. _class_TextServer_method_font_remove_language_support_override:
  1449. .. rst-class:: classref-method
  1450. |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>`
  1451. Remove language support override.
  1452. .. rst-class:: classref-item-separator
  1453. ----
  1454. .. _class_TextServer_method_font_remove_script_support_override:
  1455. .. rst-class:: classref-method
  1456. |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>`
  1457. Removes script support override.
  1458. .. rst-class:: classref-item-separator
  1459. ----
  1460. .. _class_TextServer_method_font_remove_size_cache:
  1461. .. rst-class:: classref-method
  1462. |void| **font_remove_size_cache**\ (\ font_rid\: :ref:`RID<class_RID>`, size\: :ref:`Vector2i<class_Vector2i>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_remove_size_cache>`
  1463. Removes specified font size from the cache entry.
  1464. .. rst-class:: classref-item-separator
  1465. ----
  1466. .. _class_TextServer_method_font_remove_texture:
  1467. .. rst-class:: classref-method
  1468. |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>`
  1469. Removes specified texture from the cache entry.
  1470. \ **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>`.
  1471. .. rst-class:: classref-item-separator
  1472. ----
  1473. .. _class_TextServer_method_font_render_glyph:
  1474. .. rst-class:: classref-method
  1475. |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>`
  1476. Renders specified glyph to the font cache texture.
  1477. .. rst-class:: classref-item-separator
  1478. ----
  1479. .. _class_TextServer_method_font_render_range:
  1480. .. rst-class:: classref-method
  1481. |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>`
  1482. Renders the range of characters to the font cache texture.
  1483. .. rst-class:: classref-item-separator
  1484. ----
  1485. .. _class_TextServer_method_font_set_allow_system_fallback:
  1486. .. rst-class:: classref-method
  1487. |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>`
  1488. If set to ``true``, system fonts can be automatically used as fallbacks.
  1489. .. rst-class:: classref-item-separator
  1490. ----
  1491. .. _class_TextServer_method_font_set_antialiasing:
  1492. .. rst-class:: classref-method
  1493. |void| **font_set_antialiasing**\ (\ font_rid\: :ref:`RID<class_RID>`, antialiasing\: :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_antialiasing>`
  1494. Sets font anti-aliasing mode.
  1495. .. rst-class:: classref-item-separator
  1496. ----
  1497. .. _class_TextServer_method_font_set_ascent:
  1498. .. rst-class:: classref-method
  1499. |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>`
  1500. Sets the font ascent (number of pixels above the baseline).
  1501. .. rst-class:: classref-item-separator
  1502. ----
  1503. .. _class_TextServer_method_font_set_baseline_offset:
  1504. .. rst-class:: classref-method
  1505. |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>`
  1506. Sets extra baseline offset (as a fraction of font height).
  1507. .. rst-class:: classref-item-separator
  1508. ----
  1509. .. _class_TextServer_method_font_set_data:
  1510. .. rst-class:: classref-method
  1511. |void| **font_set_data**\ (\ font_rid\: :ref:`RID<class_RID>`, data\: :ref:`PackedByteArray<class_PackedByteArray>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_data>`
  1512. Sets font source data, e.g contents of the dynamic font source file.
  1513. .. rst-class:: classref-item-separator
  1514. ----
  1515. .. _class_TextServer_method_font_set_descent:
  1516. .. rst-class:: classref-method
  1517. |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>`
  1518. Sets the font descent (number of pixels below the baseline).
  1519. .. rst-class:: classref-item-separator
  1520. ----
  1521. .. _class_TextServer_method_font_set_disable_embedded_bitmaps:
  1522. .. rst-class:: classref-method
  1523. |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>`
  1524. If set to ``true``, embedded font bitmap loading is disabled (bitmap-only and color fonts ignore this property).
  1525. .. rst-class:: classref-item-separator
  1526. ----
  1527. .. _class_TextServer_method_font_set_embolden:
  1528. .. rst-class:: classref-method
  1529. |void| **font_set_embolden**\ (\ font_rid\: :ref:`RID<class_RID>`, strength\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_embolden>`
  1530. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1531. .. rst-class:: classref-item-separator
  1532. ----
  1533. .. _class_TextServer_method_font_set_face_index:
  1534. .. rst-class:: classref-method
  1535. |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>`
  1536. Sets an active face index in the TrueType / OpenType collection.
  1537. .. rst-class:: classref-item-separator
  1538. ----
  1539. .. _class_TextServer_method_font_set_fixed_size:
  1540. .. rst-class:: classref-method
  1541. |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>`
  1542. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1543. .. rst-class:: classref-item-separator
  1544. ----
  1545. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1546. .. rst-class:: classref-method
  1547. |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>`
  1548. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1549. .. rst-class:: classref-item-separator
  1550. ----
  1551. .. _class_TextServer_method_font_set_force_autohinter:
  1552. .. rst-class:: classref-method
  1553. |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>`
  1554. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1555. .. rst-class:: classref-item-separator
  1556. ----
  1557. .. _class_TextServer_method_font_set_generate_mipmaps:
  1558. .. rst-class:: classref-method
  1559. |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>`
  1560. If set to ``true`` font texture mipmap generation is enabled.
  1561. .. rst-class:: classref-item-separator
  1562. ----
  1563. .. _class_TextServer_method_font_set_global_oversampling:
  1564. .. rst-class:: classref-method
  1565. |void| **font_set_global_oversampling**\ (\ oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_global_oversampling>`
  1566. Sets oversampling factor, shared by all font in the TextServer.
  1567. \ **Note:** This value can be automatically changed by display server.
  1568. .. rst-class:: classref-item-separator
  1569. ----
  1570. .. _class_TextServer_method_font_set_glyph_advance:
  1571. .. rst-class:: classref-method
  1572. |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>`
  1573. Sets glyph advance (offset of the next glyph).
  1574. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1575. .. rst-class:: classref-item-separator
  1576. ----
  1577. .. _class_TextServer_method_font_set_glyph_offset:
  1578. .. rst-class:: classref-method
  1579. |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>`
  1580. Sets glyph offset from the baseline.
  1581. .. rst-class:: classref-item-separator
  1582. ----
  1583. .. _class_TextServer_method_font_set_glyph_size:
  1584. .. rst-class:: classref-method
  1585. |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>`
  1586. Sets size of the glyph.
  1587. .. rst-class:: classref-item-separator
  1588. ----
  1589. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1590. .. rst-class:: classref-method
  1591. |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>`
  1592. Sets index of the cache texture containing the glyph.
  1593. .. rst-class:: classref-item-separator
  1594. ----
  1595. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1596. .. rst-class:: classref-method
  1597. |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>`
  1598. Sets rectangle in the cache texture containing the glyph.
  1599. .. rst-class:: classref-item-separator
  1600. ----
  1601. .. _class_TextServer_method_font_set_hinting:
  1602. .. rst-class:: classref-method
  1603. |void| **font_set_hinting**\ (\ font_rid\: :ref:`RID<class_RID>`, hinting\: :ref:`Hinting<enum_TextServer_Hinting>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_hinting>`
  1604. Sets font hinting mode. Used by dynamic fonts only.
  1605. .. rst-class:: classref-item-separator
  1606. ----
  1607. .. _class_TextServer_method_font_set_kerning:
  1608. .. rst-class:: classref-method
  1609. |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>`
  1610. Sets kerning for the pair of glyphs.
  1611. .. rst-class:: classref-item-separator
  1612. ----
  1613. .. _class_TextServer_method_font_set_language_support_override:
  1614. .. rst-class:: classref-method
  1615. |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>`
  1616. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1617. .. rst-class:: classref-item-separator
  1618. ----
  1619. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1620. .. rst-class:: classref-method
  1621. |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>`
  1622. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1623. .. rst-class:: classref-item-separator
  1624. ----
  1625. .. _class_TextServer_method_font_set_msdf_size:
  1626. .. rst-class:: classref-method
  1627. |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>`
  1628. Sets source font size used to generate MSDF textures.
  1629. .. rst-class:: classref-item-separator
  1630. ----
  1631. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1632. .. rst-class:: classref-method
  1633. |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>`
  1634. 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.
  1635. \ **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.
  1636. .. rst-class:: classref-item-separator
  1637. ----
  1638. .. _class_TextServer_method_font_set_name:
  1639. .. rst-class:: classref-method
  1640. |void| **font_set_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_name>`
  1641. Sets the font family name.
  1642. .. rst-class:: classref-item-separator
  1643. ----
  1644. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1645. .. rst-class:: classref-method
  1646. |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>`
  1647. Sets font OpenType feature set override.
  1648. .. rst-class:: classref-item-separator
  1649. ----
  1650. .. _class_TextServer_method_font_set_oversampling:
  1651. .. rst-class:: classref-method
  1652. |void| **font_set_oversampling**\ (\ font_rid\: :ref:`RID<class_RID>`, oversampling\: :ref:`float<class_float>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_oversampling>`
  1653. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1654. .. rst-class:: classref-item-separator
  1655. ----
  1656. .. _class_TextServer_method_font_set_scale:
  1657. .. rst-class:: classref-method
  1658. |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>`
  1659. Sets scaling factor of the color bitmap font.
  1660. .. rst-class:: classref-item-separator
  1661. ----
  1662. .. _class_TextServer_method_font_set_script_support_override:
  1663. .. rst-class:: classref-method
  1664. |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>`
  1665. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1666. .. rst-class:: classref-item-separator
  1667. ----
  1668. .. _class_TextServer_method_font_set_spacing:
  1669. .. rst-class:: classref-method
  1670. |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>`
  1671. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1672. .. rst-class:: classref-item-separator
  1673. ----
  1674. .. _class_TextServer_method_font_set_stretch:
  1675. .. rst-class:: classref-method
  1676. |void| **font_set_stretch**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_stretch>`
  1677. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1678. \ **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.
  1679. .. rst-class:: classref-item-separator
  1680. ----
  1681. .. _class_TextServer_method_font_set_style:
  1682. .. rst-class:: classref-method
  1683. |void| **font_set_style**\ (\ font_rid\: :ref:`RID<class_RID>`, style\: |bitfield|\[:ref:`FontStyle<enum_TextServer_FontStyle>`\]\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style>`
  1684. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1685. \ **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.
  1686. .. rst-class:: classref-item-separator
  1687. ----
  1688. .. _class_TextServer_method_font_set_style_name:
  1689. .. rst-class:: classref-method
  1690. |void| **font_set_style_name**\ (\ font_rid\: :ref:`RID<class_RID>`, name\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_style_name>`
  1691. Sets the font style name.
  1692. .. rst-class:: classref-item-separator
  1693. ----
  1694. .. _class_TextServer_method_font_set_subpixel_positioning:
  1695. .. rst-class:: classref-method
  1696. |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>`
  1697. Sets font subpixel glyph positioning mode.
  1698. .. rst-class:: classref-item-separator
  1699. ----
  1700. .. _class_TextServer_method_font_set_texture_image:
  1701. .. rst-class:: classref-method
  1702. |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>`
  1703. Sets font cache texture image data.
  1704. .. rst-class:: classref-item-separator
  1705. ----
  1706. .. _class_TextServer_method_font_set_texture_offsets:
  1707. .. rst-class:: classref-method
  1708. |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>`
  1709. Sets array containing glyph packing data.
  1710. .. rst-class:: classref-item-separator
  1711. ----
  1712. .. _class_TextServer_method_font_set_transform:
  1713. .. rst-class:: classref-method
  1714. |void| **font_set_transform**\ (\ font_rid\: :ref:`RID<class_RID>`, transform\: :ref:`Transform2D<class_Transform2D>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_transform>`
  1715. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping, and rotating glyphs.
  1716. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1717. .. rst-class:: classref-item-separator
  1718. ----
  1719. .. _class_TextServer_method_font_set_underline_position:
  1720. .. rst-class:: classref-method
  1721. |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>`
  1722. Sets pixel offset of the underline below the baseline.
  1723. .. rst-class:: classref-item-separator
  1724. ----
  1725. .. _class_TextServer_method_font_set_underline_thickness:
  1726. .. rst-class:: classref-method
  1727. |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>`
  1728. Sets thickness of the underline in pixels.
  1729. .. rst-class:: classref-item-separator
  1730. ----
  1731. .. _class_TextServer_method_font_set_variation_coordinates:
  1732. .. rst-class:: classref-method
  1733. |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>`
  1734. 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.
  1735. .. rst-class:: classref-item-separator
  1736. ----
  1737. .. _class_TextServer_method_font_set_weight:
  1738. .. rst-class:: classref-method
  1739. |void| **font_set_weight**\ (\ font_rid\: :ref:`RID<class_RID>`, weight\: :ref:`int<class_int>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_font_set_weight>`
  1740. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1741. \ **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.
  1742. .. rst-class:: classref-item-separator
  1743. ----
  1744. .. _class_TextServer_method_font_supported_feature_list:
  1745. .. rst-class:: classref-method
  1746. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_feature_list>`
  1747. Returns the dictionary of the supported OpenType features.
  1748. .. rst-class:: classref-item-separator
  1749. ----
  1750. .. _class_TextServer_method_font_supported_variation_list:
  1751. .. rst-class:: classref-method
  1752. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list**\ (\ font_rid\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_font_supported_variation_list>`
  1753. Returns the dictionary of the supported OpenType variation coordinates.
  1754. .. rst-class:: classref-item-separator
  1755. ----
  1756. .. _class_TextServer_method_format_number:
  1757. .. rst-class:: classref-method
  1758. :ref:`String<class_String>` **format_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_format_number>`
  1759. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1760. If ``language`` is omitted, the active locale will be used.
  1761. .. rst-class:: classref-item-separator
  1762. ----
  1763. .. _class_TextServer_method_free_rid:
  1764. .. rst-class:: classref-method
  1765. |void| **free_rid**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_free_rid>`
  1766. Frees an object created by this **TextServer**.
  1767. .. rst-class:: classref-item-separator
  1768. ----
  1769. .. _class_TextServer_method_get_features:
  1770. .. rst-class:: classref-method
  1771. :ref:`int<class_int>` **get_features**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_features>`
  1772. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1773. .. rst-class:: classref-item-separator
  1774. ----
  1775. .. _class_TextServer_method_get_hex_code_box_size:
  1776. .. rst-class:: classref-method
  1777. :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>`
  1778. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1779. .. rst-class:: classref-item-separator
  1780. ----
  1781. .. _class_TextServer_method_get_name:
  1782. .. rst-class:: classref-method
  1783. :ref:`String<class_String>` **get_name**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_name>`
  1784. Returns the name of the server interface.
  1785. .. rst-class:: classref-item-separator
  1786. ----
  1787. .. _class_TextServer_method_get_support_data_filename:
  1788. .. rst-class:: classref-method
  1789. :ref:`String<class_String>` **get_support_data_filename**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_filename>`
  1790. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1791. .. rst-class:: classref-item-separator
  1792. ----
  1793. .. _class_TextServer_method_get_support_data_info:
  1794. .. rst-class:: classref-method
  1795. :ref:`String<class_String>` **get_support_data_info**\ (\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_get_support_data_info>`
  1796. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1797. .. rst-class:: classref-item-separator
  1798. ----
  1799. .. _class_TextServer_method_has:
  1800. .. rst-class:: classref-method
  1801. :ref:`bool<class_bool>` **has**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_has>`
  1802. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1803. .. rst-class:: classref-item-separator
  1804. ----
  1805. .. _class_TextServer_method_has_feature:
  1806. .. rst-class:: classref-method
  1807. :ref:`bool<class_bool>` **has_feature**\ (\ feature\: :ref:`Feature<enum_TextServer_Feature>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_has_feature>`
  1808. Returns ``true`` if the server supports a feature.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_TextServer_method_is_confusable:
  1812. .. rst-class:: classref-method
  1813. :ref:`int<class_int>` **is_confusable**\ (\ string\: :ref:`String<class_String>`, dict\: :ref:`PackedStringArray<class_PackedStringArray>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_confusable>`
  1814. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1815. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1816. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1817. .. rst-class:: classref-item-separator
  1818. ----
  1819. .. _class_TextServer_method_is_locale_right_to_left:
  1820. .. rst-class:: classref-method
  1821. :ref:`bool<class_bool>` **is_locale_right_to_left**\ (\ locale\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_locale_right_to_left>`
  1822. Returns ``true`` if locale is right-to-left.
  1823. .. rst-class:: classref-item-separator
  1824. ----
  1825. .. _class_TextServer_method_is_valid_identifier:
  1826. .. rst-class:: classref-method
  1827. :ref:`bool<class_bool>` **is_valid_identifier**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_identifier>`
  1828. Returns ``true`` if ``string`` is a valid identifier.
  1829. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1830. - Conform to normalization form C.
  1831. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1832. - May contain Unicode characters of class XID_Continue in the other positions.
  1833. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1834. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1835. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1836. - May contain Unicode characters of class XID_Continue in the other positions.
  1837. .. rst-class:: classref-item-separator
  1838. ----
  1839. .. _class_TextServer_method_is_valid_letter:
  1840. .. rst-class:: classref-method
  1841. :ref:`bool<class_bool>` **is_valid_letter**\ (\ unicode\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_is_valid_letter>`
  1842. Returns ``true`` if the given code point is a valid letter, i.e. it belongs to the Unicode category "L".
  1843. .. rst-class:: classref-item-separator
  1844. ----
  1845. .. _class_TextServer_method_load_support_data:
  1846. .. rst-class:: classref-method
  1847. :ref:`bool<class_bool>` **load_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_load_support_data>`
  1848. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1849. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1850. .. rst-class:: classref-item-separator
  1851. ----
  1852. .. _class_TextServer_method_name_to_tag:
  1853. .. rst-class:: classref-method
  1854. :ref:`int<class_int>` **name_to_tag**\ (\ name\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_name_to_tag>`
  1855. Converts readable feature, variation, script, or language name to OpenType tag.
  1856. .. rst-class:: classref-item-separator
  1857. ----
  1858. .. _class_TextServer_method_parse_number:
  1859. .. rst-class:: classref-method
  1860. :ref:`String<class_String>` **parse_number**\ (\ number\: :ref:`String<class_String>`, language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_parse_number>`
  1861. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1862. .. rst-class:: classref-item-separator
  1863. ----
  1864. .. _class_TextServer_method_parse_structured_text:
  1865. .. rst-class:: classref-method
  1866. :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>`
  1867. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1868. .. rst-class:: classref-item-separator
  1869. ----
  1870. .. _class_TextServer_method_percent_sign:
  1871. .. rst-class:: classref-method
  1872. :ref:`String<class_String>` **percent_sign**\ (\ language\: :ref:`String<class_String>` = ""\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_percent_sign>`
  1873. Returns percent sign used in the ``language``.
  1874. .. rst-class:: classref-item-separator
  1875. ----
  1876. .. _class_TextServer_method_save_support_data:
  1877. .. rst-class:: classref-method
  1878. :ref:`bool<class_bool>` **save_support_data**\ (\ filename\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_save_support_data>`
  1879. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1880. \ **Note:** This function is used by during project export, to include TextServer database.
  1881. .. rst-class:: classref-item-separator
  1882. ----
  1883. .. _class_TextServer_method_shaped_get_span_count:
  1884. .. rst-class:: classref-method
  1885. :ref:`int<class_int>` **shaped_get_span_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_get_span_count>`
  1886. 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>`.
  1887. .. rst-class:: classref-item-separator
  1888. ----
  1889. .. _class_TextServer_method_shaped_get_span_meta:
  1890. .. rst-class:: classref-method
  1891. :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>`
  1892. Returns text span metadata.
  1893. .. rst-class:: classref-item-separator
  1894. ----
  1895. .. _class_TextServer_method_shaped_set_span_update_font:
  1896. .. rst-class:: classref-method
  1897. |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>`
  1898. Changes text span font, font size, and OpenType features, without changing the text.
  1899. .. rst-class:: classref-item-separator
  1900. ----
  1901. .. _class_TextServer_method_shaped_text_add_object:
  1902. .. rst-class:: classref-method
  1903. :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>`
  1904. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1905. .. rst-class:: classref-item-separator
  1906. ----
  1907. .. _class_TextServer_method_shaped_text_add_string:
  1908. .. rst-class:: classref-method
  1909. :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>`
  1910. Adds text span and font to draw it to the text buffer.
  1911. .. rst-class:: classref-item-separator
  1912. ----
  1913. .. _class_TextServer_method_shaped_text_clear:
  1914. .. rst-class:: classref-method
  1915. |void| **shaped_text_clear**\ (\ rid\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_clear>`
  1916. Clears text buffer (removes text and inline objects).
  1917. .. rst-class:: classref-item-separator
  1918. ----
  1919. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1920. .. rst-class:: classref-method
  1921. :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>`
  1922. Returns composite character position closest to the ``pos``.
  1923. .. rst-class:: classref-item-separator
  1924. ----
  1925. .. _class_TextServer_method_shaped_text_draw:
  1926. .. rst-class:: classref-method
  1927. |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>`
  1928. 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).
  1929. .. rst-class:: classref-item-separator
  1930. ----
  1931. .. _class_TextServer_method_shaped_text_draw_outline:
  1932. .. rst-class:: classref-method
  1933. |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>`
  1934. 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).
  1935. .. rst-class:: classref-item-separator
  1936. ----
  1937. .. _class_TextServer_method_shaped_text_fit_to_width:
  1938. .. rst-class:: classref-method
  1939. :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>`
  1940. Adjusts text width to fit to specified width, returns new text width.
  1941. .. rst-class:: classref-item-separator
  1942. ----
  1943. .. _class_TextServer_method_shaped_text_get_ascent:
  1944. .. rst-class:: classref-method
  1945. :ref:`float<class_float>` **shaped_text_get_ascent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ascent>`
  1946. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1947. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1948. .. rst-class:: classref-item-separator
  1949. ----
  1950. .. _class_TextServer_method_shaped_text_get_carets:
  1951. .. rst-class:: classref-method
  1952. :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>`
  1953. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1954. .. rst-class:: classref-item-separator
  1955. ----
  1956. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1957. .. rst-class:: classref-method
  1958. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_character_breaks>`
  1959. Returns array of the composite character boundaries.
  1960. .. rst-class:: classref-item-separator
  1961. ----
  1962. .. _class_TextServer_method_shaped_text_get_custom_ellipsis:
  1963. .. rst-class:: classref-method
  1964. :ref:`int<class_int>` **shaped_text_get_custom_ellipsis**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_ellipsis>`
  1965. Returns ellipsis character used for text clipping.
  1966. .. rst-class:: classref-item-separator
  1967. ----
  1968. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1969. .. rst-class:: classref-method
  1970. :ref:`String<class_String>` **shaped_text_get_custom_punctuation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_custom_punctuation>`
  1971. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1972. .. rst-class:: classref-item-separator
  1973. ----
  1974. .. _class_TextServer_method_shaped_text_get_descent:
  1975. .. rst-class:: classref-method
  1976. :ref:`float<class_float>` **shaped_text_get_descent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_descent>`
  1977. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1978. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1979. .. rst-class:: classref-item-separator
  1980. ----
  1981. .. _class_TextServer_method_shaped_text_get_direction:
  1982. .. rst-class:: classref-method
  1983. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_direction>`
  1984. Returns direction of the text.
  1985. .. rst-class:: classref-item-separator
  1986. ----
  1987. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1988. .. rst-class:: classref-method
  1989. :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>`
  1990. Returns dominant direction of in the range of text.
  1991. .. rst-class:: classref-item-separator
  1992. ----
  1993. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1994. .. rst-class:: classref-method
  1995. :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>`
  1996. Returns number of glyphs in the ellipsis.
  1997. .. rst-class:: classref-item-separator
  1998. ----
  1999. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  2000. .. rst-class:: classref-method
  2001. :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>`
  2002. Returns array of the glyphs in the ellipsis.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  2006. .. rst-class:: classref-method
  2007. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_ellipsis_pos>`
  2008. Returns position of the ellipsis.
  2009. .. rst-class:: classref-item-separator
  2010. ----
  2011. .. _class_TextServer_method_shaped_text_get_glyph_count:
  2012. .. rst-class:: classref-method
  2013. :ref:`int<class_int>` **shaped_text_get_glyph_count**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_glyph_count>`
  2014. Returns number of glyphs in the buffer.
  2015. .. rst-class:: classref-item-separator
  2016. ----
  2017. .. _class_TextServer_method_shaped_text_get_glyphs:
  2018. .. rst-class:: classref-method
  2019. :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>`
  2020. Returns an array of glyphs in the visual order.
  2021. .. rst-class:: classref-item-separator
  2022. ----
  2023. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  2024. .. rst-class:: classref-method
  2025. :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>`
  2026. Returns composite character's bounds as offsets from the start of the line.
  2027. .. rst-class:: classref-item-separator
  2028. ----
  2029. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  2030. .. rst-class:: classref-method
  2031. :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>`
  2032. Returns direction of the text, inferred by the BiDi algorithm.
  2033. .. rst-class:: classref-item-separator
  2034. ----
  2035. .. _class_TextServer_method_shaped_text_get_line_breaks:
  2036. .. rst-class:: classref-method
  2037. :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>`
  2038. Breaks text to the lines and returns character ranges for each line.
  2039. .. rst-class:: classref-item-separator
  2040. ----
  2041. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  2042. .. rst-class:: classref-method
  2043. :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>`
  2044. Breaks text to the lines and columns. Returns character ranges for each segment.
  2045. .. rst-class:: classref-item-separator
  2046. ----
  2047. .. _class_TextServer_method_shaped_text_get_object_glyph:
  2048. .. rst-class:: classref-method
  2049. :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>`
  2050. Returns the glyph index of the inline object.
  2051. .. rst-class:: classref-item-separator
  2052. ----
  2053. .. _class_TextServer_method_shaped_text_get_object_range:
  2054. .. rst-class:: classref-method
  2055. :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>`
  2056. Returns the character range of the inline object.
  2057. .. rst-class:: classref-item-separator
  2058. ----
  2059. .. _class_TextServer_method_shaped_text_get_object_rect:
  2060. .. rst-class:: classref-method
  2061. :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>`
  2062. Returns bounding rectangle of the inline object.
  2063. .. rst-class:: classref-item-separator
  2064. ----
  2065. .. _class_TextServer_method_shaped_text_get_objects:
  2066. .. rst-class:: classref-method
  2067. :ref:`Array<class_Array>` **shaped_text_get_objects**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_objects>`
  2068. Returns array of inline objects.
  2069. .. rst-class:: classref-item-separator
  2070. ----
  2071. .. _class_TextServer_method_shaped_text_get_orientation:
  2072. .. rst-class:: classref-method
  2073. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_orientation>`
  2074. Returns text orientation.
  2075. .. rst-class:: classref-item-separator
  2076. ----
  2077. .. _class_TextServer_method_shaped_text_get_parent:
  2078. .. rst-class:: classref-method
  2079. :ref:`RID<class_RID>` **shaped_text_get_parent**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_parent>`
  2080. Returns the parent buffer from which the substring originates.
  2081. .. rst-class:: classref-item-separator
  2082. ----
  2083. .. _class_TextServer_method_shaped_text_get_preserve_control:
  2084. .. rst-class:: classref-method
  2085. :ref:`bool<class_bool>` **shaped_text_get_preserve_control**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_control>`
  2086. Returns ``true`` if text buffer is configured to display control characters.
  2087. .. rst-class:: classref-item-separator
  2088. ----
  2089. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  2090. .. rst-class:: classref-method
  2091. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_preserve_invalid>`
  2092. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2093. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2094. .. rst-class:: classref-item-separator
  2095. ----
  2096. .. _class_TextServer_method_shaped_text_get_range:
  2097. .. rst-class:: classref-method
  2098. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_range>`
  2099. Returns substring buffer character range in the parent buffer.
  2100. .. rst-class:: classref-item-separator
  2101. ----
  2102. .. _class_TextServer_method_shaped_text_get_selection:
  2103. .. rst-class:: classref-method
  2104. :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>`
  2105. Returns selection rectangles for the specified character range.
  2106. .. rst-class:: classref-item-separator
  2107. ----
  2108. .. _class_TextServer_method_shaped_text_get_size:
  2109. .. rst-class:: classref-method
  2110. :ref:`Vector2<class_Vector2>` **shaped_text_get_size**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_size>`
  2111. Returns size of the text.
  2112. .. rst-class:: classref-item-separator
  2113. ----
  2114. .. _class_TextServer_method_shaped_text_get_spacing:
  2115. .. rst-class:: classref-method
  2116. :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>`
  2117. Returns extra spacing added between glyphs or lines in pixels.
  2118. .. rst-class:: classref-item-separator
  2119. ----
  2120. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2121. .. rst-class:: classref-method
  2122. :ref:`int<class_int>` **shaped_text_get_trim_pos**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_trim_pos>`
  2123. Returns the position of the overrun trim.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_TextServer_method_shaped_text_get_underline_position:
  2127. .. rst-class:: classref-method
  2128. :ref:`float<class_float>` **shaped_text_get_underline_position**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_position>`
  2129. Returns pixel offset of the underline below the baseline.
  2130. .. rst-class:: classref-item-separator
  2131. ----
  2132. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2133. .. rst-class:: classref-method
  2134. :ref:`float<class_float>` **shaped_text_get_underline_thickness**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_underline_thickness>`
  2135. Returns thickness of the underline.
  2136. .. rst-class:: classref-item-separator
  2137. ----
  2138. .. _class_TextServer_method_shaped_text_get_width:
  2139. .. rst-class:: classref-method
  2140. :ref:`float<class_float>` **shaped_text_get_width**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_get_width>`
  2141. Returns width (for horizontal layout) or height (for vertical) of the text.
  2142. .. rst-class:: classref-item-separator
  2143. ----
  2144. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2145. .. rst-class:: classref-method
  2146. :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>`
  2147. 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>`).
  2148. .. rst-class:: classref-item-separator
  2149. ----
  2150. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2151. .. rst-class:: classref-method
  2152. :ref:`bool<class_bool>` **shaped_text_has_visible_chars**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_has_visible_chars>`
  2153. Returns ``true`` if text buffer contains any visible characters.
  2154. .. rst-class:: classref-item-separator
  2155. ----
  2156. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2157. .. rst-class:: classref-method
  2158. :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>`
  2159. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2160. .. rst-class:: classref-item-separator
  2161. ----
  2162. .. _class_TextServer_method_shaped_text_hit_test_position:
  2163. .. rst-class:: classref-method
  2164. :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>`
  2165. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2166. .. rst-class:: classref-item-separator
  2167. ----
  2168. .. _class_TextServer_method_shaped_text_is_ready:
  2169. .. rst-class:: classref-method
  2170. :ref:`bool<class_bool>` **shaped_text_is_ready**\ (\ shaped\: :ref:`RID<class_RID>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_is_ready>`
  2171. Returns ``true`` if buffer is successfully shaped.
  2172. .. rst-class:: classref-item-separator
  2173. ----
  2174. .. _class_TextServer_method_shaped_text_next_character_pos:
  2175. .. rst-class:: classref-method
  2176. :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>`
  2177. Returns composite character end position closest to the ``pos``.
  2178. .. rst-class:: classref-item-separator
  2179. ----
  2180. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2181. .. rst-class:: classref-method
  2182. :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>`
  2183. Returns grapheme end position closest to the ``pos``.
  2184. .. rst-class:: classref-item-separator
  2185. ----
  2186. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2187. .. rst-class:: classref-method
  2188. |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>`
  2189. Trims text if it exceeds the given width.
  2190. .. rst-class:: classref-item-separator
  2191. ----
  2192. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2193. .. rst-class:: classref-method
  2194. :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>`
  2195. Returns composite character start position closest to the ``pos``.
  2196. .. rst-class:: classref-item-separator
  2197. ----
  2198. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2199. .. rst-class:: classref-method
  2200. :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>`
  2201. Returns grapheme start position closest to the ``pos``.
  2202. .. rst-class:: classref-item-separator
  2203. ----
  2204. .. _class_TextServer_method_shaped_text_resize_object:
  2205. .. rst-class:: classref-method
  2206. :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>`
  2207. Sets new size and alignment of embedded object.
  2208. .. rst-class:: classref-item-separator
  2209. ----
  2210. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2211. .. rst-class:: classref-method
  2212. |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>`
  2213. Overrides BiDi for the structured text.
  2214. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2215. .. rst-class:: classref-item-separator
  2216. ----
  2217. .. _class_TextServer_method_shaped_text_set_custom_ellipsis:
  2218. .. rst-class:: classref-method
  2219. |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>`
  2220. Sets ellipsis character used for text clipping.
  2221. .. rst-class:: classref-item-separator
  2222. ----
  2223. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2224. .. rst-class:: classref-method
  2225. |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>`
  2226. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2227. .. rst-class:: classref-item-separator
  2228. ----
  2229. .. _class_TextServer_method_shaped_text_set_direction:
  2230. .. rst-class:: classref-method
  2231. |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>`
  2232. 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.
  2233. \ **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>`).
  2234. .. rst-class:: classref-item-separator
  2235. ----
  2236. .. _class_TextServer_method_shaped_text_set_orientation:
  2237. .. rst-class:: classref-method
  2238. |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>`
  2239. Sets desired text orientation.
  2240. \ **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>`).
  2241. .. rst-class:: classref-item-separator
  2242. ----
  2243. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2244. .. rst-class:: classref-method
  2245. |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>`
  2246. If set to ``true`` text buffer will display control characters.
  2247. .. rst-class:: classref-item-separator
  2248. ----
  2249. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2250. .. rst-class:: classref-method
  2251. |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>`
  2252. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2253. .. rst-class:: classref-item-separator
  2254. ----
  2255. .. _class_TextServer_method_shaped_text_set_spacing:
  2256. .. rst-class:: classref-method
  2257. |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>`
  2258. Sets extra spacing added between glyphs or lines in pixels.
  2259. .. rst-class:: classref-item-separator
  2260. ----
  2261. .. _class_TextServer_method_shaped_text_shape:
  2262. .. rst-class:: classref-method
  2263. :ref:`bool<class_bool>` **shaped_text_shape**\ (\ shaped\: :ref:`RID<class_RID>`\ ) :ref:`๐Ÿ”—<class_TextServer_method_shaped_text_shape>`
  2264. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2265. \ **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.
  2266. .. rst-class:: classref-item-separator
  2267. ----
  2268. .. _class_TextServer_method_shaped_text_sort_logical:
  2269. .. rst-class:: classref-method
  2270. :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>`
  2271. Returns text glyphs in the logical order.
  2272. .. rst-class:: classref-item-separator
  2273. ----
  2274. .. _class_TextServer_method_shaped_text_substr:
  2275. .. rst-class:: classref-method
  2276. :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>`
  2277. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2278. .. rst-class:: classref-item-separator
  2279. ----
  2280. .. _class_TextServer_method_shaped_text_tab_align:
  2281. .. rst-class:: classref-method
  2282. :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>`
  2283. Aligns shaped text to the given tab-stops.
  2284. .. rst-class:: classref-item-separator
  2285. ----
  2286. .. _class_TextServer_method_spoof_check:
  2287. .. rst-class:: classref-method
  2288. :ref:`bool<class_bool>` **spoof_check**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_spoof_check>`
  2289. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2290. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2291. .. rst-class:: classref-item-separator
  2292. ----
  2293. .. _class_TextServer_method_string_get_character_breaks:
  2294. .. rst-class:: classref-method
  2295. :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>`
  2296. Returns array of the composite character boundaries.
  2297. ::
  2298. var ts = TextServerManager.get_primary_interface()
  2299. print(ts.string_get_word_breaks("Test โค๏ธโ€๐Ÿ”ฅ Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2300. .. rst-class:: classref-item-separator
  2301. ----
  2302. .. _class_TextServer_method_string_get_word_breaks:
  2303. .. rst-class:: classref-method
  2304. :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>`
  2305. 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.
  2306. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2307. ::
  2308. var ts = TextServerManager.get_primary_interface()
  2309. print(ts.string_get_word_breaks("The Godot Engine, 4")) # Prints [0, 3, 4, 9, 10, 16, 18, 19], which corresponds to the following substrings: "The", "Godot", "Engine", "4"
  2310. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 5)) # Prints [0, 3, 4, 9, 10, 15, 15, 19], which corresponds to the following substrings: "The", "Godot", "Engin", "e, 4"
  2311. print(ts.string_get_word_breaks("The Godot Engine, 4", "en", 10)) # Prints [0, 9, 10, 19], which corresponds to the following substrings: "The Godot", "Engine, 4"
  2312. .. rst-class:: classref-item-separator
  2313. ----
  2314. .. _class_TextServer_method_string_to_lower:
  2315. .. rst-class:: classref-method
  2316. :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>`
  2317. Returns the string converted to lowercase.
  2318. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2319. \ **Note:** The result may be longer or shorter than the original.
  2320. .. rst-class:: classref-item-separator
  2321. ----
  2322. .. _class_TextServer_method_string_to_title:
  2323. .. rst-class:: classref-method
  2324. :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>`
  2325. Returns the string converted to title case.
  2326. \ **Note:** Casing is locale dependent and context sensitive if server support :ref:`FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION<class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION>` feature (supported by :ref:`TextServerAdvanced<class_TextServerAdvanced>`).
  2327. \ **Note:** The result may be longer or shorter than the original.
  2328. .. rst-class:: classref-item-separator
  2329. ----
  2330. .. _class_TextServer_method_string_to_upper:
  2331. .. rst-class:: classref-method
  2332. :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>`
  2333. Returns the string converted to uppercase.
  2334. \ **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>`).
  2335. \ **Note:** The result may be longer or shorter than the original.
  2336. .. rst-class:: classref-item-separator
  2337. ----
  2338. .. _class_TextServer_method_strip_diacritics:
  2339. .. rst-class:: classref-method
  2340. :ref:`String<class_String>` **strip_diacritics**\ (\ string\: :ref:`String<class_String>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_strip_diacritics>`
  2341. Strips diacritics from the string.
  2342. \ **Note:** The result may be longer or shorter than the original.
  2343. .. rst-class:: classref-item-separator
  2344. ----
  2345. .. _class_TextServer_method_tag_to_name:
  2346. .. rst-class:: classref-method
  2347. :ref:`String<class_String>` **tag_to_name**\ (\ tag\: :ref:`int<class_int>`\ ) |const| :ref:`๐Ÿ”—<class_TextServer_method_tag_to_name>`
  2348. Converts OpenType tag to readable feature, variation, script, or language name.
  2349. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2350. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2351. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2352. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2353. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2354. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2355. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
  2356. .. |void| replace:: :abbr:`void (No return value.)`