Browse Source

Merge pull request #64297 from timothyqiu/outline-doc

Document `outline` parameter of `Font.draw_char()`
Yuri Sizov 3 years ago
parent
commit
1806e414b8
1 changed files with 1 additions and 0 deletions
  1. 1 0
      doc/classes/Font.xml

+ 1 - 0
doc/classes/Font.xml

@@ -35,6 +35,7 @@
 			<argument index="5" name="outline" type="bool" default="false" />
 			<description>
 				Draw character [code]char[/code] into a canvas item using the font at a given position, with [code]modulate[/code] color, and optionally kerning if [code]next[/code] is passed. clipping the width. [code]position[/code] specifies the baseline, not the top. To draw from the top, [i]ascent[/i] must be added to the Y axis. The width used by the character is returned, making this function useful for drawing strings character by character.
+				If [code]outline[/code] is [code]true[/code], the outline of the character is drawn instead of the character itself.
 			</description>
 		</method>
 		<method name="get_ascent" qualifiers="const">