Browse Source

[TextServer] Add notes about high level text/font classes and getting active server instance.

bruvzg 1 year ago
parent
commit
cfb9639fc3
1 changed files with 10 additions and 0 deletions
  1. 10 0
      doc/classes/TextServer.xml

+ 10 - 0
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>