Merge pull request #91974 from bruvzg/ts_notes

[TextServer] Add notes about high level text/font classes and getting active server instance.
This commit is contained in:
Rémi Verschelde 2024-05-15 13:51:38 +02:00
commit ce00392fc3
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 10 additions and 0 deletions

View File

@ -5,6 +5,16 @@
</brief_description>
<description>
[TextServer] is the API backend for managing fonts and rendering text.
[b]Note:[/b] This is a low-level API, consider using [TextLine], [TextParagraph], and [Font] classes instead.
This is an abstract class, so to get the currently active [TextServer] instance, use the following code:
[codeblocks]
[gdscript]
var ts = TextServerManager.get_primary_interface()
[/gdscript]
[csharp]
var ts = TextServerManager.GetPrimaryInterface();
[/csharp]
[/codeblocks]
</description>
<tutorials>
</tutorials>