Text#
- class Text#
A text label. Added to a
Canvasor aPanel.- rect_transform#
The rect transform for the UI object.
- Attribute:
Read-only, cannot be set
- Return type:
- layout_element#
How much space the UI object asks a layout for.
- Attribute:
Read-only, cannot be set
- Return type:
Note
Only has an effect when the object is in a panel that has a layout. A canvas is not inside a layout and does not have one.
- visible#
Whether the UI object is visible.
- Attribute:
Can be read or written
- Return type:
bool
Note
This is the object’s own setting, which is what it was last set to. An object is only drawn when everything it is inside is visible as well, so an interface can be built with its parts visible, inside a panel that is not, and shown all at once by making that panel visible.
- content#
The text string
- Attribute:
Can be read or written
- Return type:
str
- word_wrap#
Whether the text wraps onto further lines when it is wider than the space it has. Text that does not wrap carries on past the edge, and its preferred size is that of a single line, so a changing value leaves a layout in place.
- Attribute:
Can be read or written
- Return type:
bool
- font#
Name of the font
- Attribute:
Can be read or written
- Return type:
str
Note
Empty if the game provided no font to draw the text with, in which case it is not drawn. See
Text.available_fontsfor the names that can be set.
- available_fonts#
A list of all available fonts.
- Attribute:
Read-only, cannot be set
- Return type:
list(str)
- size#
Font size.
- Attribute:
Can be read or written
- Return type:
int
- color#
The color the text is drawn in.
- Attribute:
Can be read or written
- Return type:
- alignment#
Alignment.
- Attribute:
Can be read or written
- Return type:
- line_spacing#
Line spacing.
- Attribute:
Can be read or written
- Return type:
float
- remove()#
Remove the UI object.
- class FontStyle#
Font style.
- normal#
Normal.
- bold#
Bold.
- italic#
Italic.
- bold_and_italic#
Bold and italic.