diff options
Diffstat (limited to 'doc/classes/TextParagraph.xml')
| -rw-r--r-- | doc/classes/TextParagraph.xml | 126 |
1 files changed, 63 insertions, 63 deletions
diff --git a/doc/classes/TextParagraph.xml b/doc/classes/TextParagraph.xml index c733d8fcee..e0729ba844 100644 --- a/doc/classes/TextParagraph.xml +++ b/doc/classes/TextParagraph.xml @@ -11,21 +11,21 @@ <methods> <method name="add_object"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="size" type="Vector2" /> - <argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> - <argument index="3" name="length" type="int" default="1" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="size" type="Vector2" /> + <param index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="3" name="length" type="int" default="1" /> <description> - Adds inline object to the text buffer, [code]key[/code] must be unique. In the text, object is represented as [code]length[/code] object replacement characters. + Adds inline object to the text buffer, [param key] must be unique. In the text, object is represented as [param length] object replacement characters. </description> </method> <method name="add_string"> <return type="bool" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="font" type="Font" /> - <argument index="2" name="font_size" type="int" /> - <argument index="3" name="language" type="String" default="""" /> - <argument index="4" name="meta" type="Variant" default="null" /> + <param index="0" name="text" type="String" /> + <param index="1" name="font" type="Font" /> + <param index="2" name="font_size" type="int" /> + <param index="3" name="language" type="String" default="""" /> + <param index="4" name="meta" type="Variant" default="null" /> <description> Adds text span and font to draw it. </description> @@ -44,63 +44,63 @@ </method> <method name="draw" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="3" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="3" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> <description> - Draw all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + Draw all lines of the text and drop cap into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box. </description> </method> <method name="draw_dropcap" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> - Draw drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + Draw drop cap into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box. </description> </method> <method name="draw_dropcap_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="outline_size" type="int" default="1" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="outline_size" type="int" default="1" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> - Draw drop cap outline into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + Draw drop cap outline into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box. </description> </method> <method name="draw_line" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="line" type="int" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="line" type="int" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> - Draw single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + Draw single line of text into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box. </description> </method> <method name="draw_line_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="line" type="int" /> - <argument index="3" name="outline_size" type="int" default="1" /> - <argument index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="line" type="int" /> + <param index="3" name="outline_size" type="int" default="1" /> + <param index="4" name="color" type="Color" default="Color(1, 1, 1, 1)" /> <description> - Draw outline of the single line of text into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + Draw outline of the single line of text into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box. </description> </method> <method name="draw_outline" qualifiers="const"> <return type="void" /> - <argument index="0" name="canvas" type="RID" /> - <argument index="1" name="pos" type="Vector2" /> - <argument index="2" name="outline_size" type="int" default="1" /> - <argument index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> - <argument index="4" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="0" name="canvas" type="RID" /> + <param index="1" name="pos" type="Vector2" /> + <param index="2" name="outline_size" type="int" default="1" /> + <param index="3" name="color" type="Color" default="Color(1, 1, 1, 1)" /> + <param index="4" name="dc_color" type="Color" default="Color(1, 1, 1, 1)" /> <description> - Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with [code]color[/code]. [code]pos[/code] specifies the top left corner of the bounding box. + Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with [param color]. [param pos] specifies the top left corner of the bounding box. </description> </method> <method name="get_dropcap_lines" qualifiers="const"> @@ -123,7 +123,7 @@ </method> <method name="get_line_ascent" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical). </description> @@ -136,64 +136,64 @@ </method> <method name="get_line_descent" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical). </description> </method> <method name="get_line_object_rect" qualifiers="const"> <return type="Rect2" /> - <argument index="0" name="line" type="int" /> - <argument index="1" name="key" type="Variant" /> + <param index="0" name="line" type="int" /> + <param index="1" name="key" type="Variant" /> <description> Returns bounding rectangle of the inline object. </description> </method> <method name="get_line_objects" qualifiers="const"> <return type="Array" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns array of inline objects in the line. </description> </method> <method name="get_line_range" qualifiers="const"> <return type="Vector2i" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns character range of the line. </description> </method> <method name="get_line_rid" qualifiers="const"> <return type="RID" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns TextServer line buffer RID. </description> </method> <method name="get_line_size" qualifiers="const"> <return type="Vector2" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns size of the bounding box of the line of text. </description> </method> <method name="get_line_underline_position" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns pixel offset of the underline below the baseline. </description> </method> <method name="get_line_underline_thickness" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns thickness of the underline. </description> </method> <method name="get_line_width" qualifiers="const"> <return type="float" /> - <argument index="0" name="line" type="int" /> + <param index="0" name="line" type="int" /> <description> Returns width (for horizontal layout) or height (for vertical) of the line of text. </description> @@ -218,23 +218,23 @@ </method> <method name="hit_test" qualifiers="const"> <return type="int" /> - <argument index="0" name="coords" type="Vector2" /> + <param index="0" name="coords" type="Vector2" /> <description> Returns caret character offset at the specified coordinates. This function always returns a valid position. </description> </method> <method name="resize_object"> <return type="bool" /> - <argument index="0" name="key" type="Variant" /> - <argument index="1" name="size" type="Vector2" /> - <argument index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> + <param index="0" name="key" type="Variant" /> + <param index="1" name="size" type="Vector2" /> + <param index="2" name="inline_align" type="int" enum="InlineAlignment" default="5" /> <description> Sets new size and alignment of embedded object. </description> </method> <method name="set_bidi_override"> <return type="void" /> - <argument index="0" name="override" type="Array" /> + <param index="0" name="override" type="Array" /> <description> Overrides BiDi for the structured text. Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately. @@ -242,18 +242,18 @@ </method> <method name="set_dropcap"> <return type="bool" /> - <argument index="0" name="text" type="String" /> - <argument index="1" name="font" type="Font" /> - <argument index="2" name="font_size" type="int" /> - <argument index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> - <argument index="4" name="language" type="String" default="""" /> + <param index="0" name="text" type="String" /> + <param index="1" name="font" type="Font" /> + <param index="2" name="font_size" type="int" /> + <param index="3" name="dropcap_margins" type="Rect2" default="Rect2(0, 0, 0, 0)" /> + <param index="4" name="language" type="String" default="""" /> <description> Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text. </description> </method> <method name="tab_align"> <return type="void" /> - <argument index="0" name="tab_stops" type="PackedFloat32Array" /> + <param index="0" name="tab_stops" type="PackedFloat32Array" /> <description> Aligns paragraph to the given tab-stops. </description> |