Browse Source

Merge pull request #47098 from Birdulon/DocDrawString4

Documentation: Correct CanvasItem.draw_string position description.
Rémi Verschelde 4 years ago
parent
commit
c34b110784
2 changed files with 3 additions and 2 deletions
  1. 1 1
      doc/classes/CanvasItem.xml
  2. 2 1
      doc/classes/Font.xml

+ 1 - 1
doc/classes/CanvasItem.xml

@@ -318,7 +318,7 @@
 			<argument index="9" name="flags" type="int" default="3">
 			</argument>
 			<description>
-				Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (top-left corner). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
+				Draws [code]text[/code] using the specified [code]font[/code] at the [code]position[/code] (bottom-left corner using the baseline of the font). The text will have its color multiplied by [code]modulate[/code]. If [code]clip_w[/code] is greater than or equal to 0, the text will be clipped if it exceeds the specified width.
 				[b]Example using the default project font:[/b]
 				[codeblocks]
 				[gdscript]

+ 2 - 1
doc/classes/Font.xml

@@ -175,7 +175,7 @@
 			</argument>
 			<description>
 				Returns the size of a character, optionally taking kerning into account if the next character is provided.
-				[b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead.
+				[b]Note:[/b] Do not use this function to calculate width of the string character by character, use [method get_string_size] or [TextLine] instead. The height returned is the font height (see also [method get_height]) and has no relation to the glyph height.
 			</description>
 		</method>
 		<method name="get_data" qualifiers="const">
@@ -248,6 +248,7 @@
 			</argument>
 			<description>
 				Returns the size size of a bounding box of a string, taking kerning and advance into account.
+				[b]Note:[/b] Real height of the string is context-dependent and can be significantly different from the value returned by [method get_height].
 				See also [method draw_string].
 			</description>
 		</method>