summaryrefslogtreecommitdiff
path: root/doc/classes/TextLine.xml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/classes/TextLine.xml')
-rw-r--r--doc/classes/TextLine.xml52
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/classes/TextLine.xml b/doc/classes/TextLine.xml
index 601650db2e..471c1a9040 100644
--- a/doc/classes/TextLine.xml
+++ b/doc/classes/TextLine.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="&quot;&quot;" />
- <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="&quot;&quot;" />
+ <param index="4" name="meta" type="Variant" default="null" />
<description>
Adds text span and font to draw it.
</description>
@@ -38,21 +38,21 @@
</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)" />
+ <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 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 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)" />
+ <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 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 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="get_line_ascent" qualifiers="const">
@@ -87,7 +87,7 @@
</method>
<method name="get_object_rect" qualifiers="const">
<return type="Rect2" />
- <argument index="0" name="key" type="Variant" />
+ <param index="0" name="key" type="Variant" />
<description>
Returns bounding rectangle of the inline object.
</description>
@@ -112,23 +112,23 @@
</method>
<method name="hit_test" qualifiers="const">
<return type="int" />
- <argument index="0" name="coords" type="float" />
+ <param index="0" name="coords" type="float" />
<description>
Returns caret character offset at the specified pixel offset at the baseline. 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.
@@ -136,7 +136,7 @@
</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 text to the given tab-stops.
</description>