TextParams

This type is used to determine text alignment.

Line alignment only makes sense if you have multiple lines in your text. By default, all next lines will start from the left side of the text. You can change this behavior by using one of the functions that take line as a parameter. For example, if you pass right to the line alignment, all next lines will start from the right side. Text alignment will remain as dictated by v and h parameters.

WithV

Function

Creates TextParams instance with vertical alignment.

Arguments

Name	Type	Description
v	TextAlignment	Vertical alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local align_top = draw.TextParams.WithV(draw.TextAlignment.TOP);

---

WithH

Function

Creates TextParams instance with horizontal alignment.

Arguments

Name	Type	Description
h	TextAlignment	Horizontal alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local align_right = draw.TextParams.WithH(draw.TextAlignment.RIGHT);

---

WithLine

Function

Creates TextParams instance with line alignment.

Arguments

Name	Type	Description
line	TextAlignment	Line alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local lines_center = draw.TextParams.WithLine(draw.TextAlignment.CENTER);

---

WithVH

Function

Creates TextParams instance with vertical and horizontal alignments.

Arguments

Name	Type	Description
v	TextAlignment	Vertical alignment.
h	TextAlignment	Horizontal alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local align_bottom_right = draw.TextParams.WithVH(draw.TextAlignment.BOTTOM, draw.TextAlignment.RIGHT);

---

WithVLine

Function

Creates TextParams instance with vertical alignment and line alignment.

Arguments

Name	Type	Description
v	TextAlignment	Vertical alignment.
line	TextAlignment	Line alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local align = draw.TextParams.WithVLine(draw.TextAlignment.BOTTOM, draw.TextAlignment.CENTER);

---

WithHLine

Function

Creates TextParams instance with horizontal alignment and line alignment.

Arguments

Name	Type	Description
h	TextAlignment	Horizontal alignment.
line	TextAlignment	Line alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local align = draw.TextParams.WithHLine(draw.TextAlignment.CENTER, draw.TextAlignment.CENTER);

---

WithVHLine

Function

Creates TextParams instance with vertical, horizontal and line alignments.

Arguments

Name	Type	Description
v	TextAlignment	Vertical alignment.
h	TextAlignment	Horizontal alignment.
line	TextAlignment	Line alignment.

Returns

Type	Description
TextParams	Created text params.

Example

local align = draw.TextParams.WithVHLine(draw.TextAlignment.CENTER, draw.TextAlignment.CENTER, draw.TextAlignment.CENTER);