summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-05-15 13:51:38 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-05-15 13:51:38 +0200
commitce00392fc35ce639752c710094d87a4311985fb2 (patch)
tree357ac325075bcfac07fafefe205380acf9b07951
parent693a13a8498611d8f1b2ba22eb1a19fba126e426 (diff)
parentcfb9639fc3e9337b14e9b30b135f44edb6a700ea (diff)
downloadredot-engine-ce00392fc35ce639752c710094d87a4311985fb2.tar.gz
Merge pull request #91974 from bruvzg/ts_notes
[TextServer] Add notes about high level text/font classes and getting active server instance.
-rw-r--r--doc/classes/TextServer.xml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/TextServer.xml b/doc/classes/TextServer.xml
index 7579a3938f..34137a18ef 100644
--- a/doc/classes/TextServer.xml
+++ b/doc/classes/TextServer.xml
@@ -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>