class_textserver.rst 284 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101
  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. .. rst-class:: classref-reftable-group
  17. Methods
  18. -------
  19. .. table::
  20. :widths: auto
  21. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  22. | :ref:`RID<class_RID>` | :ref:`create_font<class_TextServer_method_create_font>` **(** **)** |
  23. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  24. | :ref:`RID<class_RID>` | :ref:`create_font_linked_variation<class_TextServer_method_create_font_linked_variation>` **(** :ref:`RID<class_RID>` font_rid **)** |
  25. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  26. | :ref:`RID<class_RID>` | :ref:`create_shaped_text<class_TextServer_method_create_shaped_text>` **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)** |
  27. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  28. | void | :ref:`draw_hex_code_box<class_TextServer_method_draw_hex_code_box>` **(** :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |const| |
  29. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  30. | void | :ref:`font_clear_glyphs<class_TextServer_method_font_clear_glyphs>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  31. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  32. | void | :ref:`font_clear_kerning_map<class_TextServer_method_font_clear_kerning_map>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |
  33. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  34. | void | :ref:`font_clear_size_cache<class_TextServer_method_font_clear_size_cache>` **(** :ref:`RID<class_RID>` font_rid **)** |
  35. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  36. | void | :ref:`font_clear_textures<class_TextServer_method_font_clear_textures>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  37. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  38. | void | :ref:`font_draw_glyph<class_TextServer_method_font_draw_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
  39. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  40. | void | :ref:`font_draw_glyph_outline<class_TextServer_method_font_draw_glyph_outline>` **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`int<class_int>` outline_size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
  41. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  42. | :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` | :ref:`font_get_antialiasing<class_TextServer_method_font_get_antialiasing>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  43. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  44. | :ref:`float<class_float>` | :ref:`font_get_ascent<class_TextServer_method_font_get_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  45. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  46. | :ref:`int<class_int>` | :ref:`font_get_char_from_glyph_index<class_TextServer_method_font_get_char_from_glyph_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph_index **)** |const| |
  47. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  48. | :ref:`float<class_float>` | :ref:`font_get_descent<class_TextServer_method_font_get_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  49. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  50. | :ref:`float<class_float>` | :ref:`font_get_embolden<class_TextServer_method_font_get_embolden>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  51. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  52. | :ref:`int<class_int>` | :ref:`font_get_face_count<class_TextServer_method_font_get_face_count>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  53. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  54. | :ref:`int<class_int>` | :ref:`font_get_face_index<class_TextServer_method_font_get_face_index>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  55. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  56. | :ref:`int<class_int>` | :ref:`font_get_fixed_size<class_TextServer_method_font_get_fixed_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  57. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  58. | :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` | :ref:`font_get_fixed_size_scale_mode<class_TextServer_method_font_get_fixed_size_scale_mode>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  59. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  60. | :ref:`bool<class_bool>` | :ref:`font_get_generate_mipmaps<class_TextServer_method_font_get_generate_mipmaps>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  61. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`font_get_global_oversampling<class_TextServer_method_font_get_global_oversampling>` **(** **)** |const| |
  63. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  64. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_advance<class_TextServer_method_font_get_glyph_advance>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |const| |
  65. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  66. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_glyph_contours<class_TextServer_method_font_get_glyph_contours>` **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const| |
  67. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  68. | :ref:`int<class_int>` | :ref:`font_get_glyph_index<class_TextServer_method_font_get_glyph_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |const| |
  69. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  70. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_glyph_list<class_TextServer_method_font_get_glyph_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const| |
  71. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  72. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_offset<class_TextServer_method_font_get_glyph_offset>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  73. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  74. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_size<class_TextServer_method_font_get_glyph_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  75. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`font_get_glyph_texture_idx<class_TextServer_method_font_get_glyph_texture_idx>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  77. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  78. | :ref:`RID<class_RID>` | :ref:`font_get_glyph_texture_rid<class_TextServer_method_font_get_glyph_texture_rid>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  79. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  80. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_glyph_texture_size<class_TextServer_method_font_get_glyph_texture_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  81. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  82. | :ref:`Rect2<class_Rect2>` | :ref:`font_get_glyph_uv_rect<class_TextServer_method_font_get_glyph_uv_rect>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const| |
  83. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  84. | :ref:`Hinting<enum_TextServer_Hinting>` | :ref:`font_get_hinting<class_TextServer_method_font_get_hinting>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  85. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  86. | :ref:`Vector2<class_Vector2>` | :ref:`font_get_kerning<class_TextServer_method_font_get_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const| |
  87. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  88. | :ref:`Vector2i[]<class_Vector2i>` | :ref:`font_get_kerning_list<class_TextServer_method_font_get_kerning_list>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  89. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  90. | :ref:`bool<class_bool>` | :ref:`font_get_language_support_override<class_TextServer_method_font_get_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |
  91. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  92. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_language_support_overrides<class_TextServer_method_font_get_language_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  93. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  94. | :ref:`int<class_int>` | :ref:`font_get_msdf_pixel_range<class_TextServer_method_font_get_msdf_pixel_range>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  95. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  96. | :ref:`int<class_int>` | :ref:`font_get_msdf_size<class_TextServer_method_font_get_msdf_size>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  97. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  98. | :ref:`String<class_String>` | :ref:`font_get_name<class_TextServer_method_font_get_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  99. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  100. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_opentype_feature_overrides<class_TextServer_method_font_get_opentype_feature_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  101. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  102. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_ot_name_strings<class_TextServer_method_font_get_ot_name_strings>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  103. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  104. | :ref:`float<class_float>` | :ref:`font_get_oversampling<class_TextServer_method_font_get_oversampling>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  105. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  106. | :ref:`float<class_float>` | :ref:`font_get_scale<class_TextServer_method_font_get_scale>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  107. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  108. | :ref:`bool<class_bool>` | :ref:`font_get_script_support_override<class_TextServer_method_font_get_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |
  109. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  110. | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`font_get_script_support_overrides<class_TextServer_method_font_get_script_support_overrides>` **(** :ref:`RID<class_RID>` font_rid **)** |
  111. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  112. | :ref:`Vector2i[]<class_Vector2i>` | :ref:`font_get_size_cache_list<class_TextServer_method_font_get_size_cache_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  113. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  114. | :ref:`int<class_int>` | :ref:`font_get_spacing<class_TextServer_method_font_get_spacing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const| |
  115. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  116. | :ref:`int<class_int>` | :ref:`font_get_stretch<class_TextServer_method_font_get_stretch>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  117. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  118. | |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> | :ref:`font_get_style<class_TextServer_method_font_get_style>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  119. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  120. | :ref:`String<class_String>` | :ref:`font_get_style_name<class_TextServer_method_font_get_style_name>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  121. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  122. | :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` | :ref:`font_get_subpixel_positioning<class_TextServer_method_font_get_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  123. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  124. | :ref:`String<class_String>` | :ref:`font_get_supported_chars<class_TextServer_method_font_get_supported_chars>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  125. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  126. | :ref:`int<class_int>` | :ref:`font_get_texture_count<class_TextServer_method_font_get_texture_count>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const| |
  127. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  128. | :ref:`Image<class_Image>` | :ref:`font_get_texture_image<class_TextServer_method_font_get_texture_image>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const| |
  129. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  130. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`font_get_texture_offsets<class_TextServer_method_font_get_texture_offsets>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const| |
  131. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  132. | :ref:`Transform2D<class_Transform2D>` | :ref:`font_get_transform<class_TextServer_method_font_get_transform>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  133. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  134. | :ref:`float<class_float>` | :ref:`font_get_underline_position<class_TextServer_method_font_get_underline_position>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  135. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  136. | :ref:`float<class_float>` | :ref:`font_get_underline_thickness<class_TextServer_method_font_get_underline_thickness>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const| |
  137. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  138. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_get_variation_coordinates<class_TextServer_method_font_get_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  139. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  140. | :ref:`int<class_int>` | :ref:`font_get_weight<class_TextServer_method_font_get_weight>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  141. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  142. | :ref:`bool<class_bool>` | :ref:`font_has_char<class_TextServer_method_font_has_char>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const| |
  143. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  144. | :ref:`bool<class_bool>` | :ref:`font_is_allow_system_fallback<class_TextServer_method_font_is_allow_system_fallback>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  145. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  146. | :ref:`bool<class_bool>` | :ref:`font_is_force_autohinter<class_TextServer_method_font_is_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  147. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  148. | :ref:`bool<class_bool>` | :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const| |
  149. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  150. | :ref:`bool<class_bool>` | :ref:`font_is_multichannel_signed_distance_field<class_TextServer_method_font_is_multichannel_signed_distance_field>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  151. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  152. | :ref:`bool<class_bool>` | :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const| |
  153. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  154. | void | :ref:`font_remove_glyph<class_TextServer_method_font_remove_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |
  155. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  156. | void | :ref:`font_remove_kerning<class_TextServer_method_font_remove_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |
  157. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  158. | void | :ref:`font_remove_language_support_override<class_TextServer_method_font_remove_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |
  159. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  160. | void | :ref:`font_remove_script_support_override<class_TextServer_method_font_remove_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |
  161. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  162. | void | :ref:`font_remove_size_cache<class_TextServer_method_font_remove_size_cache>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |
  163. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  164. | void | :ref:`font_remove_texture<class_TextServer_method_font_remove_texture>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |
  165. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  166. | void | :ref:`font_render_glyph<class_TextServer_method_font_render_glyph>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)** |
  167. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  168. | void | :ref:`font_render_range<class_TextServer_method_font_render_range>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |
  169. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  170. | void | :ref:`font_set_allow_system_fallback<class_TextServer_method_font_set_allow_system_fallback>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)** |
  171. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  172. | void | :ref:`font_set_antialiasing<class_TextServer_method_font_set_antialiasing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)** |
  173. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  174. | void | :ref:`font_set_ascent<class_TextServer_method_font_set_ascent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)** |
  175. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  176. | void | :ref:`font_set_data<class_TextServer_method_font_set_data>` **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)** |
  177. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  178. | void | :ref:`font_set_descent<class_TextServer_method_font_set_descent>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)** |
  179. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  180. | void | :ref:`font_set_embolden<class_TextServer_method_font_set_embolden>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)** |
  181. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  182. | void | :ref:`font_set_face_index<class_TextServer_method_font_set_face_index>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)** |
  183. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  184. | void | :ref:`font_set_fixed_size<class_TextServer_method_font_set_fixed_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)** |
  185. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  186. | void | :ref:`font_set_fixed_size_scale_mode<class_TextServer_method_font_set_fixed_size_scale_mode>` **(** :ref:`RID<class_RID>` font_rid, :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` fixed_size_scale_mode **)** |
  187. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  188. | void | :ref:`font_set_force_autohinter<class_TextServer_method_font_set_force_autohinter>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)** |
  189. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  190. | void | :ref:`font_set_generate_mipmaps<class_TextServer_method_font_set_generate_mipmaps>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)** |
  191. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  192. | void | :ref:`font_set_global_oversampling<class_TextServer_method_font_set_global_oversampling>` **(** :ref:`float<class_float>` oversampling **)** |
  193. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  194. | void | :ref:`font_set_glyph_advance<class_TextServer_method_font_set_glyph_advance>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` advance **)** |
  195. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  196. | void | :ref:`font_set_glyph_offset<class_TextServer_method_font_set_glyph_offset>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` offset **)** |
  197. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  198. | void | :ref:`font_set_glyph_size<class_TextServer_method_font_set_glyph_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` gl_size **)** |
  199. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  200. | void | :ref:`font_set_glyph_texture_idx<class_TextServer_method_font_set_glyph_texture_idx>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`int<class_int>` texture_idx **)** |
  201. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  202. | void | :ref:`font_set_glyph_uv_rect<class_TextServer_method_font_set_glyph_uv_rect>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Rect2<class_Rect2>` uv_rect **)** |
  203. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  204. | void | :ref:`font_set_hinting<class_TextServer_method_font_set_hinting>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)** |
  205. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  206. | void | :ref:`font_set_kerning<class_TextServer_method_font_set_kerning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair, :ref:`Vector2<class_Vector2>` kerning **)** |
  207. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  208. | void | :ref:`font_set_language_support_override<class_TextServer_method_font_set_language_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)** |
  209. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  210. | void | :ref:`font_set_msdf_pixel_range<class_TextServer_method_font_set_msdf_pixel_range>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)** |
  211. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  212. | void | :ref:`font_set_msdf_size<class_TextServer_method_font_set_msdf_size>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)** |
  213. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  214. | void | :ref:`font_set_multichannel_signed_distance_field<class_TextServer_method_font_set_multichannel_signed_distance_field>` **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)** |
  215. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  216. | void | :ref:`font_set_name<class_TextServer_method_font_set_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  217. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  218. | void | :ref:`font_set_opentype_feature_overrides<class_TextServer_method_font_set_opentype_feature_overrides>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)** |
  219. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  220. | void | :ref:`font_set_oversampling<class_TextServer_method_font_set_oversampling>` **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)** |
  221. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  222. | void | :ref:`font_set_scale<class_TextServer_method_font_set_scale>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)** |
  223. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  224. | void | :ref:`font_set_script_support_override<class_TextServer_method_font_set_script_support_override>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)** |
  225. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  226. | void | :ref:`font_set_spacing<class_TextServer_method_font_set_spacing>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)** |
  227. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  228. | void | :ref:`font_set_stretch<class_TextServer_method_font_set_stretch>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  229. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  230. | void | :ref:`font_set_style<class_TextServer_method_font_set_style>` **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)** |
  231. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  232. | void | :ref:`font_set_style_name<class_TextServer_method_font_set_style_name>` **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)** |
  233. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  234. | void | :ref:`font_set_subpixel_positioning<class_TextServer_method_font_set_subpixel_positioning>` **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)** |
  235. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  236. | void | :ref:`font_set_texture_image<class_TextServer_method_font_set_texture_image>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`Image<class_Image>` image **)** |
  237. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  238. | void | :ref:`font_set_texture_offsets<class_TextServer_method_font_set_texture_offsets>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`PackedInt32Array<class_PackedInt32Array>` offset **)** |
  239. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  240. | void | :ref:`font_set_transform<class_TextServer_method_font_set_transform>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)** |
  241. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  242. | void | :ref:`font_set_underline_position<class_TextServer_method_font_set_underline_position>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)** |
  243. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  244. | void | :ref:`font_set_underline_thickness<class_TextServer_method_font_set_underline_thickness>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)** |
  245. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  246. | void | :ref:`font_set_variation_coordinates<class_TextServer_method_font_set_variation_coordinates>` **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)** |
  247. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  248. | void | :ref:`font_set_weight<class_TextServer_method_font_set_weight>` **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)** |
  249. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  250. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_feature_list<class_TextServer_method_font_supported_feature_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  251. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  252. | :ref:`Dictionary<class_Dictionary>` | :ref:`font_supported_variation_list<class_TextServer_method_font_supported_variation_list>` **(** :ref:`RID<class_RID>` font_rid **)** |const| |
  253. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  254. | :ref:`String<class_String>` | :ref:`format_number<class_TextServer_method_format_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  255. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  256. | void | :ref:`free_rid<class_TextServer_method_free_rid>` **(** :ref:`RID<class_RID>` rid **)** |
  257. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  258. | :ref:`int<class_int>` | :ref:`get_features<class_TextServer_method_get_features>` **(** **)** |const| |
  259. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  260. | :ref:`Vector2<class_Vector2>` | :ref:`get_hex_code_box_size<class_TextServer_method_get_hex_code_box_size>` **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const| |
  261. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  262. | :ref:`String<class_String>` | :ref:`get_name<class_TextServer_method_get_name>` **(** **)** |const| |
  263. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  264. | :ref:`String<class_String>` | :ref:`get_support_data_filename<class_TextServer_method_get_support_data_filename>` **(** **)** |const| |
  265. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  266. | :ref:`String<class_String>` | :ref:`get_support_data_info<class_TextServer_method_get_support_data_info>` **(** **)** |const| |
  267. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  268. | :ref:`bool<class_bool>` | :ref:`has<class_TextServer_method_has>` **(** :ref:`RID<class_RID>` rid **)** |
  269. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  270. | :ref:`bool<class_bool>` | :ref:`has_feature<class_TextServer_method_has_feature>` **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const| |
  271. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  272. | :ref:`int<class_int>` | :ref:`is_confusable<class_TextServer_method_is_confusable>` **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const| |
  273. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  274. | :ref:`bool<class_bool>` | :ref:`is_locale_right_to_left<class_TextServer_method_is_locale_right_to_left>` **(** :ref:`String<class_String>` locale **)** |const| |
  275. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  276. | :ref:`bool<class_bool>` | :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>` **(** :ref:`String<class_String>` string **)** |const| |
  277. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  278. | :ref:`bool<class_bool>` | :ref:`load_support_data<class_TextServer_method_load_support_data>` **(** :ref:`String<class_String>` filename **)** |
  279. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  280. | :ref:`int<class_int>` | :ref:`name_to_tag<class_TextServer_method_name_to_tag>` **(** :ref:`String<class_String>` name **)** |const| |
  281. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  282. | :ref:`String<class_String>` | :ref:`parse_number<class_TextServer_method_parse_number>` **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const| |
  283. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  284. | :ref:`Vector3i[]<class_Vector3i>` | :ref:`parse_structured_text<class_TextServer_method_parse_structured_text>` **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const| |
  285. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  286. | :ref:`String<class_String>` | :ref:`percent_sign<class_TextServer_method_percent_sign>` **(** :ref:`String<class_String>` language="" **)** |const| |
  287. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  288. | :ref:`bool<class_bool>` | :ref:`save_support_data<class_TextServer_method_save_support_data>` **(** :ref:`String<class_String>` filename **)** |const| |
  289. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  290. | :ref:`int<class_int>` | :ref:`shaped_get_span_count<class_TextServer_method_shaped_get_span_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  291. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  292. | :ref:`Variant<class_Variant>` | :ref:`shaped_get_span_meta<class_TextServer_method_shaped_get_span_meta>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const| |
  293. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  294. | void | :ref:`shaped_set_span_update_font<class_TextServer_method_shaped_set_span_update_font>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={} **)** |
  295. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  296. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_object<class_TextServer_method_shaped_text_add_object>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=5, :ref:`int<class_int>` length=1, :ref:`float<class_float>` baseline=0.0 **)** |
  297. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  298. | :ref:`bool<class_bool>` | :ref:`shaped_text_add_string<class_TextServer_method_shaped_text_add_string>` **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` text, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={}, :ref:`String<class_String>` language="", :ref:`Variant<class_Variant>` meta=null **)** |
  299. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  300. | void | :ref:`shaped_text_clear<class_TextServer_method_shaped_text_clear>` **(** :ref:`RID<class_RID>` rid **)** |
  301. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  302. | :ref:`int<class_int>` | :ref:`shaped_text_closest_character_pos<class_TextServer_method_shaped_text_closest_character_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  303. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  304. | void | :ref:`shaped_text_draw<class_TextServer_method_shaped_text_draw>` **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l=-1, :ref:`float<class_float>` clip_r=-1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
  305. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  306. | void | :ref:`shaped_text_draw_outline<class_TextServer_method_shaped_text_draw_outline>` **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l=-1, :ref:`float<class_float>` clip_r=-1, :ref:`int<class_int>` outline_size=1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const| |
  307. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  308. | :ref:`float<class_float>` | :ref:`shaped_text_fit_to_width<class_TextServer_method_shaped_text_fit_to_width>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, |bitfield|\<:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\> justification_flags=3 **)** |
  309. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  310. | :ref:`float<class_float>` | :ref:`shaped_text_get_ascent<class_TextServer_method_shaped_text_get_ascent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  311. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  312. | :ref:`Dictionary<class_Dictionary>` | :ref:`shaped_text_get_carets<class_TextServer_method_shaped_text_get_carets>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const| |
  313. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  314. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_character_breaks<class_TextServer_method_shaped_text_get_character_breaks>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  315. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  316. | :ref:`int<class_int>` | :ref:`shaped_text_get_custom_ellipsis<class_TextServer_method_shaped_text_get_custom_ellipsis>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  317. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  318. | :ref:`String<class_String>` | :ref:`shaped_text_get_custom_punctuation<class_TextServer_method_shaped_text_get_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  319. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  320. | :ref:`float<class_float>` | :ref:`shaped_text_get_descent<class_TextServer_method_shaped_text_get_descent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  321. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  322. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_direction<class_TextServer_method_shaped_text_get_direction>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  323. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  324. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_dominant_direction_in_range<class_TextServer_method_shaped_text_get_dominant_direction_in_range>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const| |
  325. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  326. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_glyph_count<class_TextServer_method_shaped_text_get_ellipsis_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  327. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  328. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_ellipsis_glyphs<class_TextServer_method_shaped_text_get_ellipsis_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  329. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  330. | :ref:`int<class_int>` | :ref:`shaped_text_get_ellipsis_pos<class_TextServer_method_shaped_text_get_ellipsis_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  331. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  332. | :ref:`int<class_int>` | :ref:`shaped_text_get_glyph_count<class_TextServer_method_shaped_text_get_glyph_count>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  333. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  334. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_get_glyphs<class_TextServer_method_shaped_text_get_glyphs>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  335. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  336. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_grapheme_bounds<class_TextServer_method_shaped_text_get_grapheme_bounds>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  337. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  338. | :ref:`Direction<enum_TextServer_Direction>` | :ref:`shaped_text_get_inferred_direction<class_TextServer_method_shaped_text_get_inferred_direction>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  339. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  340. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks<class_TextServer_method_shaped_text_get_line_breaks>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` start=0, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const| |
  341. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  342. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_line_breaks_adv<class_TextServer_method_shaped_text_get_line_breaks_adv>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` width, :ref:`int<class_int>` start=0, :ref:`bool<class_bool>` once=true, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const| |
  343. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  344. | :ref:`Rect2<class_Rect2>` | :ref:`shaped_text_get_object_rect<class_TextServer_method_shaped_text_get_object_rect>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const| |
  345. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  346. | :ref:`Array<class_Array>` | :ref:`shaped_text_get_objects<class_TextServer_method_shaped_text_get_objects>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  347. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  348. | :ref:`Orientation<enum_TextServer_Orientation>` | :ref:`shaped_text_get_orientation<class_TextServer_method_shaped_text_get_orientation>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  349. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  350. | :ref:`RID<class_RID>` | :ref:`shaped_text_get_parent<class_TextServer_method_shaped_text_get_parent>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  351. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  352. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_control<class_TextServer_method_shaped_text_get_preserve_control>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  353. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  354. | :ref:`bool<class_bool>` | :ref:`shaped_text_get_preserve_invalid<class_TextServer_method_shaped_text_get_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  355. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  356. | :ref:`Vector2i<class_Vector2i>` | :ref:`shaped_text_get_range<class_TextServer_method_shaped_text_get_range>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  357. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  358. | :ref:`PackedVector2Array<class_PackedVector2Array>` | :ref:`shaped_text_get_selection<class_TextServer_method_shaped_text_get_selection>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const| |
  359. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  360. | :ref:`Vector2<class_Vector2>` | :ref:`shaped_text_get_size<class_TextServer_method_shaped_text_get_size>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  361. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  362. | :ref:`int<class_int>` | :ref:`shaped_text_get_spacing<class_TextServer_method_shaped_text_get_spacing>` **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const| |
  363. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  364. | :ref:`int<class_int>` | :ref:`shaped_text_get_trim_pos<class_TextServer_method_shaped_text_get_trim_pos>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  365. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  366. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_position<class_TextServer_method_shaped_text_get_underline_position>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  367. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  368. | :ref:`float<class_float>` | :ref:`shaped_text_get_underline_thickness<class_TextServer_method_shaped_text_get_underline_thickness>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  369. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  370. | :ref:`float<class_float>` | :ref:`shaped_text_get_width<class_TextServer_method_shaped_text_get_width>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  371. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  372. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`shaped_text_get_word_breaks<class_TextServer_method_shaped_text_get_word_breaks>` **(** :ref:`RID<class_RID>` shaped, |bitfield|\<:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\> grapheme_flags=264 **)** |const| |
  373. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  374. | :ref:`bool<class_bool>` | :ref:`shaped_text_has_visible_chars<class_TextServer_method_shaped_text_has_visible_chars>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  375. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  376. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_grapheme<class_TextServer_method_shaped_text_hit_test_grapheme>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const| |
  377. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  378. | :ref:`int<class_int>` | :ref:`shaped_text_hit_test_position<class_TextServer_method_shaped_text_hit_test_position>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const| |
  379. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  380. | :ref:`bool<class_bool>` | :ref:`shaped_text_is_ready<class_TextServer_method_shaped_text_is_ready>` **(** :ref:`RID<class_RID>` shaped **)** |const| |
  381. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  382. | :ref:`int<class_int>` | :ref:`shaped_text_next_character_pos<class_TextServer_method_shaped_text_next_character_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  383. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  384. | :ref:`int<class_int>` | :ref:`shaped_text_next_grapheme_pos<class_TextServer_method_shaped_text_next_grapheme_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  385. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  386. | void | :ref:`shaped_text_overrun_trim_to_width<class_TextServer_method_shaped_text_overrun_trim_to_width>` **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width=0, |bitfield|\<:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\> overrun_trim_flags=0 **)** |
  387. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  388. | :ref:`int<class_int>` | :ref:`shaped_text_prev_character_pos<class_TextServer_method_shaped_text_prev_character_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  389. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  390. | :ref:`int<class_int>` | :ref:`shaped_text_prev_grapheme_pos<class_TextServer_method_shaped_text_prev_grapheme_pos>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const| |
  391. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  392. | :ref:`bool<class_bool>` | :ref:`shaped_text_resize_object<class_TextServer_method_shaped_text_resize_object>` **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=5, :ref:`float<class_float>` baseline=0.0 **)** |
  393. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  394. | void | :ref:`shaped_text_set_bidi_override<class_TextServer_method_shaped_text_set_bidi_override>` **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)** |
  395. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  396. | void | :ref:`shaped_text_set_custom_ellipsis<class_TextServer_method_shaped_text_set_custom_ellipsis>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` char **)** |
  397. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  398. | void | :ref:`shaped_text_set_custom_punctuation<class_TextServer_method_shaped_text_set_custom_punctuation>` **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)** |
  399. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  400. | void | :ref:`shaped_text_set_direction<class_TextServer_method_shaped_text_set_direction>` **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)** |
  401. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  402. | void | :ref:`shaped_text_set_orientation<class_TextServer_method_shaped_text_set_orientation>` **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)** |
  403. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  404. | void | :ref:`shaped_text_set_preserve_control<class_TextServer_method_shaped_text_set_preserve_control>` **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |
  405. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  406. | void | :ref:`shaped_text_set_preserve_invalid<class_TextServer_method_shaped_text_set_preserve_invalid>` **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)** |
  407. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  408. | void | :ref:`shaped_text_set_spacing<class_TextServer_method_shaped_text_set_spacing>` **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)** |
  409. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  410. | :ref:`bool<class_bool>` | :ref:`shaped_text_shape<class_TextServer_method_shaped_text_shape>` **(** :ref:`RID<class_RID>` shaped **)** |
  411. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  412. | :ref:`Dictionary[]<class_Dictionary>` | :ref:`shaped_text_sort_logical<class_TextServer_method_shaped_text_sort_logical>` **(** :ref:`RID<class_RID>` shaped **)** |
  413. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  414. | :ref:`RID<class_RID>` | :ref:`shaped_text_substr<class_TextServer_method_shaped_text_substr>` **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const| |
  415. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  416. | :ref:`float<class_float>` | :ref:`shaped_text_tab_align<class_TextServer_method_shaped_text_tab_align>` **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)** |
  417. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  418. | :ref:`bool<class_bool>` | :ref:`spoof_check<class_TextServer_method_spoof_check>` **(** :ref:`String<class_String>` string **)** |const| |
  419. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  420. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_character_breaks<class_TextServer_method_string_get_character_breaks>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
  421. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  422. | :ref:`PackedInt32Array<class_PackedInt32Array>` | :ref:`string_get_word_breaks<class_TextServer_method_string_get_word_breaks>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="", :ref:`int<class_int>` chars_per_line=0 **)** |const| |
  423. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  424. | :ref:`String<class_String>` | :ref:`string_to_lower<class_TextServer_method_string_to_lower>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
  425. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  426. | :ref:`String<class_String>` | :ref:`string_to_upper<class_TextServer_method_string_to_upper>` **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const| |
  427. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  428. | :ref:`String<class_String>` | :ref:`strip_diacritics<class_TextServer_method_strip_diacritics>` **(** :ref:`String<class_String>` string **)** |const| |
  429. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  430. | :ref:`String<class_String>` | :ref:`tag_to_name<class_TextServer_method_tag_to_name>` **(** :ref:`int<class_int>` tag **)** |const| |
  431. +-----------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  432. .. rst-class:: classref-section-separator
  433. ----
  434. .. rst-class:: classref-descriptions-group
  435. Enumerations
  436. ------------
  437. .. _enum_TextServer_FontAntialiasing:
  438. .. rst-class:: classref-enumeration
  439. enum **FontAntialiasing**:
  440. .. _class_TextServer_constant_FONT_ANTIALIASING_NONE:
  441. .. rst-class:: classref-enumeration-constant
  442. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_NONE** = ``0``
  443. Font glyphs are rasterized as 1-bit bitmaps.
  444. .. _class_TextServer_constant_FONT_ANTIALIASING_GRAY:
  445. .. rst-class:: classref-enumeration-constant
  446. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_GRAY** = ``1``
  447. Font glyphs are rasterized as 8-bit grayscale anti-aliased bitmaps.
  448. .. _class_TextServer_constant_FONT_ANTIALIASING_LCD:
  449. .. rst-class:: classref-enumeration-constant
  450. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **FONT_ANTIALIASING_LCD** = ``2``
  451. Font glyphs are rasterized for LCD screens.
  452. LCD subpixel layout is determined by the value of ``gui/theme/lcd_subpixel_layout`` project settings.
  453. LCD subpixel anti-aliasing mode is suitable only for rendering horizontal, unscaled text in 2D.
  454. .. rst-class:: classref-item-separator
  455. ----
  456. .. _enum_TextServer_FontLCDSubpixelLayout:
  457. .. rst-class:: classref-enumeration
  458. enum **FontLCDSubpixelLayout**:
  459. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_NONE:
  460. .. rst-class:: classref-enumeration-constant
  461. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_NONE** = ``0``
  462. Unknown or unsupported subpixel layout, LCD subpixel antialiasing is disabled.
  463. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HRGB:
  464. .. rst-class:: classref-enumeration-constant
  465. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HRGB** = ``1``
  466. Horizontal RGB subpixel layout.
  467. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_HBGR:
  468. .. rst-class:: classref-enumeration-constant
  469. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_HBGR** = ``2``
  470. Horizontal BGR subpixel layout.
  471. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VRGB:
  472. .. rst-class:: classref-enumeration-constant
  473. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VRGB** = ``3``
  474. Vertical RGB subpixel layout.
  475. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_VBGR:
  476. .. rst-class:: classref-enumeration-constant
  477. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_VBGR** = ``4``
  478. Vertical BGR subpixel layout.
  479. .. _class_TextServer_constant_FONT_LCD_SUBPIXEL_LAYOUT_MAX:
  480. .. rst-class:: classref-enumeration-constant
  481. :ref:`FontLCDSubpixelLayout<enum_TextServer_FontLCDSubpixelLayout>` **FONT_LCD_SUBPIXEL_LAYOUT_MAX** = ``5``
  482. .. rst-class:: classref-item-separator
  483. ----
  484. .. _enum_TextServer_Direction:
  485. .. rst-class:: classref-enumeration
  486. enum **Direction**:
  487. .. _class_TextServer_constant_DIRECTION_AUTO:
  488. .. rst-class:: classref-enumeration-constant
  489. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_AUTO** = ``0``
  490. Text direction is determined based on contents and current locale.
  491. .. _class_TextServer_constant_DIRECTION_LTR:
  492. .. rst-class:: classref-enumeration-constant
  493. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_LTR** = ``1``
  494. Text is written from left to right.
  495. .. _class_TextServer_constant_DIRECTION_RTL:
  496. .. rst-class:: classref-enumeration-constant
  497. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_RTL** = ``2``
  498. Text is written from right to left.
  499. .. _class_TextServer_constant_DIRECTION_INHERITED:
  500. .. rst-class:: classref-enumeration-constant
  501. :ref:`Direction<enum_TextServer_Direction>` **DIRECTION_INHERITED** = ``3``
  502. Text writing direction is the same as base string writing direction. Used for BiDi override only.
  503. .. rst-class:: classref-item-separator
  504. ----
  505. .. _enum_TextServer_Orientation:
  506. .. rst-class:: classref-enumeration
  507. enum **Orientation**:
  508. .. _class_TextServer_constant_ORIENTATION_HORIZONTAL:
  509. .. rst-class:: classref-enumeration-constant
  510. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_HORIZONTAL** = ``0``
  511. Text is written horizontally.
  512. .. _class_TextServer_constant_ORIENTATION_VERTICAL:
  513. .. rst-class:: classref-enumeration-constant
  514. :ref:`Orientation<enum_TextServer_Orientation>` **ORIENTATION_VERTICAL** = ``1``
  515. Left to right text is written vertically from top to bottom.
  516. Right to left text is written vertically from bottom to top.
  517. .. rst-class:: classref-item-separator
  518. ----
  519. .. _enum_TextServer_JustificationFlag:
  520. .. rst-class:: classref-enumeration
  521. flags **JustificationFlag**:
  522. .. _class_TextServer_constant_JUSTIFICATION_NONE:
  523. .. rst-class:: classref-enumeration-constant
  524. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_NONE** = ``0``
  525. Do not justify text.
  526. .. _class_TextServer_constant_JUSTIFICATION_KASHIDA:
  527. .. rst-class:: classref-enumeration-constant
  528. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_KASHIDA** = ``1``
  529. Justify text by adding and removing kashidas.
  530. .. _class_TextServer_constant_JUSTIFICATION_WORD_BOUND:
  531. .. rst-class:: classref-enumeration-constant
  532. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_WORD_BOUND** = ``2``
  533. Justify text by changing width of the spaces between the words.
  534. .. _class_TextServer_constant_JUSTIFICATION_TRIM_EDGE_SPACES:
  535. .. rst-class:: classref-enumeration-constant
  536. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_TRIM_EDGE_SPACES** = ``4``
  537. Remove trailing and leading spaces from the justified text.
  538. .. _class_TextServer_constant_JUSTIFICATION_AFTER_LAST_TAB:
  539. .. rst-class:: classref-enumeration-constant
  540. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_AFTER_LAST_TAB** = ``8``
  541. Only apply justification to the part of the text after the last tab.
  542. .. _class_TextServer_constant_JUSTIFICATION_CONSTRAIN_ELLIPSIS:
  543. .. rst-class:: classref-enumeration-constant
  544. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_CONSTRAIN_ELLIPSIS** = ``16``
  545. Apply justification to the trimmed line with ellipsis.
  546. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE:
  547. .. rst-class:: classref-enumeration-constant
  548. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE** = ``32``
  549. Do not apply justification to the last line of the paragraph.
  550. .. _class_TextServer_constant_JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS:
  551. .. rst-class:: classref-enumeration-constant
  552. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_SKIP_LAST_LINE_WITH_VISIBLE_CHARS** = ``64``
  553. 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>`).
  554. .. _class_TextServer_constant_JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE:
  555. .. rst-class:: classref-enumeration-constant
  556. :ref:`JustificationFlag<enum_TextServer_JustificationFlag>` **JUSTIFICATION_DO_NOT_SKIP_SINGLE_LINE** = ``128``
  557. 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).
  558. .. rst-class:: classref-item-separator
  559. ----
  560. .. _enum_TextServer_AutowrapMode:
  561. .. rst-class:: classref-enumeration
  562. enum **AutowrapMode**:
  563. .. _class_TextServer_constant_AUTOWRAP_OFF:
  564. .. rst-class:: classref-enumeration-constant
  565. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_OFF** = ``0``
  566. Autowrap is disabled.
  567. .. _class_TextServer_constant_AUTOWRAP_ARBITRARY:
  568. .. rst-class:: classref-enumeration-constant
  569. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_ARBITRARY** = ``1``
  570. 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.
  571. .. _class_TextServer_constant_AUTOWRAP_WORD:
  572. .. rst-class:: classref-enumeration-constant
  573. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD** = ``2``
  574. Wraps the text inside the node's bounding rectangle by soft-breaking between words.
  575. .. _class_TextServer_constant_AUTOWRAP_WORD_SMART:
  576. .. rst-class:: classref-enumeration-constant
  577. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **AUTOWRAP_WORD_SMART** = ``3``
  578. 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.
  579. .. rst-class:: classref-item-separator
  580. ----
  581. .. _enum_TextServer_LineBreakFlag:
  582. .. rst-class:: classref-enumeration
  583. flags **LineBreakFlag**:
  584. .. _class_TextServer_constant_BREAK_NONE:
  585. .. rst-class:: classref-enumeration-constant
  586. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_NONE** = ``0``
  587. Do not break the line.
  588. .. _class_TextServer_constant_BREAK_MANDATORY:
  589. .. rst-class:: classref-enumeration-constant
  590. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_MANDATORY** = ``1``
  591. Break the line at the line mandatory break characters (e.g. ``"\n"``).
  592. .. _class_TextServer_constant_BREAK_WORD_BOUND:
  593. .. rst-class:: classref-enumeration-constant
  594. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_WORD_BOUND** = ``2``
  595. Break the line between the words.
  596. .. _class_TextServer_constant_BREAK_GRAPHEME_BOUND:
  597. .. rst-class:: classref-enumeration-constant
  598. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_GRAPHEME_BOUND** = ``4``
  599. Break the line between any unconnected graphemes.
  600. .. _class_TextServer_constant_BREAK_ADAPTIVE:
  601. .. rst-class:: classref-enumeration-constant
  602. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_ADAPTIVE** = ``8``
  603. 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.
  604. .. _class_TextServer_constant_BREAK_TRIM_EDGE_SPACES:
  605. .. rst-class:: classref-enumeration-constant
  606. :ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>` **BREAK_TRIM_EDGE_SPACES** = ``16``
  607. Remove edge spaces from the broken line segments.
  608. .. rst-class:: classref-item-separator
  609. ----
  610. .. _enum_TextServer_VisibleCharactersBehavior:
  611. .. rst-class:: classref-enumeration
  612. enum **VisibleCharactersBehavior**:
  613. .. _class_TextServer_constant_VC_CHARS_BEFORE_SHAPING:
  614. .. rst-class:: classref-enumeration-constant
  615. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_BEFORE_SHAPING** = ``0``
  616. 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.
  617. .. _class_TextServer_constant_VC_CHARS_AFTER_SHAPING:
  618. .. rst-class:: classref-enumeration-constant
  619. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_CHARS_AFTER_SHAPING** = ``1``
  620. 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.
  621. .. _class_TextServer_constant_VC_GLYPHS_AUTO:
  622. .. rst-class:: classref-enumeration-constant
  623. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_AUTO** = ``2``
  624. 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.
  625. .. _class_TextServer_constant_VC_GLYPHS_LTR:
  626. .. rst-class:: classref-enumeration-constant
  627. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_LTR** = ``3``
  628. 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.
  629. .. _class_TextServer_constant_VC_GLYPHS_RTL:
  630. .. rst-class:: classref-enumeration-constant
  631. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **VC_GLYPHS_RTL** = ``4``
  632. 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.
  633. .. rst-class:: classref-item-separator
  634. ----
  635. .. _enum_TextServer_OverrunBehavior:
  636. .. rst-class:: classref-enumeration
  637. enum **OverrunBehavior**:
  638. .. _class_TextServer_constant_OVERRUN_NO_TRIMMING:
  639. .. rst-class:: classref-enumeration-constant
  640. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_NO_TRIMMING** = ``0``
  641. No text trimming is performed.
  642. .. _class_TextServer_constant_OVERRUN_TRIM_CHAR:
  643. .. rst-class:: classref-enumeration-constant
  644. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_CHAR** = ``1``
  645. Trims the text per character.
  646. .. _class_TextServer_constant_OVERRUN_TRIM_WORD:
  647. .. rst-class:: classref-enumeration-constant
  648. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD** = ``2``
  649. Trims the text per word.
  650. .. _class_TextServer_constant_OVERRUN_TRIM_ELLIPSIS:
  651. .. rst-class:: classref-enumeration-constant
  652. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_ELLIPSIS** = ``3``
  653. Trims the text per character and adds an ellipsis to indicate that parts are hidden.
  654. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ELLIPSIS:
  655. .. rst-class:: classref-enumeration-constant
  656. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **OVERRUN_TRIM_WORD_ELLIPSIS** = ``4``
  657. Trims the text per word and adds an ellipsis to indicate that parts are hidden.
  658. .. rst-class:: classref-item-separator
  659. ----
  660. .. _enum_TextServer_TextOverrunFlag:
  661. .. rst-class:: classref-enumeration
  662. flags **TextOverrunFlag**:
  663. .. _class_TextServer_constant_OVERRUN_NO_TRIM:
  664. .. rst-class:: classref-enumeration-constant
  665. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_NO_TRIM** = ``0``
  666. No trimming is performed.
  667. .. _class_TextServer_constant_OVERRUN_TRIM:
  668. .. rst-class:: classref-enumeration-constant
  669. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM** = ``1``
  670. Trims the text when it exceeds the given width.
  671. .. _class_TextServer_constant_OVERRUN_TRIM_WORD_ONLY:
  672. .. rst-class:: classref-enumeration-constant
  673. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_TRIM_WORD_ONLY** = ``2``
  674. Trims the text per word instead of per grapheme.
  675. .. _class_TextServer_constant_OVERRUN_ADD_ELLIPSIS:
  676. .. rst-class:: classref-enumeration-constant
  677. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ADD_ELLIPSIS** = ``4``
  678. Determines whether an ellipsis should be added at the end of the text.
  679. .. _class_TextServer_constant_OVERRUN_ENFORCE_ELLIPSIS:
  680. .. rst-class:: classref-enumeration-constant
  681. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_ENFORCE_ELLIPSIS** = ``8``
  682. Determines whether the ellipsis at the end of the text is enforced and may not be hidden.
  683. .. _class_TextServer_constant_OVERRUN_JUSTIFICATION_AWARE:
  684. .. rst-class:: classref-enumeration-constant
  685. :ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>` **OVERRUN_JUSTIFICATION_AWARE** = ``16``
  686. .. rst-class:: classref-item-separator
  687. ----
  688. .. _enum_TextServer_GraphemeFlag:
  689. .. rst-class:: classref-enumeration
  690. flags **GraphemeFlag**:
  691. .. _class_TextServer_constant_GRAPHEME_IS_VALID:
  692. .. rst-class:: classref-enumeration-constant
  693. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VALID** = ``1``
  694. Grapheme is supported by the font, and can be drawn.
  695. .. _class_TextServer_constant_GRAPHEME_IS_RTL:
  696. .. rst-class:: classref-enumeration-constant
  697. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_RTL** = ``2``
  698. Grapheme is part of right-to-left or bottom-to-top run.
  699. .. _class_TextServer_constant_GRAPHEME_IS_VIRTUAL:
  700. .. rst-class:: classref-enumeration-constant
  701. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_VIRTUAL** = ``4``
  702. Grapheme is not part of source text, it was added by justification process.
  703. .. _class_TextServer_constant_GRAPHEME_IS_SPACE:
  704. .. rst-class:: classref-enumeration-constant
  705. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SPACE** = ``8``
  706. Grapheme is whitespace.
  707. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_HARD:
  708. .. rst-class:: classref-enumeration-constant
  709. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_HARD** = ``16``
  710. Grapheme is mandatory break point (e.g. ``"\n"``).
  711. .. _class_TextServer_constant_GRAPHEME_IS_BREAK_SOFT:
  712. .. rst-class:: classref-enumeration-constant
  713. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_BREAK_SOFT** = ``32``
  714. Grapheme is optional break point (e.g. space).
  715. .. _class_TextServer_constant_GRAPHEME_IS_TAB:
  716. .. rst-class:: classref-enumeration-constant
  717. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_TAB** = ``64``
  718. Grapheme is the tabulation character.
  719. .. _class_TextServer_constant_GRAPHEME_IS_ELONGATION:
  720. .. rst-class:: classref-enumeration-constant
  721. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_ELONGATION** = ``128``
  722. Grapheme is kashida.
  723. .. _class_TextServer_constant_GRAPHEME_IS_PUNCTUATION:
  724. .. rst-class:: classref-enumeration-constant
  725. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_PUNCTUATION** = ``256``
  726. Grapheme is punctuation character.
  727. .. _class_TextServer_constant_GRAPHEME_IS_UNDERSCORE:
  728. .. rst-class:: classref-enumeration-constant
  729. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_UNDERSCORE** = ``512``
  730. Grapheme is underscore character.
  731. .. _class_TextServer_constant_GRAPHEME_IS_CONNECTED:
  732. .. rst-class:: classref-enumeration-constant
  733. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_CONNECTED** = ``1024``
  734. Grapheme is connected to the previous grapheme. Breaking line before this grapheme is not safe.
  735. .. _class_TextServer_constant_GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL:
  736. .. rst-class:: classref-enumeration-constant
  737. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_SAFE_TO_INSERT_TATWEEL** = ``2048``
  738. It is safe to insert a U+0640 before this grapheme for elongation.
  739. .. _class_TextServer_constant_GRAPHEME_IS_EMBEDDED_OBJECT:
  740. .. rst-class:: classref-enumeration-constant
  741. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` **GRAPHEME_IS_EMBEDDED_OBJECT** = ``4096``
  742. Grapheme is an object replacement character for the embedded object.
  743. .. rst-class:: classref-item-separator
  744. ----
  745. .. _enum_TextServer_Hinting:
  746. .. rst-class:: classref-enumeration
  747. enum **Hinting**:
  748. .. _class_TextServer_constant_HINTING_NONE:
  749. .. rst-class:: classref-enumeration-constant
  750. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NONE** = ``0``
  751. Disables font hinting (smoother but less crisp).
  752. .. _class_TextServer_constant_HINTING_LIGHT:
  753. .. rst-class:: classref-enumeration-constant
  754. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_LIGHT** = ``1``
  755. Use the light font hinting mode.
  756. .. _class_TextServer_constant_HINTING_NORMAL:
  757. .. rst-class:: classref-enumeration-constant
  758. :ref:`Hinting<enum_TextServer_Hinting>` **HINTING_NORMAL** = ``2``
  759. Use the default font hinting mode (crisper but less smooth).
  760. \ **Note:** This hinting mode changes both horizontal and vertical glyph metrics. If applied to monospace font, some glyphs might have different width.
  761. .. rst-class:: classref-item-separator
  762. ----
  763. .. _enum_TextServer_SubpixelPositioning:
  764. .. rst-class:: classref-enumeration
  765. enum **SubpixelPositioning**:
  766. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_DISABLED:
  767. .. rst-class:: classref-enumeration-constant
  768. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_DISABLED** = ``0``
  769. Glyph horizontal position is rounded to the whole pixel size, each glyph is rasterized once.
  770. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_AUTO:
  771. .. rst-class:: classref-enumeration-constant
  772. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_AUTO** = ``1``
  773. Glyph horizontal position is rounded based on font size.
  774. - 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>`.
  775. - 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>`.
  776. - To the whole pixel size for larger fonts.
  777. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF:
  778. .. rst-class:: classref-enumeration-constant
  779. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF** = ``2``
  780. Glyph horizontal position is rounded to one half of the pixel size, each glyph is rasterized up to two times.
  781. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER:
  782. .. rst-class:: classref-enumeration-constant
  783. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER** = ``3``
  784. Glyph horizontal position is rounded to one quarter of the pixel size, each glyph is rasterized up to four times.
  785. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE:
  786. .. rst-class:: classref-enumeration-constant
  787. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_HALF_MAX_SIZE** = ``20``
  788. 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.
  789. .. _class_TextServer_constant_SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE:
  790. .. rst-class:: classref-enumeration-constant
  791. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **SUBPIXEL_POSITIONING_ONE_QUARTER_MAX_SIZE** = ``16``
  792. 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.
  793. .. rst-class:: classref-item-separator
  794. ----
  795. .. _enum_TextServer_Feature:
  796. .. rst-class:: classref-enumeration
  797. enum **Feature**:
  798. .. _class_TextServer_constant_FEATURE_SIMPLE_LAYOUT:
  799. .. rst-class:: classref-enumeration-constant
  800. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SIMPLE_LAYOUT** = ``1``
  801. TextServer supports simple text layouts.
  802. .. _class_TextServer_constant_FEATURE_BIDI_LAYOUT:
  803. .. rst-class:: classref-enumeration-constant
  804. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BIDI_LAYOUT** = ``2``
  805. TextServer supports bidirectional text layouts.
  806. .. _class_TextServer_constant_FEATURE_VERTICAL_LAYOUT:
  807. .. rst-class:: classref-enumeration-constant
  808. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_VERTICAL_LAYOUT** = ``4``
  809. TextServer supports vertical layouts.
  810. .. _class_TextServer_constant_FEATURE_SHAPING:
  811. .. rst-class:: classref-enumeration-constant
  812. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_SHAPING** = ``8``
  813. TextServer supports complex text shaping.
  814. .. _class_TextServer_constant_FEATURE_KASHIDA_JUSTIFICATION:
  815. .. rst-class:: classref-enumeration-constant
  816. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_KASHIDA_JUSTIFICATION** = ``16``
  817. TextServer supports justification using kashidas.
  818. .. _class_TextServer_constant_FEATURE_BREAK_ITERATORS:
  819. .. rst-class:: classref-enumeration-constant
  820. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_BREAK_ITERATORS** = ``32``
  821. TextServer supports complex line/word breaking rules (e.g. dictionary based).
  822. .. _class_TextServer_constant_FEATURE_FONT_BITMAP:
  823. .. rst-class:: classref-enumeration-constant
  824. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_BITMAP** = ``64``
  825. TextServer supports loading bitmap fonts.
  826. .. _class_TextServer_constant_FEATURE_FONT_DYNAMIC:
  827. .. rst-class:: classref-enumeration-constant
  828. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_DYNAMIC** = ``128``
  829. TextServer supports loading dynamic (TrueType, OpeType, etc.) fonts.
  830. .. _class_TextServer_constant_FEATURE_FONT_MSDF:
  831. .. rst-class:: classref-enumeration-constant
  832. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_MSDF** = ``256``
  833. TextServer supports multichannel signed distance field dynamic font rendering.
  834. .. _class_TextServer_constant_FEATURE_FONT_SYSTEM:
  835. .. rst-class:: classref-enumeration-constant
  836. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_SYSTEM** = ``512``
  837. TextServer supports loading system fonts.
  838. .. _class_TextServer_constant_FEATURE_FONT_VARIABLE:
  839. .. rst-class:: classref-enumeration-constant
  840. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_FONT_VARIABLE** = ``1024``
  841. TextServer supports variable fonts.
  842. .. _class_TextServer_constant_FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION:
  843. .. rst-class:: classref-enumeration-constant
  844. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_CONTEXT_SENSITIVE_CASE_CONVERSION** = ``2048``
  845. TextServer supports locale dependent and context sensitive case conversion.
  846. .. _class_TextServer_constant_FEATURE_USE_SUPPORT_DATA:
  847. .. rst-class:: classref-enumeration-constant
  848. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_USE_SUPPORT_DATA** = ``4096``
  849. TextServer require external data file for some features, see :ref:`load_support_data<class_TextServer_method_load_support_data>`.
  850. .. _class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS:
  851. .. rst-class:: classref-enumeration-constant
  852. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_IDENTIFIERS** = ``8192``
  853. TextServer supports UAX #31 identifier validation, see :ref:`is_valid_identifier<class_TextServer_method_is_valid_identifier>`.
  854. .. _class_TextServer_constant_FEATURE_UNICODE_SECURITY:
  855. .. rst-class:: classref-enumeration-constant
  856. :ref:`Feature<enum_TextServer_Feature>` **FEATURE_UNICODE_SECURITY** = ``16384``
  857. 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.
  858. .. rst-class:: classref-item-separator
  859. ----
  860. .. _enum_TextServer_ContourPointTag:
  861. .. rst-class:: classref-enumeration
  862. enum **ContourPointTag**:
  863. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_ON:
  864. .. rst-class:: classref-enumeration-constant
  865. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_ON** = ``1``
  866. Contour point is on the curve.
  867. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CONIC:
  868. .. rst-class:: classref-enumeration-constant
  869. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CONIC** = ``0``
  870. Contour point isn't on the curve, but serves as a control point for a conic (quadratic) Bézier arc.
  871. .. _class_TextServer_constant_CONTOUR_CURVE_TAG_OFF_CUBIC:
  872. .. rst-class:: classref-enumeration-constant
  873. :ref:`ContourPointTag<enum_TextServer_ContourPointTag>` **CONTOUR_CURVE_TAG_OFF_CUBIC** = ``2``
  874. Contour point isn't on the curve, but serves as a control point for a cubic Bézier arc.
  875. .. rst-class:: classref-item-separator
  876. ----
  877. .. _enum_TextServer_SpacingType:
  878. .. rst-class:: classref-enumeration
  879. enum **SpacingType**:
  880. .. _class_TextServer_constant_SPACING_GLYPH:
  881. .. rst-class:: classref-enumeration-constant
  882. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_GLYPH** = ``0``
  883. Spacing for each glyph.
  884. .. _class_TextServer_constant_SPACING_SPACE:
  885. .. rst-class:: classref-enumeration-constant
  886. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_SPACE** = ``1``
  887. Spacing for the space character.
  888. .. _class_TextServer_constant_SPACING_TOP:
  889. .. rst-class:: classref-enumeration-constant
  890. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_TOP** = ``2``
  891. Spacing at the top of the line.
  892. .. _class_TextServer_constant_SPACING_BOTTOM:
  893. .. rst-class:: classref-enumeration-constant
  894. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_BOTTOM** = ``3``
  895. Spacing at the bottom of the line.
  896. .. _class_TextServer_constant_SPACING_MAX:
  897. .. rst-class:: classref-enumeration-constant
  898. :ref:`SpacingType<enum_TextServer_SpacingType>` **SPACING_MAX** = ``4``
  899. .. rst-class:: classref-item-separator
  900. ----
  901. .. _enum_TextServer_FontStyle:
  902. .. rst-class:: classref-enumeration
  903. flags **FontStyle**:
  904. .. _class_TextServer_constant_FONT_BOLD:
  905. .. rst-class:: classref-enumeration-constant
  906. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_BOLD** = ``1``
  907. Font is bold.
  908. .. _class_TextServer_constant_FONT_ITALIC:
  909. .. rst-class:: classref-enumeration-constant
  910. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_ITALIC** = ``2``
  911. Font is italic or oblique.
  912. .. _class_TextServer_constant_FONT_FIXED_WIDTH:
  913. .. rst-class:: classref-enumeration-constant
  914. :ref:`FontStyle<enum_TextServer_FontStyle>` **FONT_FIXED_WIDTH** = ``4``
  915. Font have fixed-width characters.
  916. .. rst-class:: classref-item-separator
  917. ----
  918. .. _enum_TextServer_StructuredTextParser:
  919. .. rst-class:: classref-enumeration
  920. enum **StructuredTextParser**:
  921. .. _class_TextServer_constant_STRUCTURED_TEXT_DEFAULT:
  922. .. rst-class:: classref-enumeration-constant
  923. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_DEFAULT** = ``0``
  924. Use default Unicode BiDi algorithm.
  925. .. _class_TextServer_constant_STRUCTURED_TEXT_URI:
  926. .. rst-class:: classref-enumeration-constant
  927. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_URI** = ``1``
  928. BiDi override for URI.
  929. .. _class_TextServer_constant_STRUCTURED_TEXT_FILE:
  930. .. rst-class:: classref-enumeration-constant
  931. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_FILE** = ``2``
  932. BiDi override for file path.
  933. .. _class_TextServer_constant_STRUCTURED_TEXT_EMAIL:
  934. .. rst-class:: classref-enumeration-constant
  935. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_EMAIL** = ``3``
  936. BiDi override for email.
  937. .. _class_TextServer_constant_STRUCTURED_TEXT_LIST:
  938. .. rst-class:: classref-enumeration-constant
  939. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_LIST** = ``4``
  940. BiDi override for lists. Structured text options: list separator :ref:`String<class_String>`.
  941. .. _class_TextServer_constant_STRUCTURED_TEXT_GDSCRIPT:
  942. .. rst-class:: classref-enumeration-constant
  943. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_GDSCRIPT** = ``5``
  944. BiDi override for GDScript.
  945. .. _class_TextServer_constant_STRUCTURED_TEXT_CUSTOM:
  946. .. rst-class:: classref-enumeration-constant
  947. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **STRUCTURED_TEXT_CUSTOM** = ``6``
  948. User defined structured text BiDi override function.
  949. .. rst-class:: classref-item-separator
  950. ----
  951. .. _enum_TextServer_FixedSizeScaleMode:
  952. .. rst-class:: classref-enumeration
  953. enum **FixedSizeScaleMode**:
  954. .. _class_TextServer_constant_FIXED_SIZE_SCALE_DISABLE:
  955. .. rst-class:: classref-enumeration-constant
  956. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_DISABLE** = ``0``
  957. Bitmap font is not scaled.
  958. .. _class_TextServer_constant_FIXED_SIZE_SCALE_INTEGER_ONLY:
  959. .. rst-class:: classref-enumeration-constant
  960. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_INTEGER_ONLY** = ``1``
  961. Bitmap font is scaled to the closest integer multiple of the font's fixed size. This is the recommended option for pixel art fonts.
  962. .. _class_TextServer_constant_FIXED_SIZE_SCALE_ENABLED:
  963. .. rst-class:: classref-enumeration-constant
  964. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **FIXED_SIZE_SCALE_ENABLED** = ``2``
  965. Bitmap font is scaled to an arbitrary (fractional) size. This is the recommended option for non-pixel art fonts.
  966. .. rst-class:: classref-section-separator
  967. ----
  968. .. rst-class:: classref-descriptions-group
  969. Method Descriptions
  970. -------------------
  971. .. _class_TextServer_method_create_font:
  972. .. rst-class:: classref-method
  973. :ref:`RID<class_RID>` **create_font** **(** **)**
  974. Creates a new, empty font cache entry resource. To free the resulting resource, use the :ref:`free_rid<class_TextServer_method_free_rid>` method.
  975. .. rst-class:: classref-item-separator
  976. ----
  977. .. _class_TextServer_method_create_font_linked_variation:
  978. .. rst-class:: classref-method
  979. :ref:`RID<class_RID>` **create_font_linked_variation** **(** :ref:`RID<class_RID>` font_rid **)**
  980. 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.
  981. .. rst-class:: classref-item-separator
  982. ----
  983. .. _class_TextServer_method_create_shaped_text:
  984. .. rst-class:: classref-method
  985. :ref:`RID<class_RID>` **create_shaped_text** **(** :ref:`Direction<enum_TextServer_Direction>` direction=0, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  986. Creates 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.
  987. \ **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>`).
  988. \ **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>`).
  989. .. rst-class:: classref-item-separator
  990. ----
  991. .. _class_TextServer_method_draw_hex_code_box:
  992. .. rst-class:: classref-method
  993. void **draw_hex_code_box** **(** :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color **)** |const|
  994. Draws box displaying character hexadecimal code. Used for replacing missing characters.
  995. .. rst-class:: classref-item-separator
  996. ----
  997. .. _class_TextServer_method_font_clear_glyphs:
  998. .. rst-class:: classref-method
  999. void **font_clear_glyphs** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1000. Removes all rendered glyphs information from the cache entry.
  1001. \ **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.
  1002. .. rst-class:: classref-item-separator
  1003. ----
  1004. .. _class_TextServer_method_font_clear_kerning_map:
  1005. .. rst-class:: classref-method
  1006. void **font_clear_kerning_map** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)**
  1007. Removes all kerning overrides.
  1008. .. rst-class:: classref-item-separator
  1009. ----
  1010. .. _class_TextServer_method_font_clear_size_cache:
  1011. .. rst-class:: classref-method
  1012. void **font_clear_size_cache** **(** :ref:`RID<class_RID>` font_rid **)**
  1013. Removes all font sizes from the cache entry.
  1014. .. rst-class:: classref-item-separator
  1015. ----
  1016. .. _class_TextServer_method_font_clear_textures:
  1017. .. rst-class:: classref-method
  1018. void **font_clear_textures** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1019. Removes all textures from font cache entry.
  1020. \ **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.
  1021. .. rst-class:: classref-item-separator
  1022. ----
  1023. .. _class_TextServer_method_font_draw_glyph:
  1024. .. rst-class:: classref-method
  1025. void **font_draw_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const|
  1026. Draws single glyph into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1027. \ **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>`.
  1028. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1029. .. rst-class:: classref-item-separator
  1030. ----
  1031. .. _class_TextServer_method_font_draw_glyph_outline:
  1032. .. rst-class:: classref-method
  1033. void **font_draw_glyph_outline** **(** :ref:`RID<class_RID>` font_rid, :ref:`RID<class_RID>` canvas, :ref:`int<class_int>` size, :ref:`int<class_int>` outline_size, :ref:`Vector2<class_Vector2>` pos, :ref:`int<class_int>` index, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const|
  1034. Draws single glyph outline of size ``outline_size`` into a canvas item at the position, using ``font_rid`` at the size ``size``.
  1035. \ **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>`.
  1036. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1037. .. rst-class:: classref-item-separator
  1038. ----
  1039. .. _class_TextServer_method_font_get_antialiasing:
  1040. .. rst-class:: classref-method
  1041. :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` **font_get_antialiasing** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1042. Returns font anti-aliasing mode.
  1043. .. rst-class:: classref-item-separator
  1044. ----
  1045. .. _class_TextServer_method_font_get_ascent:
  1046. .. rst-class:: classref-method
  1047. :ref:`float<class_float>` **font_get_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1048. Returns the font ascent (number of pixels above the baseline).
  1049. .. rst-class:: classref-item-separator
  1050. ----
  1051. .. _class_TextServer_method_font_get_char_from_glyph_index:
  1052. .. rst-class:: classref-method
  1053. :ref:`int<class_int>` **font_get_char_from_glyph_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph_index **)** |const|
  1054. 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>`.
  1055. .. rst-class:: classref-item-separator
  1056. ----
  1057. .. _class_TextServer_method_font_get_descent:
  1058. .. rst-class:: classref-method
  1059. :ref:`float<class_float>` **font_get_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1060. Returns the font descent (number of pixels below the baseline).
  1061. .. rst-class:: classref-item-separator
  1062. ----
  1063. .. _class_TextServer_method_font_get_embolden:
  1064. .. rst-class:: classref-method
  1065. :ref:`float<class_float>` **font_get_embolden** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1066. Returns font embolden strength.
  1067. .. rst-class:: classref-item-separator
  1068. ----
  1069. .. _class_TextServer_method_font_get_face_count:
  1070. .. rst-class:: classref-method
  1071. :ref:`int<class_int>` **font_get_face_count** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1072. Returns number of faces in the TrueType / OpenType collection.
  1073. .. rst-class:: classref-item-separator
  1074. ----
  1075. .. _class_TextServer_method_font_get_face_index:
  1076. .. rst-class:: classref-method
  1077. :ref:`int<class_int>` **font_get_face_index** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1078. Returns an active face index in the TrueType / OpenType collection.
  1079. .. rst-class:: classref-item-separator
  1080. ----
  1081. .. _class_TextServer_method_font_get_fixed_size:
  1082. .. rst-class:: classref-method
  1083. :ref:`int<class_int>` **font_get_fixed_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1084. Returns bitmap font fixed size.
  1085. .. rst-class:: classref-item-separator
  1086. ----
  1087. .. _class_TextServer_method_font_get_fixed_size_scale_mode:
  1088. .. rst-class:: classref-method
  1089. :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` **font_get_fixed_size_scale_mode** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1090. Returns bitmap font scaling mode.
  1091. .. rst-class:: classref-item-separator
  1092. ----
  1093. .. _class_TextServer_method_font_get_generate_mipmaps:
  1094. .. rst-class:: classref-method
  1095. :ref:`bool<class_bool>` **font_get_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1096. Returns ``true`` if font texture mipmap generation is enabled.
  1097. .. rst-class:: classref-item-separator
  1098. ----
  1099. .. _class_TextServer_method_font_get_global_oversampling:
  1100. .. rst-class:: classref-method
  1101. :ref:`float<class_float>` **font_get_global_oversampling** **(** **)** |const|
  1102. Returns the font oversampling factor, shared by all fonts in the TextServer.
  1103. .. rst-class:: classref-item-separator
  1104. ----
  1105. .. _class_TextServer_method_font_get_glyph_advance:
  1106. .. rst-class:: classref-method
  1107. :ref:`Vector2<class_Vector2>` **font_get_glyph_advance** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph **)** |const|
  1108. Returns glyph advance (offset of the next glyph).
  1109. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1110. .. rst-class:: classref-item-separator
  1111. ----
  1112. .. _class_TextServer_method_font_get_glyph_contours:
  1113. .. rst-class:: classref-method
  1114. :ref:`Dictionary<class_Dictionary>` **font_get_glyph_contours** **(** :ref:`RID<class_RID>` font, :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1115. Returns outline contours of the glyph as a :ref:`Dictionary<class_Dictionary>` with the following contents:
  1116. \ ``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.
  1117. \ ``contours`` - :ref:`PackedInt32Array<class_PackedInt32Array>`, containing indices the end points of each contour.
  1118. \ ``orientation`` - :ref:`bool<class_bool>`, contour orientation. If ``true``, clockwise contours must be filled.
  1119. .. rst-class:: classref-item-separator
  1120. ----
  1121. .. _class_TextServer_method_font_get_glyph_index:
  1122. .. rst-class:: classref-method
  1123. :ref:`int<class_int>` **font_get_glyph_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` char, :ref:`int<class_int>` variation_selector **)** |const|
  1124. 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>`.
  1125. .. rst-class:: classref-item-separator
  1126. ----
  1127. .. _class_TextServer_method_font_get_glyph_list:
  1128. .. rst-class:: classref-method
  1129. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_glyph_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1130. Returns list of rendered glyphs in the cache entry.
  1131. .. rst-class:: classref-item-separator
  1132. ----
  1133. .. _class_TextServer_method_font_get_glyph_offset:
  1134. .. rst-class:: classref-method
  1135. :ref:`Vector2<class_Vector2>` **font_get_glyph_offset** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1136. Returns glyph offset from the baseline.
  1137. .. rst-class:: classref-item-separator
  1138. ----
  1139. .. _class_TextServer_method_font_get_glyph_size:
  1140. .. rst-class:: classref-method
  1141. :ref:`Vector2<class_Vector2>` **font_get_glyph_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1142. Returns size of the glyph.
  1143. .. rst-class:: classref-item-separator
  1144. ----
  1145. .. _class_TextServer_method_font_get_glyph_texture_idx:
  1146. .. rst-class:: classref-method
  1147. :ref:`int<class_int>` **font_get_glyph_texture_idx** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1148. Returns index of the cache texture containing the glyph.
  1149. .. rst-class:: classref-item-separator
  1150. ----
  1151. .. _class_TextServer_method_font_get_glyph_texture_rid:
  1152. .. rst-class:: classref-method
  1153. :ref:`RID<class_RID>` **font_get_glyph_texture_rid** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1154. Returns resource ID of the cache texture containing the glyph.
  1155. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1156. .. rst-class:: classref-item-separator
  1157. ----
  1158. .. _class_TextServer_method_font_get_glyph_texture_size:
  1159. .. rst-class:: classref-method
  1160. :ref:`Vector2<class_Vector2>` **font_get_glyph_texture_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1161. Returns size of the cache texture containing the glyph.
  1162. \ **Note:** If there are pending glyphs to render, calling this function might trigger the texture cache update.
  1163. .. rst-class:: classref-item-separator
  1164. ----
  1165. .. _class_TextServer_method_font_get_glyph_uv_rect:
  1166. .. rst-class:: classref-method
  1167. :ref:`Rect2<class_Rect2>` **font_get_glyph_uv_rect** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)** |const|
  1168. Returns rectangle in the cache texture containing the glyph.
  1169. .. rst-class:: classref-item-separator
  1170. ----
  1171. .. _class_TextServer_method_font_get_hinting:
  1172. .. rst-class:: classref-method
  1173. :ref:`Hinting<enum_TextServer_Hinting>` **font_get_hinting** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1174. Returns the font hinting mode. Used by dynamic fonts only.
  1175. .. rst-class:: classref-item-separator
  1176. ----
  1177. .. _class_TextServer_method_font_get_kerning:
  1178. .. rst-class:: classref-method
  1179. :ref:`Vector2<class_Vector2>` **font_get_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)** |const|
  1180. Returns kerning for the pair of glyphs.
  1181. .. rst-class:: classref-item-separator
  1182. ----
  1183. .. _class_TextServer_method_font_get_kerning_list:
  1184. .. rst-class:: classref-method
  1185. :ref:`Vector2i[]<class_Vector2i>` **font_get_kerning_list** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1186. Returns list of the kerning overrides.
  1187. .. rst-class:: classref-item-separator
  1188. ----
  1189. .. _class_TextServer_method_font_get_language_support_override:
  1190. .. rst-class:: classref-method
  1191. :ref:`bool<class_bool>` **font_get_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1192. Returns ``true`` if support override is enabled for the ``language``.
  1193. .. rst-class:: classref-item-separator
  1194. ----
  1195. .. _class_TextServer_method_font_get_language_support_overrides:
  1196. .. rst-class:: classref-method
  1197. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_language_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1198. Returns list of language support overrides.
  1199. .. rst-class:: classref-item-separator
  1200. ----
  1201. .. _class_TextServer_method_font_get_msdf_pixel_range:
  1202. .. rst-class:: classref-method
  1203. :ref:`int<class_int>` **font_get_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1204. Returns the width of the range around the shape between the minimum and maximum representable signed distance.
  1205. .. rst-class:: classref-item-separator
  1206. ----
  1207. .. _class_TextServer_method_font_get_msdf_size:
  1208. .. rst-class:: classref-method
  1209. :ref:`int<class_int>` **font_get_msdf_size** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1210. Returns source font size used to generate MSDF textures.
  1211. .. rst-class:: classref-item-separator
  1212. ----
  1213. .. _class_TextServer_method_font_get_name:
  1214. .. rst-class:: classref-method
  1215. :ref:`String<class_String>` **font_get_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1216. Returns font family name.
  1217. .. rst-class:: classref-item-separator
  1218. ----
  1219. .. _class_TextServer_method_font_get_opentype_feature_overrides:
  1220. .. rst-class:: classref-method
  1221. :ref:`Dictionary<class_Dictionary>` **font_get_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1222. Returns font OpenType feature set override.
  1223. .. rst-class:: classref-item-separator
  1224. ----
  1225. .. _class_TextServer_method_font_get_ot_name_strings:
  1226. .. rst-class:: classref-method
  1227. :ref:`Dictionary<class_Dictionary>` **font_get_ot_name_strings** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1228. Returns :ref:`Dictionary<class_Dictionary>` with OpenType font name strings (localized font names, version, description, license information, sample text, etc.).
  1229. .. rst-class:: classref-item-separator
  1230. ----
  1231. .. _class_TextServer_method_font_get_oversampling:
  1232. .. rst-class:: classref-method
  1233. :ref:`float<class_float>` **font_get_oversampling** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1234. Returns font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1235. .. rst-class:: classref-item-separator
  1236. ----
  1237. .. _class_TextServer_method_font_get_scale:
  1238. .. rst-class:: classref-method
  1239. :ref:`float<class_float>` **font_get_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1240. Returns scaling factor of the color bitmap font.
  1241. .. rst-class:: classref-item-separator
  1242. ----
  1243. .. _class_TextServer_method_font_get_script_support_override:
  1244. .. rst-class:: classref-method
  1245. :ref:`bool<class_bool>` **font_get_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1246. Returns ``true`` if support override is enabled for the ``script``.
  1247. .. rst-class:: classref-item-separator
  1248. ----
  1249. .. _class_TextServer_method_font_get_script_support_overrides:
  1250. .. rst-class:: classref-method
  1251. :ref:`PackedStringArray<class_PackedStringArray>` **font_get_script_support_overrides** **(** :ref:`RID<class_RID>` font_rid **)**
  1252. Returns list of script support overrides.
  1253. .. rst-class:: classref-item-separator
  1254. ----
  1255. .. _class_TextServer_method_font_get_size_cache_list:
  1256. .. rst-class:: classref-method
  1257. :ref:`Vector2i[]<class_Vector2i>` **font_get_size_cache_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1258. Returns list of the font sizes in the cache. Each size is :ref:`Vector2i<class_Vector2i>` with font size and outline size.
  1259. .. rst-class:: classref-item-separator
  1260. ----
  1261. .. _class_TextServer_method_font_get_spacing:
  1262. .. rst-class:: classref-method
  1263. :ref:`int<class_int>` **font_get_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  1264. Returns the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) in pixels (not relative to the font size).
  1265. .. rst-class:: classref-item-separator
  1266. ----
  1267. .. _class_TextServer_method_font_get_stretch:
  1268. .. rst-class:: classref-method
  1269. :ref:`int<class_int>` **font_get_stretch** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1270. Returns font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1271. .. rst-class:: classref-item-separator
  1272. ----
  1273. .. _class_TextServer_method_font_get_style:
  1274. .. rst-class:: classref-method
  1275. |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> **font_get_style** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1276. Returns font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1277. .. rst-class:: classref-item-separator
  1278. ----
  1279. .. _class_TextServer_method_font_get_style_name:
  1280. .. rst-class:: classref-method
  1281. :ref:`String<class_String>` **font_get_style_name** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1282. Returns font style name.
  1283. .. rst-class:: classref-item-separator
  1284. ----
  1285. .. _class_TextServer_method_font_get_subpixel_positioning:
  1286. .. rst-class:: classref-method
  1287. :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` **font_get_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1288. Returns font subpixel glyph positioning mode.
  1289. .. rst-class:: classref-item-separator
  1290. ----
  1291. .. _class_TextServer_method_font_get_supported_chars:
  1292. .. rst-class:: classref-method
  1293. :ref:`String<class_String>` **font_get_supported_chars** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1294. Returns a string containing all the characters available in the font.
  1295. .. rst-class:: classref-item-separator
  1296. ----
  1297. .. _class_TextServer_method_font_get_texture_count:
  1298. .. rst-class:: classref-method
  1299. :ref:`int<class_int>` **font_get_texture_count** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)** |const|
  1300. Returns number of textures used by font cache entry.
  1301. .. rst-class:: classref-item-separator
  1302. ----
  1303. .. _class_TextServer_method_font_get_texture_image:
  1304. .. rst-class:: classref-method
  1305. :ref:`Image<class_Image>` **font_get_texture_image** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const|
  1306. Returns font cache texture image data.
  1307. .. rst-class:: classref-item-separator
  1308. ----
  1309. .. _class_TextServer_method_font_get_texture_offsets:
  1310. .. rst-class:: classref-method
  1311. :ref:`PackedInt32Array<class_PackedInt32Array>` **font_get_texture_offsets** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)** |const|
  1312. Returns array containing glyph packing data.
  1313. .. rst-class:: classref-item-separator
  1314. ----
  1315. .. _class_TextServer_method_font_get_transform:
  1316. .. rst-class:: classref-method
  1317. :ref:`Transform2D<class_Transform2D>` **font_get_transform** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1318. Returns 2D transform applied to the font outlines.
  1319. .. rst-class:: classref-item-separator
  1320. ----
  1321. .. _class_TextServer_method_font_get_underline_position:
  1322. .. rst-class:: classref-method
  1323. :ref:`float<class_float>` **font_get_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1324. Returns pixel offset of the underline below the baseline.
  1325. .. rst-class:: classref-item-separator
  1326. ----
  1327. .. _class_TextServer_method_font_get_underline_thickness:
  1328. .. rst-class:: classref-method
  1329. :ref:`float<class_float>` **font_get_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size **)** |const|
  1330. Returns thickness of the underline in pixels.
  1331. .. rst-class:: classref-item-separator
  1332. ----
  1333. .. _class_TextServer_method_font_get_variation_coordinates:
  1334. .. rst-class:: classref-method
  1335. :ref:`Dictionary<class_Dictionary>` **font_get_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1336. 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.
  1337. .. rst-class:: classref-item-separator
  1338. ----
  1339. .. _class_TextServer_method_font_get_weight:
  1340. .. rst-class:: classref-method
  1341. :ref:`int<class_int>` **font_get_weight** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1342. Returns weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1343. .. rst-class:: classref-item-separator
  1344. ----
  1345. .. _class_TextServer_method_font_has_char:
  1346. .. rst-class:: classref-method
  1347. :ref:`bool<class_bool>` **font_has_char** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` char **)** |const|
  1348. Returns ``true`` if a Unicode ``char`` is available in the font.
  1349. .. rst-class:: classref-item-separator
  1350. ----
  1351. .. _class_TextServer_method_font_is_allow_system_fallback:
  1352. .. rst-class:: classref-method
  1353. :ref:`bool<class_bool>` **font_is_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1354. Returns ``true`` if system fonts can be automatically used as fallbacks.
  1355. .. rst-class:: classref-item-separator
  1356. ----
  1357. .. _class_TextServer_method_font_is_force_autohinter:
  1358. .. rst-class:: classref-method
  1359. :ref:`bool<class_bool>` **font_is_force_autohinter** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1360. Returns ``true`` if auto-hinting is supported and preferred over font built-in hinting. Used by dynamic fonts only.
  1361. .. rst-class:: classref-item-separator
  1362. ----
  1363. .. _class_TextServer_method_font_is_language_supported:
  1364. .. rst-class:: classref-method
  1365. :ref:`bool<class_bool>` **font_is_language_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)** |const|
  1366. Returns ``true``, if font supports given language (`ISO 639 <https://en.wikipedia.org/wiki/ISO_639-1>`__ code).
  1367. .. rst-class:: classref-item-separator
  1368. ----
  1369. .. _class_TextServer_method_font_is_multichannel_signed_distance_field:
  1370. .. rst-class:: classref-method
  1371. :ref:`bool<class_bool>` **font_is_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1372. Returns ``true`` if glyphs of all sizes are rendered using single multichannel signed distance field generated from the dynamic font vector data.
  1373. .. rst-class:: classref-item-separator
  1374. ----
  1375. .. _class_TextServer_method_font_is_script_supported:
  1376. .. rst-class:: classref-method
  1377. :ref:`bool<class_bool>` **font_is_script_supported** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)** |const|
  1378. Returns ``true``, if font supports given script (ISO 15924 code).
  1379. .. rst-class:: classref-item-separator
  1380. ----
  1381. .. _class_TextServer_method_font_remove_glyph:
  1382. .. rst-class:: classref-method
  1383. void **font_remove_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph **)**
  1384. Removes specified rendered glyph information from the cache entry.
  1385. \ **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.
  1386. .. rst-class:: classref-item-separator
  1387. ----
  1388. .. _class_TextServer_method_font_remove_kerning:
  1389. .. rst-class:: classref-method
  1390. void **font_remove_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair **)**
  1391. Removes kerning override for the pair of glyphs.
  1392. .. rst-class:: classref-item-separator
  1393. ----
  1394. .. _class_TextServer_method_font_remove_language_support_override:
  1395. .. rst-class:: classref-method
  1396. void **font_remove_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language **)**
  1397. Remove language support override.
  1398. .. rst-class:: classref-item-separator
  1399. ----
  1400. .. _class_TextServer_method_font_remove_script_support_override:
  1401. .. rst-class:: classref-method
  1402. void **font_remove_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script **)**
  1403. Removes script support override.
  1404. .. rst-class:: classref-item-separator
  1405. ----
  1406. .. _class_TextServer_method_font_remove_size_cache:
  1407. .. rst-class:: classref-method
  1408. void **font_remove_size_cache** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size **)**
  1409. Removes specified font size from the cache entry.
  1410. .. rst-class:: classref-item-separator
  1411. ----
  1412. .. _class_TextServer_method_font_remove_texture:
  1413. .. rst-class:: classref-method
  1414. void **font_remove_texture** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index **)**
  1415. Removes specified texture from the cache entry.
  1416. \ **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>`.
  1417. .. rst-class:: classref-item-separator
  1418. ----
  1419. .. _class_TextServer_method_font_render_glyph:
  1420. .. rst-class:: classref-method
  1421. void **font_render_glyph** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` index **)**
  1422. Renders specified glyph to the font cache texture.
  1423. .. rst-class:: classref-item-separator
  1424. ----
  1425. .. _class_TextServer_method_font_render_range:
  1426. .. rst-class:: classref-method
  1427. void **font_render_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)**
  1428. Renders the range of characters to the font cache texture.
  1429. .. rst-class:: classref-item-separator
  1430. ----
  1431. .. _class_TextServer_method_font_set_allow_system_fallback:
  1432. .. rst-class:: classref-method
  1433. void **font_set_allow_system_fallback** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` allow_system_fallback **)**
  1434. If set to ``true``, system fonts can be automatically used as fallbacks.
  1435. .. rst-class:: classref-item-separator
  1436. ----
  1437. .. _class_TextServer_method_font_set_antialiasing:
  1438. .. rst-class:: classref-method
  1439. void **font_set_antialiasing** **(** :ref:`RID<class_RID>` font_rid, :ref:`FontAntialiasing<enum_TextServer_FontAntialiasing>` antialiasing **)**
  1440. Sets font anti-aliasing mode.
  1441. .. rst-class:: classref-item-separator
  1442. ----
  1443. .. _class_TextServer_method_font_set_ascent:
  1444. .. rst-class:: classref-method
  1445. void **font_set_ascent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` ascent **)**
  1446. Sets the font ascent (number of pixels above the baseline).
  1447. .. rst-class:: classref-item-separator
  1448. ----
  1449. .. _class_TextServer_method_font_set_data:
  1450. .. rst-class:: classref-method
  1451. void **font_set_data** **(** :ref:`RID<class_RID>` font_rid, :ref:`PackedByteArray<class_PackedByteArray>` data **)**
  1452. Sets font source data, e.g contents of the dynamic font source file.
  1453. .. rst-class:: classref-item-separator
  1454. ----
  1455. .. _class_TextServer_method_font_set_descent:
  1456. .. rst-class:: classref-method
  1457. void **font_set_descent** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` descent **)**
  1458. Sets the font descent (number of pixels below the baseline).
  1459. .. rst-class:: classref-item-separator
  1460. ----
  1461. .. _class_TextServer_method_font_set_embolden:
  1462. .. rst-class:: classref-method
  1463. void **font_set_embolden** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` strength **)**
  1464. Sets font embolden strength. If ``strength`` is not equal to zero, emboldens the font outlines. Negative values reduce the outline thickness.
  1465. .. rst-class:: classref-item-separator
  1466. ----
  1467. .. _class_TextServer_method_font_set_face_index:
  1468. .. rst-class:: classref-method
  1469. void **font_set_face_index** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` face_index **)**
  1470. Sets an active face index in the TrueType / OpenType collection.
  1471. .. rst-class:: classref-item-separator
  1472. ----
  1473. .. _class_TextServer_method_font_set_fixed_size:
  1474. .. rst-class:: classref-method
  1475. void **font_set_fixed_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` fixed_size **)**
  1476. Sets bitmap font fixed size. If set to value greater than zero, same cache entry will be used for all font sizes.
  1477. .. rst-class:: classref-item-separator
  1478. ----
  1479. .. _class_TextServer_method_font_set_fixed_size_scale_mode:
  1480. .. rst-class:: classref-method
  1481. void **font_set_fixed_size_scale_mode** **(** :ref:`RID<class_RID>` font_rid, :ref:`FixedSizeScaleMode<enum_TextServer_FixedSizeScaleMode>` fixed_size_scale_mode **)**
  1482. Sets bitmap font scaling mode. This property is used only if ``fixed_size`` is greater than zero.
  1483. .. rst-class:: classref-item-separator
  1484. ----
  1485. .. _class_TextServer_method_font_set_force_autohinter:
  1486. .. rst-class:: classref-method
  1487. void **font_set_force_autohinter** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` force_autohinter **)**
  1488. If set to ``true`` auto-hinting is preferred over font built-in hinting.
  1489. .. rst-class:: classref-item-separator
  1490. ----
  1491. .. _class_TextServer_method_font_set_generate_mipmaps:
  1492. .. rst-class:: classref-method
  1493. void **font_set_generate_mipmaps** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` generate_mipmaps **)**
  1494. If set to ``true`` font texture mipmap generation is enabled.
  1495. .. rst-class:: classref-item-separator
  1496. ----
  1497. .. _class_TextServer_method_font_set_global_oversampling:
  1498. .. rst-class:: classref-method
  1499. void **font_set_global_oversampling** **(** :ref:`float<class_float>` oversampling **)**
  1500. Sets oversampling factor, shared by all font in the TextServer.
  1501. \ **Note:** This value can be automatically changed by display server.
  1502. .. rst-class:: classref-item-separator
  1503. ----
  1504. .. _class_TextServer_method_font_set_glyph_advance:
  1505. .. rst-class:: classref-method
  1506. void **font_set_glyph_advance** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` advance **)**
  1507. Sets glyph advance (offset of the next glyph).
  1508. \ **Note:** Advance for glyphs outlines is the same as the base glyph advance and is not saved.
  1509. .. rst-class:: classref-item-separator
  1510. ----
  1511. .. _class_TextServer_method_font_set_glyph_offset:
  1512. .. rst-class:: classref-method
  1513. void **font_set_glyph_offset** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` offset **)**
  1514. Sets glyph offset from the baseline.
  1515. .. rst-class:: classref-item-separator
  1516. ----
  1517. .. _class_TextServer_method_font_set_glyph_size:
  1518. .. rst-class:: classref-method
  1519. void **font_set_glyph_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Vector2<class_Vector2>` gl_size **)**
  1520. Sets size of the glyph.
  1521. .. rst-class:: classref-item-separator
  1522. ----
  1523. .. _class_TextServer_method_font_set_glyph_texture_idx:
  1524. .. rst-class:: classref-method
  1525. void **font_set_glyph_texture_idx** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`int<class_int>` texture_idx **)**
  1526. Sets index of the cache texture containing the glyph.
  1527. .. rst-class:: classref-item-separator
  1528. ----
  1529. .. _class_TextServer_method_font_set_glyph_uv_rect:
  1530. .. rst-class:: classref-method
  1531. void **font_set_glyph_uv_rect** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` glyph, :ref:`Rect2<class_Rect2>` uv_rect **)**
  1532. Sets rectangle in the cache texture containing the glyph.
  1533. .. rst-class:: classref-item-separator
  1534. ----
  1535. .. _class_TextServer_method_font_set_hinting:
  1536. .. rst-class:: classref-method
  1537. void **font_set_hinting** **(** :ref:`RID<class_RID>` font_rid, :ref:`Hinting<enum_TextServer_Hinting>` hinting **)**
  1538. Sets font hinting mode. Used by dynamic fonts only.
  1539. .. rst-class:: classref-item-separator
  1540. ----
  1541. .. _class_TextServer_method_font_set_kerning:
  1542. .. rst-class:: classref-method
  1543. void **font_set_kerning** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`Vector2i<class_Vector2i>` glyph_pair, :ref:`Vector2<class_Vector2>` kerning **)**
  1544. Sets kerning for the pair of glyphs.
  1545. .. rst-class:: classref-item-separator
  1546. ----
  1547. .. _class_TextServer_method_font_set_language_support_override:
  1548. .. rst-class:: classref-method
  1549. void **font_set_language_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` language, :ref:`bool<class_bool>` supported **)**
  1550. Adds override for :ref:`font_is_language_supported<class_TextServer_method_font_is_language_supported>`.
  1551. .. rst-class:: classref-item-separator
  1552. ----
  1553. .. _class_TextServer_method_font_set_msdf_pixel_range:
  1554. .. rst-class:: classref-method
  1555. void **font_set_msdf_pixel_range** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_pixel_range **)**
  1556. Sets the width of the range around the shape between the minimum and maximum representable signed distance.
  1557. .. rst-class:: classref-item-separator
  1558. ----
  1559. .. _class_TextServer_method_font_set_msdf_size:
  1560. .. rst-class:: classref-method
  1561. void **font_set_msdf_size** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` msdf_size **)**
  1562. Sets source font size used to generate MSDF textures.
  1563. .. rst-class:: classref-item-separator
  1564. ----
  1565. .. _class_TextServer_method_font_set_multichannel_signed_distance_field:
  1566. .. rst-class:: classref-method
  1567. void **font_set_multichannel_signed_distance_field** **(** :ref:`RID<class_RID>` font_rid, :ref:`bool<class_bool>` msdf **)**
  1568. 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.
  1569. \ **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.
  1570. .. rst-class:: classref-item-separator
  1571. ----
  1572. .. _class_TextServer_method_font_set_name:
  1573. .. rst-class:: classref-method
  1574. void **font_set_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1575. Sets the font family name.
  1576. .. rst-class:: classref-item-separator
  1577. ----
  1578. .. _class_TextServer_method_font_set_opentype_feature_overrides:
  1579. .. rst-class:: classref-method
  1580. void **font_set_opentype_feature_overrides** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` overrides **)**
  1581. Sets font OpenType feature set override.
  1582. .. rst-class:: classref-item-separator
  1583. ----
  1584. .. _class_TextServer_method_font_set_oversampling:
  1585. .. rst-class:: classref-method
  1586. void **font_set_oversampling** **(** :ref:`RID<class_RID>` font_rid, :ref:`float<class_float>` oversampling **)**
  1587. Sets font oversampling factor, if set to ``0.0`` global oversampling factor is used instead. Used by dynamic fonts only.
  1588. .. rst-class:: classref-item-separator
  1589. ----
  1590. .. _class_TextServer_method_font_set_scale:
  1591. .. rst-class:: classref-method
  1592. void **font_set_scale** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` scale **)**
  1593. Sets scaling factor of the color bitmap font.
  1594. .. rst-class:: classref-item-separator
  1595. ----
  1596. .. _class_TextServer_method_font_set_script_support_override:
  1597. .. rst-class:: classref-method
  1598. void **font_set_script_support_override** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` script, :ref:`bool<class_bool>` supported **)**
  1599. Adds override for :ref:`font_is_script_supported<class_TextServer_method_font_is_script_supported>`.
  1600. .. rst-class:: classref-item-separator
  1601. ----
  1602. .. _class_TextServer_method_font_set_spacing:
  1603. .. rst-class:: classref-method
  1604. void **font_set_spacing** **(** :ref:`RID<class_RID>` font_rid, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  1605. Sets the spacing for ``spacing`` (see :ref:`SpacingType<enum_TextServer_SpacingType>`) to ``value`` in pixels (not relative to the font size).
  1606. .. rst-class:: classref-item-separator
  1607. ----
  1608. .. _class_TextServer_method_font_set_stretch:
  1609. .. rst-class:: classref-method
  1610. void **font_set_stretch** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1611. Sets font stretch amount, compared to a normal width. A percentage value between ``50%`` and ``200%``.
  1612. \ **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.
  1613. .. rst-class:: classref-item-separator
  1614. ----
  1615. .. _class_TextServer_method_font_set_style:
  1616. .. rst-class:: classref-method
  1617. void **font_set_style** **(** :ref:`RID<class_RID>` font_rid, |bitfield|\<:ref:`FontStyle<enum_TextServer_FontStyle>`\> style **)**
  1618. Sets the font style flags, see :ref:`FontStyle<enum_TextServer_FontStyle>`.
  1619. \ **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.
  1620. .. rst-class:: classref-item-separator
  1621. ----
  1622. .. _class_TextServer_method_font_set_style_name:
  1623. .. rst-class:: classref-method
  1624. void **font_set_style_name** **(** :ref:`RID<class_RID>` font_rid, :ref:`String<class_String>` name **)**
  1625. Sets the font style name.
  1626. .. rst-class:: classref-item-separator
  1627. ----
  1628. .. _class_TextServer_method_font_set_subpixel_positioning:
  1629. .. rst-class:: classref-method
  1630. void **font_set_subpixel_positioning** **(** :ref:`RID<class_RID>` font_rid, :ref:`SubpixelPositioning<enum_TextServer_SubpixelPositioning>` subpixel_positioning **)**
  1631. Sets font subpixel glyph positioning mode.
  1632. .. rst-class:: classref-item-separator
  1633. ----
  1634. .. _class_TextServer_method_font_set_texture_image:
  1635. .. rst-class:: classref-method
  1636. void **font_set_texture_image** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`Image<class_Image>` image **)**
  1637. Sets font cache texture image data.
  1638. .. rst-class:: classref-item-separator
  1639. ----
  1640. .. _class_TextServer_method_font_set_texture_offsets:
  1641. .. rst-class:: classref-method
  1642. void **font_set_texture_offsets** **(** :ref:`RID<class_RID>` font_rid, :ref:`Vector2i<class_Vector2i>` size, :ref:`int<class_int>` texture_index, :ref:`PackedInt32Array<class_PackedInt32Array>` offset **)**
  1643. Sets array containing glyph packing data.
  1644. .. rst-class:: classref-item-separator
  1645. ----
  1646. .. _class_TextServer_method_font_set_transform:
  1647. .. rst-class:: classref-method
  1648. void **font_set_transform** **(** :ref:`RID<class_RID>` font_rid, :ref:`Transform2D<class_Transform2D>` transform **)**
  1649. Sets 2D transform, applied to the font outlines, can be used for slanting, flipping and rotating glyphs.
  1650. For example, to simulate italic typeface by slanting, apply the following transform ``Transform2D(1.0, slant, 0.0, 1.0, 0.0, 0.0)``.
  1651. .. rst-class:: classref-item-separator
  1652. ----
  1653. .. _class_TextServer_method_font_set_underline_position:
  1654. .. rst-class:: classref-method
  1655. void **font_set_underline_position** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_position **)**
  1656. Sets pixel offset of the underline below the baseline.
  1657. .. rst-class:: classref-item-separator
  1658. ----
  1659. .. _class_TextServer_method_font_set_underline_thickness:
  1660. .. rst-class:: classref-method
  1661. void **font_set_underline_thickness** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` size, :ref:`float<class_float>` underline_thickness **)**
  1662. Sets thickness of the underline in pixels.
  1663. .. rst-class:: classref-item-separator
  1664. ----
  1665. .. _class_TextServer_method_font_set_variation_coordinates:
  1666. .. rst-class:: classref-method
  1667. void **font_set_variation_coordinates** **(** :ref:`RID<class_RID>` font_rid, :ref:`Dictionary<class_Dictionary>` variation_coordinates **)**
  1668. 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.
  1669. .. rst-class:: classref-item-separator
  1670. ----
  1671. .. _class_TextServer_method_font_set_weight:
  1672. .. rst-class:: classref-method
  1673. void **font_set_weight** **(** :ref:`RID<class_RID>` font_rid, :ref:`int<class_int>` weight **)**
  1674. Sets weight (boldness) of the font. A value in the ``100...999`` range, normal font weight is ``400``, bold font weight is ``700``.
  1675. \ **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.
  1676. .. rst-class:: classref-item-separator
  1677. ----
  1678. .. _class_TextServer_method_font_supported_feature_list:
  1679. .. rst-class:: classref-method
  1680. :ref:`Dictionary<class_Dictionary>` **font_supported_feature_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1681. Returns the dictionary of the supported OpenType features.
  1682. .. rst-class:: classref-item-separator
  1683. ----
  1684. .. _class_TextServer_method_font_supported_variation_list:
  1685. .. rst-class:: classref-method
  1686. :ref:`Dictionary<class_Dictionary>` **font_supported_variation_list** **(** :ref:`RID<class_RID>` font_rid **)** |const|
  1687. Returns the dictionary of the supported OpenType variation coordinates.
  1688. .. rst-class:: classref-item-separator
  1689. ----
  1690. .. _class_TextServer_method_format_number:
  1691. .. rst-class:: classref-method
  1692. :ref:`String<class_String>` **format_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1693. Converts a number from the Western Arabic (0..9) to the numeral systems used in ``language``.
  1694. If ``language`` is omitted, the active locale will be used.
  1695. .. rst-class:: classref-item-separator
  1696. ----
  1697. .. _class_TextServer_method_free_rid:
  1698. .. rst-class:: classref-method
  1699. void **free_rid** **(** :ref:`RID<class_RID>` rid **)**
  1700. Frees an object created by this **TextServer**.
  1701. .. rst-class:: classref-item-separator
  1702. ----
  1703. .. _class_TextServer_method_get_features:
  1704. .. rst-class:: classref-method
  1705. :ref:`int<class_int>` **get_features** **(** **)** |const|
  1706. Returns text server features, see :ref:`Feature<enum_TextServer_Feature>`.
  1707. .. rst-class:: classref-item-separator
  1708. ----
  1709. .. _class_TextServer_method_get_hex_code_box_size:
  1710. .. rst-class:: classref-method
  1711. :ref:`Vector2<class_Vector2>` **get_hex_code_box_size** **(** :ref:`int<class_int>` size, :ref:`int<class_int>` index **)** |const|
  1712. Returns size of the replacement character (box with character hexadecimal code that is drawn in place of invalid characters).
  1713. .. rst-class:: classref-item-separator
  1714. ----
  1715. .. _class_TextServer_method_get_name:
  1716. .. rst-class:: classref-method
  1717. :ref:`String<class_String>` **get_name** **(** **)** |const|
  1718. Returns the name of the server interface.
  1719. .. rst-class:: classref-item-separator
  1720. ----
  1721. .. _class_TextServer_method_get_support_data_filename:
  1722. .. rst-class:: classref-method
  1723. :ref:`String<class_String>` **get_support_data_filename** **(** **)** |const|
  1724. Returns default TextServer database (e.g. ICU break iterators and dictionaries) filename.
  1725. .. rst-class:: classref-item-separator
  1726. ----
  1727. .. _class_TextServer_method_get_support_data_info:
  1728. .. rst-class:: classref-method
  1729. :ref:`String<class_String>` **get_support_data_info** **(** **)** |const|
  1730. Returns TextServer database (e.g. ICU break iterators and dictionaries) description.
  1731. .. rst-class:: classref-item-separator
  1732. ----
  1733. .. _class_TextServer_method_has:
  1734. .. rst-class:: classref-method
  1735. :ref:`bool<class_bool>` **has** **(** :ref:`RID<class_RID>` rid **)**
  1736. Returns ``true`` if ``rid`` is valid resource owned by this text server.
  1737. .. rst-class:: classref-item-separator
  1738. ----
  1739. .. _class_TextServer_method_has_feature:
  1740. .. rst-class:: classref-method
  1741. :ref:`bool<class_bool>` **has_feature** **(** :ref:`Feature<enum_TextServer_Feature>` feature **)** |const|
  1742. Returns ``true`` if the server supports a feature.
  1743. .. rst-class:: classref-item-separator
  1744. ----
  1745. .. _class_TextServer_method_is_confusable:
  1746. .. rst-class:: classref-method
  1747. :ref:`int<class_int>` **is_confusable** **(** :ref:`String<class_String>` string, :ref:`PackedStringArray<class_PackedStringArray>` dict **)** |const|
  1748. Returns index of the first string in ``dict`` which is visually confusable with the ``string``, or ``-1`` if none is found.
  1749. \ **Note:** This method doesn't detect invisible characters, for spoof detection use it in combination with :ref:`spoof_check<class_TextServer_method_spoof_check>`.
  1750. \ **Note:** Always returns ``-1`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  1751. .. rst-class:: classref-item-separator
  1752. ----
  1753. .. _class_TextServer_method_is_locale_right_to_left:
  1754. .. rst-class:: classref-method
  1755. :ref:`bool<class_bool>` **is_locale_right_to_left** **(** :ref:`String<class_String>` locale **)** |const|
  1756. Returns ``true`` if locale is right-to-left.
  1757. .. rst-class:: classref-item-separator
  1758. ----
  1759. .. _class_TextServer_method_is_valid_identifier:
  1760. .. rst-class:: classref-method
  1761. :ref:`bool<class_bool>` **is_valid_identifier** **(** :ref:`String<class_String>` string **)** |const|
  1762. Returns ``true`` if ``string`` is a valid identifier.
  1763. If the text server supports the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature, a valid identifier must:
  1764. - Conform to normalization form C.
  1765. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1766. - May contain Unicode characters of class XID_Continue in the other positions.
  1767. - Use UAX #31 recommended scripts only (mixed scripts are allowed).
  1768. If the :ref:`FEATURE_UNICODE_IDENTIFIERS<class_TextServer_constant_FEATURE_UNICODE_IDENTIFIERS>` feature is not supported, a valid identifier must:
  1769. - Begin with a Unicode character of class XID_Start or ``"_"``.
  1770. - May contain Unicode characters of class XID_Continue in the other positions.
  1771. .. rst-class:: classref-item-separator
  1772. ----
  1773. .. _class_TextServer_method_load_support_data:
  1774. .. rst-class:: classref-method
  1775. :ref:`bool<class_bool>` **load_support_data** **(** :ref:`String<class_String>` filename **)**
  1776. Loads optional TextServer database (e.g. ICU break iterators and dictionaries).
  1777. \ **Note:** This function should be called before any other TextServer functions used, otherwise it won't have any effect.
  1778. .. rst-class:: classref-item-separator
  1779. ----
  1780. .. _class_TextServer_method_name_to_tag:
  1781. .. rst-class:: classref-method
  1782. :ref:`int<class_int>` **name_to_tag** **(** :ref:`String<class_String>` name **)** |const|
  1783. Converts readable feature, variation, script or language name to OpenType tag.
  1784. .. rst-class:: classref-item-separator
  1785. ----
  1786. .. _class_TextServer_method_parse_number:
  1787. .. rst-class:: classref-method
  1788. :ref:`String<class_String>` **parse_number** **(** :ref:`String<class_String>` number, :ref:`String<class_String>` language="" **)** |const|
  1789. Converts ``number`` from the numeral systems used in ``language`` to Western Arabic (0..9).
  1790. .. rst-class:: classref-item-separator
  1791. ----
  1792. .. _class_TextServer_method_parse_structured_text:
  1793. .. rst-class:: classref-method
  1794. :ref:`Vector3i[]<class_Vector3i>` **parse_structured_text** **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` parser_type, :ref:`Array<class_Array>` args, :ref:`String<class_String>` text **)** |const|
  1795. Default implementation of the BiDi algorithm override function. See :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` for more info.
  1796. .. rst-class:: classref-item-separator
  1797. ----
  1798. .. _class_TextServer_method_percent_sign:
  1799. .. rst-class:: classref-method
  1800. :ref:`String<class_String>` **percent_sign** **(** :ref:`String<class_String>` language="" **)** |const|
  1801. Returns percent sign used in the ``language``.
  1802. .. rst-class:: classref-item-separator
  1803. ----
  1804. .. _class_TextServer_method_save_support_data:
  1805. .. rst-class:: classref-method
  1806. :ref:`bool<class_bool>` **save_support_data** **(** :ref:`String<class_String>` filename **)** |const|
  1807. Saves optional TextServer database (e.g. ICU break iterators and dictionaries) to the file.
  1808. \ **Note:** This function is used by during project export, to include TextServer database.
  1809. .. rst-class:: classref-item-separator
  1810. ----
  1811. .. _class_TextServer_method_shaped_get_span_count:
  1812. .. rst-class:: classref-method
  1813. :ref:`int<class_int>` **shaped_get_span_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1814. 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>`.
  1815. .. rst-class:: classref-item-separator
  1816. ----
  1817. .. _class_TextServer_method_shaped_get_span_meta:
  1818. .. rst-class:: classref-method
  1819. :ref:`Variant<class_Variant>` **shaped_get_span_meta** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index **)** |const|
  1820. Returns text span metadata.
  1821. .. rst-class:: classref-item-separator
  1822. ----
  1823. .. _class_TextServer_method_shaped_set_span_update_font:
  1824. .. rst-class:: classref-method
  1825. void **shaped_set_span_update_font** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` index, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={} **)**
  1826. Changes text span font, font size and OpenType features, without changing the text.
  1827. .. rst-class:: classref-item-separator
  1828. ----
  1829. .. _class_TextServer_method_shaped_text_add_object:
  1830. .. rst-class:: classref-method
  1831. :ref:`bool<class_bool>` **shaped_text_add_object** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=5, :ref:`int<class_int>` length=1, :ref:`float<class_float>` baseline=0.0 **)**
  1832. Adds inline object to the text buffer, ``key`` must be unique. In the text, object is represented as ``length`` object replacement characters.
  1833. .. rst-class:: classref-item-separator
  1834. ----
  1835. .. _class_TextServer_method_shaped_text_add_string:
  1836. .. rst-class:: classref-method
  1837. :ref:`bool<class_bool>` **shaped_text_add_string** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` text, :ref:`RID[]<class_RID>` fonts, :ref:`int<class_int>` size, :ref:`Dictionary<class_Dictionary>` opentype_features={}, :ref:`String<class_String>` language="", :ref:`Variant<class_Variant>` meta=null **)**
  1838. Adds text span and font to draw it to the text buffer.
  1839. .. rst-class:: classref-item-separator
  1840. ----
  1841. .. _class_TextServer_method_shaped_text_clear:
  1842. .. rst-class:: classref-method
  1843. void **shaped_text_clear** **(** :ref:`RID<class_RID>` rid **)**
  1844. Clears text buffer (removes text and inline objects).
  1845. .. rst-class:: classref-item-separator
  1846. ----
  1847. .. _class_TextServer_method_shaped_text_closest_character_pos:
  1848. .. rst-class:: classref-method
  1849. :ref:`int<class_int>` **shaped_text_closest_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1850. Returns composite character position closest to the ``pos``.
  1851. .. rst-class:: classref-item-separator
  1852. ----
  1853. .. _class_TextServer_method_shaped_text_draw:
  1854. .. rst-class:: classref-method
  1855. void **shaped_text_draw** **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l=-1, :ref:`float<class_float>` clip_r=-1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const|
  1856. 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).
  1857. .. rst-class:: classref-item-separator
  1858. ----
  1859. .. _class_TextServer_method_shaped_text_draw_outline:
  1860. .. rst-class:: classref-method
  1861. void **shaped_text_draw_outline** **(** :ref:`RID<class_RID>` shaped, :ref:`RID<class_RID>` canvas, :ref:`Vector2<class_Vector2>` pos, :ref:`float<class_float>` clip_l=-1, :ref:`float<class_float>` clip_r=-1, :ref:`int<class_int>` outline_size=1, :ref:`Color<class_Color>` color=Color(1, 1, 1, 1) **)** |const|
  1862. 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).
  1863. .. rst-class:: classref-item-separator
  1864. ----
  1865. .. _class_TextServer_method_shaped_text_fit_to_width:
  1866. .. rst-class:: classref-method
  1867. :ref:`float<class_float>` **shaped_text_fit_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, |bitfield|\<:ref:`JustificationFlag<enum_TextServer_JustificationFlag>`\> justification_flags=3 **)**
  1868. Adjusts text width to fit to specified width, returns new text width.
  1869. .. rst-class:: classref-item-separator
  1870. ----
  1871. .. _class_TextServer_method_shaped_text_get_ascent:
  1872. .. rst-class:: classref-method
  1873. :ref:`float<class_float>` **shaped_text_get_ascent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1874. Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
  1875. \ **Note:** Overall ascent can be higher than font ascent, if some glyphs are displaced from the baseline.
  1876. .. rst-class:: classref-item-separator
  1877. ----
  1878. .. _class_TextServer_method_shaped_text_get_carets:
  1879. .. rst-class:: classref-method
  1880. :ref:`Dictionary<class_Dictionary>` **shaped_text_get_carets** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` position **)** |const|
  1881. Returns shapes of the carets corresponding to the character offset ``position`` in the text. Returned caret shape is 1 pixel wide rectangle.
  1882. .. rst-class:: classref-item-separator
  1883. ----
  1884. .. _class_TextServer_method_shaped_text_get_character_breaks:
  1885. .. rst-class:: classref-method
  1886. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_character_breaks** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1887. Returns array of the composite character boundaries.
  1888. .. rst-class:: classref-item-separator
  1889. ----
  1890. .. _class_TextServer_method_shaped_text_get_custom_ellipsis:
  1891. .. rst-class:: classref-method
  1892. :ref:`int<class_int>` **shaped_text_get_custom_ellipsis** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1893. Returns ellipsis character used for text clipping.
  1894. .. rst-class:: classref-item-separator
  1895. ----
  1896. .. _class_TextServer_method_shaped_text_get_custom_punctuation:
  1897. .. rst-class:: classref-method
  1898. :ref:`String<class_String>` **shaped_text_get_custom_punctuation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1899. Returns custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  1900. .. rst-class:: classref-item-separator
  1901. ----
  1902. .. _class_TextServer_method_shaped_text_get_descent:
  1903. .. rst-class:: classref-method
  1904. :ref:`float<class_float>` **shaped_text_get_descent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1905. Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
  1906. \ **Note:** Overall descent can be higher than font descent, if some glyphs are displaced from the baseline.
  1907. .. rst-class:: classref-item-separator
  1908. ----
  1909. .. _class_TextServer_method_shaped_text_get_direction:
  1910. .. rst-class:: classref-method
  1911. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1912. Returns direction of the text.
  1913. .. rst-class:: classref-item-separator
  1914. ----
  1915. .. _class_TextServer_method_shaped_text_get_dominant_direction_in_range:
  1916. .. rst-class:: classref-method
  1917. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_dominant_direction_in_range** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  1918. Returns dominant direction of in the range of text.
  1919. .. rst-class:: classref-item-separator
  1920. ----
  1921. .. _class_TextServer_method_shaped_text_get_ellipsis_glyph_count:
  1922. .. rst-class:: classref-method
  1923. :ref:`int<class_int>` **shaped_text_get_ellipsis_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1924. Returns number of glyphs in the ellipsis.
  1925. .. rst-class:: classref-item-separator
  1926. ----
  1927. .. _class_TextServer_method_shaped_text_get_ellipsis_glyphs:
  1928. .. rst-class:: classref-method
  1929. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_ellipsis_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1930. Returns array of the glyphs in the ellipsis.
  1931. .. rst-class:: classref-item-separator
  1932. ----
  1933. .. _class_TextServer_method_shaped_text_get_ellipsis_pos:
  1934. .. rst-class:: classref-method
  1935. :ref:`int<class_int>` **shaped_text_get_ellipsis_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1936. Returns position of the ellipsis.
  1937. .. rst-class:: classref-item-separator
  1938. ----
  1939. .. _class_TextServer_method_shaped_text_get_glyph_count:
  1940. .. rst-class:: classref-method
  1941. :ref:`int<class_int>` **shaped_text_get_glyph_count** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1942. Returns number of glyphs in the buffer.
  1943. .. rst-class:: classref-item-separator
  1944. ----
  1945. .. _class_TextServer_method_shaped_text_get_glyphs:
  1946. .. rst-class:: classref-method
  1947. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_get_glyphs** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1948. Returns an array of glyphs in the visual order.
  1949. .. rst-class:: classref-item-separator
  1950. ----
  1951. .. _class_TextServer_method_shaped_text_get_grapheme_bounds:
  1952. .. rst-class:: classref-method
  1953. :ref:`Vector2<class_Vector2>` **shaped_text_get_grapheme_bounds** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  1954. Returns composite character's bounds as offsets from the start of the line.
  1955. .. rst-class:: classref-item-separator
  1956. ----
  1957. .. _class_TextServer_method_shaped_text_get_inferred_direction:
  1958. .. rst-class:: classref-method
  1959. :ref:`Direction<enum_TextServer_Direction>` **shaped_text_get_inferred_direction** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1960. Returns direction of the text, inferred by the BiDi algorithm.
  1961. .. rst-class:: classref-item-separator
  1962. ----
  1963. .. _class_TextServer_method_shaped_text_get_line_breaks:
  1964. .. rst-class:: classref-method
  1965. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width, :ref:`int<class_int>` start=0, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const|
  1966. Breaks text to the lines and returns character ranges for each line.
  1967. .. rst-class:: classref-item-separator
  1968. ----
  1969. .. _class_TextServer_method_shaped_text_get_line_breaks_adv:
  1970. .. rst-class:: classref-method
  1971. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_line_breaks_adv** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` width, :ref:`int<class_int>` start=0, :ref:`bool<class_bool>` once=true, |bitfield|\<:ref:`LineBreakFlag<enum_TextServer_LineBreakFlag>`\> break_flags=3 **)** |const|
  1972. Breaks text to the lines and columns. Returns character ranges for each segment.
  1973. .. rst-class:: classref-item-separator
  1974. ----
  1975. .. _class_TextServer_method_shaped_text_get_object_rect:
  1976. .. rst-class:: classref-method
  1977. :ref:`Rect2<class_Rect2>` **shaped_text_get_object_rect** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key **)** |const|
  1978. Returns bounding rectangle of the inline object.
  1979. .. rst-class:: classref-item-separator
  1980. ----
  1981. .. _class_TextServer_method_shaped_text_get_objects:
  1982. .. rst-class:: classref-method
  1983. :ref:`Array<class_Array>` **shaped_text_get_objects** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1984. Returns array of inline objects.
  1985. .. rst-class:: classref-item-separator
  1986. ----
  1987. .. _class_TextServer_method_shaped_text_get_orientation:
  1988. .. rst-class:: classref-method
  1989. :ref:`Orientation<enum_TextServer_Orientation>` **shaped_text_get_orientation** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1990. Returns text orientation.
  1991. .. rst-class:: classref-item-separator
  1992. ----
  1993. .. _class_TextServer_method_shaped_text_get_parent:
  1994. .. rst-class:: classref-method
  1995. :ref:`RID<class_RID>` **shaped_text_get_parent** **(** :ref:`RID<class_RID>` shaped **)** |const|
  1996. Returns the parent buffer from which the substring originates.
  1997. .. rst-class:: classref-item-separator
  1998. ----
  1999. .. _class_TextServer_method_shaped_text_get_preserve_control:
  2000. .. rst-class:: classref-method
  2001. :ref:`bool<class_bool>` **shaped_text_get_preserve_control** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2002. Returns ``true`` if text buffer is configured to display control characters.
  2003. .. rst-class:: classref-item-separator
  2004. ----
  2005. .. _class_TextServer_method_shaped_text_get_preserve_invalid:
  2006. .. rst-class:: classref-method
  2007. :ref:`bool<class_bool>` **shaped_text_get_preserve_invalid** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2008. Returns ``true`` if text buffer is configured to display hexadecimal codes in place of invalid characters.
  2009. \ **Note:** If set to ``false``, nothing is displayed in place of invalid characters.
  2010. .. rst-class:: classref-item-separator
  2011. ----
  2012. .. _class_TextServer_method_shaped_text_get_range:
  2013. .. rst-class:: classref-method
  2014. :ref:`Vector2i<class_Vector2i>` **shaped_text_get_range** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2015. Returns substring buffer character range in the parent buffer.
  2016. .. rst-class:: classref-item-separator
  2017. ----
  2018. .. _class_TextServer_method_shaped_text_get_selection:
  2019. .. rst-class:: classref-method
  2020. :ref:`PackedVector2Array<class_PackedVector2Array>` **shaped_text_get_selection** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` end **)** |const|
  2021. Returns selection rectangles for the specified character range.
  2022. .. rst-class:: classref-item-separator
  2023. ----
  2024. .. _class_TextServer_method_shaped_text_get_size:
  2025. .. rst-class:: classref-method
  2026. :ref:`Vector2<class_Vector2>` **shaped_text_get_size** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2027. Returns size of the text.
  2028. .. rst-class:: classref-item-separator
  2029. ----
  2030. .. _class_TextServer_method_shaped_text_get_spacing:
  2031. .. rst-class:: classref-method
  2032. :ref:`int<class_int>` **shaped_text_get_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing **)** |const|
  2033. Returns extra spacing added between glyphs or lines in pixels.
  2034. .. rst-class:: classref-item-separator
  2035. ----
  2036. .. _class_TextServer_method_shaped_text_get_trim_pos:
  2037. .. rst-class:: classref-method
  2038. :ref:`int<class_int>` **shaped_text_get_trim_pos** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2039. Returns the position of the overrun trim.
  2040. .. rst-class:: classref-item-separator
  2041. ----
  2042. .. _class_TextServer_method_shaped_text_get_underline_position:
  2043. .. rst-class:: classref-method
  2044. :ref:`float<class_float>` **shaped_text_get_underline_position** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2045. Returns pixel offset of the underline below the baseline.
  2046. .. rst-class:: classref-item-separator
  2047. ----
  2048. .. _class_TextServer_method_shaped_text_get_underline_thickness:
  2049. .. rst-class:: classref-method
  2050. :ref:`float<class_float>` **shaped_text_get_underline_thickness** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2051. Returns thickness of the underline.
  2052. .. rst-class:: classref-item-separator
  2053. ----
  2054. .. _class_TextServer_method_shaped_text_get_width:
  2055. .. rst-class:: classref-method
  2056. :ref:`float<class_float>` **shaped_text_get_width** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2057. Returns width (for horizontal layout) or height (for vertical) of the text.
  2058. .. rst-class:: classref-item-separator
  2059. ----
  2060. .. _class_TextServer_method_shaped_text_get_word_breaks:
  2061. .. rst-class:: classref-method
  2062. :ref:`PackedInt32Array<class_PackedInt32Array>` **shaped_text_get_word_breaks** **(** :ref:`RID<class_RID>` shaped, |bitfield|\<:ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>`\> grapheme_flags=264 **)** |const|
  2063. 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>`).
  2064. .. rst-class:: classref-item-separator
  2065. ----
  2066. .. _class_TextServer_method_shaped_text_has_visible_chars:
  2067. .. rst-class:: classref-method
  2068. :ref:`bool<class_bool>` **shaped_text_has_visible_chars** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2069. Returns ``true`` if text buffer contains any visible characters.
  2070. .. rst-class:: classref-item-separator
  2071. ----
  2072. .. _class_TextServer_method_shaped_text_hit_test_grapheme:
  2073. .. rst-class:: classref-method
  2074. :ref:`int<class_int>` **shaped_text_hit_test_grapheme** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  2075. Returns grapheme index at the specified pixel offset at the baseline, or ``-1`` if none is found.
  2076. .. rst-class:: classref-item-separator
  2077. ----
  2078. .. _class_TextServer_method_shaped_text_hit_test_position:
  2079. .. rst-class:: classref-method
  2080. :ref:`int<class_int>` **shaped_text_hit_test_position** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` coords **)** |const|
  2081. Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
  2082. .. rst-class:: classref-item-separator
  2083. ----
  2084. .. _class_TextServer_method_shaped_text_is_ready:
  2085. .. rst-class:: classref-method
  2086. :ref:`bool<class_bool>` **shaped_text_is_ready** **(** :ref:`RID<class_RID>` shaped **)** |const|
  2087. Returns ``true`` if buffer is successfully shaped.
  2088. .. rst-class:: classref-item-separator
  2089. ----
  2090. .. _class_TextServer_method_shaped_text_next_character_pos:
  2091. .. rst-class:: classref-method
  2092. :ref:`int<class_int>` **shaped_text_next_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2093. Returns composite character end position closest to the ``pos``.
  2094. .. rst-class:: classref-item-separator
  2095. ----
  2096. .. _class_TextServer_method_shaped_text_next_grapheme_pos:
  2097. .. rst-class:: classref-method
  2098. :ref:`int<class_int>` **shaped_text_next_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2099. Returns grapheme end position closest to the ``pos``.
  2100. .. rst-class:: classref-item-separator
  2101. ----
  2102. .. _class_TextServer_method_shaped_text_overrun_trim_to_width:
  2103. .. rst-class:: classref-method
  2104. void **shaped_text_overrun_trim_to_width** **(** :ref:`RID<class_RID>` shaped, :ref:`float<class_float>` width=0, |bitfield|\<:ref:`TextOverrunFlag<enum_TextServer_TextOverrunFlag>`\> overrun_trim_flags=0 **)**
  2105. Trims text if it exceeds the given width.
  2106. .. rst-class:: classref-item-separator
  2107. ----
  2108. .. _class_TextServer_method_shaped_text_prev_character_pos:
  2109. .. rst-class:: classref-method
  2110. :ref:`int<class_int>` **shaped_text_prev_character_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2111. Returns composite character start position closest to the ``pos``.
  2112. .. rst-class:: classref-item-separator
  2113. ----
  2114. .. _class_TextServer_method_shaped_text_prev_grapheme_pos:
  2115. .. rst-class:: classref-method
  2116. :ref:`int<class_int>` **shaped_text_prev_grapheme_pos** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` pos **)** |const|
  2117. Returns grapheme start position closest to the ``pos``.
  2118. .. rst-class:: classref-item-separator
  2119. ----
  2120. .. _class_TextServer_method_shaped_text_resize_object:
  2121. .. rst-class:: classref-method
  2122. :ref:`bool<class_bool>` **shaped_text_resize_object** **(** :ref:`RID<class_RID>` shaped, :ref:`Variant<class_Variant>` key, :ref:`Vector2<class_Vector2>` size, :ref:`InlineAlignment<enum_@GlobalScope_InlineAlignment>` inline_align=5, :ref:`float<class_float>` baseline=0.0 **)**
  2123. Sets new size and alignment of embedded object.
  2124. .. rst-class:: classref-item-separator
  2125. ----
  2126. .. _class_TextServer_method_shaped_text_set_bidi_override:
  2127. .. rst-class:: classref-method
  2128. void **shaped_text_set_bidi_override** **(** :ref:`RID<class_RID>` shaped, :ref:`Array<class_Array>` override **)**
  2129. Overrides BiDi for the structured text.
  2130. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
  2131. .. rst-class:: classref-item-separator
  2132. ----
  2133. .. _class_TextServer_method_shaped_text_set_custom_ellipsis:
  2134. .. rst-class:: classref-method
  2135. void **shaped_text_set_custom_ellipsis** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` char **)**
  2136. Sets ellipsis character used for text clipping.
  2137. .. rst-class:: classref-item-separator
  2138. ----
  2139. .. _class_TextServer_method_shaped_text_set_custom_punctuation:
  2140. .. rst-class:: classref-method
  2141. void **shaped_text_set_custom_punctuation** **(** :ref:`RID<class_RID>` shaped, :ref:`String<class_String>` punct **)**
  2142. Sets custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
  2143. .. rst-class:: classref-item-separator
  2144. ----
  2145. .. _class_TextServer_method_shaped_text_set_direction:
  2146. .. rst-class:: classref-method
  2147. void **shaped_text_set_direction** **(** :ref:`RID<class_RID>` shaped, :ref:`Direction<enum_TextServer_Direction>` direction=0 **)**
  2148. 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.
  2149. \ **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>`).
  2150. .. rst-class:: classref-item-separator
  2151. ----
  2152. .. _class_TextServer_method_shaped_text_set_orientation:
  2153. .. rst-class:: classref-method
  2154. void **shaped_text_set_orientation** **(** :ref:`RID<class_RID>` shaped, :ref:`Orientation<enum_TextServer_Orientation>` orientation=0 **)**
  2155. Sets desired text orientation.
  2156. \ **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>`).
  2157. .. rst-class:: classref-item-separator
  2158. ----
  2159. .. _class_TextServer_method_shaped_text_set_preserve_control:
  2160. .. rst-class:: classref-method
  2161. void **shaped_text_set_preserve_control** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2162. If set to ``true`` text buffer will display control characters.
  2163. .. rst-class:: classref-item-separator
  2164. ----
  2165. .. _class_TextServer_method_shaped_text_set_preserve_invalid:
  2166. .. rst-class:: classref-method
  2167. void **shaped_text_set_preserve_invalid** **(** :ref:`RID<class_RID>` shaped, :ref:`bool<class_bool>` enabled **)**
  2168. If set to ``true`` text buffer will display invalid characters as hexadecimal codes, otherwise nothing is displayed.
  2169. .. rst-class:: classref-item-separator
  2170. ----
  2171. .. _class_TextServer_method_shaped_text_set_spacing:
  2172. .. rst-class:: classref-method
  2173. void **shaped_text_set_spacing** **(** :ref:`RID<class_RID>` shaped, :ref:`SpacingType<enum_TextServer_SpacingType>` spacing, :ref:`int<class_int>` value **)**
  2174. Sets extra spacing added between glyphs or lines in pixels.
  2175. .. rst-class:: classref-item-separator
  2176. ----
  2177. .. _class_TextServer_method_shaped_text_shape:
  2178. .. rst-class:: classref-method
  2179. :ref:`bool<class_bool>` **shaped_text_shape** **(** :ref:`RID<class_RID>` shaped **)**
  2180. Shapes buffer if it's not shaped. Returns ``true`` if the string is shaped successfully.
  2181. \ **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.
  2182. .. rst-class:: classref-item-separator
  2183. ----
  2184. .. _class_TextServer_method_shaped_text_sort_logical:
  2185. .. rst-class:: classref-method
  2186. :ref:`Dictionary[]<class_Dictionary>` **shaped_text_sort_logical** **(** :ref:`RID<class_RID>` shaped **)**
  2187. Returns text glyphs in the logical order.
  2188. .. rst-class:: classref-item-separator
  2189. ----
  2190. .. _class_TextServer_method_shaped_text_substr:
  2191. .. rst-class:: classref-method
  2192. :ref:`RID<class_RID>` **shaped_text_substr** **(** :ref:`RID<class_RID>` shaped, :ref:`int<class_int>` start, :ref:`int<class_int>` length **)** |const|
  2193. Returns text buffer for the substring of the text in the ``shaped`` text buffer (including inline objects).
  2194. .. rst-class:: classref-item-separator
  2195. ----
  2196. .. _class_TextServer_method_shaped_text_tab_align:
  2197. .. rst-class:: classref-method
  2198. :ref:`float<class_float>` **shaped_text_tab_align** **(** :ref:`RID<class_RID>` shaped, :ref:`PackedFloat32Array<class_PackedFloat32Array>` tab_stops **)**
  2199. Aligns shaped text to the given tab-stops.
  2200. .. rst-class:: classref-item-separator
  2201. ----
  2202. .. _class_TextServer_method_spoof_check:
  2203. .. rst-class:: classref-method
  2204. :ref:`bool<class_bool>` **spoof_check** **(** :ref:`String<class_String>` string **)** |const|
  2205. Returns ``true`` if ``string`` is likely to be an attempt at confusing the reader.
  2206. \ **Note:** Always returns ``false`` if the server does not support the :ref:`FEATURE_UNICODE_SECURITY<class_TextServer_constant_FEATURE_UNICODE_SECURITY>` feature.
  2207. .. rst-class:: classref-item-separator
  2208. ----
  2209. .. _class_TextServer_method_string_get_character_breaks:
  2210. .. rst-class:: classref-method
  2211. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_character_breaks** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2212. Returns array of the composite character boundaries.
  2213. ::
  2214. var ts = TextServerManager.get_primary_interface()
  2215. print(ts.string_get_word_breaks("Test ❤️‍🔥 Test")) # Prints [1, 2, 3, 4, 5, 9, 10, 11, 12, 13, 14]
  2216. .. rst-class:: classref-item-separator
  2217. ----
  2218. .. _class_TextServer_method_string_get_word_breaks:
  2219. .. rst-class:: classref-method
  2220. :ref:`PackedInt32Array<class_PackedInt32Array>` **string_get_word_breaks** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="", :ref:`int<class_int>` chars_per_line=0 **)** |const|
  2221. 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.
  2222. When ``chars_per_line`` is greater than zero, line break boundaries are returned instead.
  2223. ::
  2224. var ts = TextServerManager.get_primary_interface()
  2225. print(ts.string_get_word_breaks("Godot Engine")) # Prints [0, 5, 6, 12]
  2226. print(ts.string_get_word_breaks("Godot Engine", "en", 5)) # Prints [0, 5, 6, 11, 11, 12]
  2227. .. rst-class:: classref-item-separator
  2228. ----
  2229. .. _class_TextServer_method_string_to_lower:
  2230. .. rst-class:: classref-method
  2231. :ref:`String<class_String>` **string_to_lower** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2232. Returns the string converted to lowercase.
  2233. \ **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>`).
  2234. \ **Note:** The result may be longer or shorter than the original.
  2235. .. rst-class:: classref-item-separator
  2236. ----
  2237. .. _class_TextServer_method_string_to_upper:
  2238. .. rst-class:: classref-method
  2239. :ref:`String<class_String>` **string_to_upper** **(** :ref:`String<class_String>` string, :ref:`String<class_String>` language="" **)** |const|
  2240. Returns the string converted to uppercase.
  2241. \ **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>`).
  2242. \ **Note:** The result may be longer or shorter than the original.
  2243. .. rst-class:: classref-item-separator
  2244. ----
  2245. .. _class_TextServer_method_strip_diacritics:
  2246. .. rst-class:: classref-method
  2247. :ref:`String<class_String>` **strip_diacritics** **(** :ref:`String<class_String>` string **)** |const|
  2248. Strips diacritics from the string.
  2249. \ **Note:** The result may be longer or shorter than the original.
  2250. .. rst-class:: classref-item-separator
  2251. ----
  2252. .. _class_TextServer_method_tag_to_name:
  2253. .. rst-class:: classref-method
  2254. :ref:`String<class_String>` **tag_to_name** **(** :ref:`int<class_int>` tag **)** |const|
  2255. Converts OpenType tag to readable feature, variation, script or language name.
  2256. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  2257. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  2258. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  2259. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  2260. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  2261. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
  2262. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`