class_label.rst 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630
  1. :github_url: hide
  2. .. DO NOT EDIT THIS FILE!!!
  3. .. Generated automatically from Godot engine sources.
  4. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
  5. .. XML source: https://github.com/godotengine/godot/tree/master/doc/classes/Label.xml.
  6. .. _class_Label:
  7. Label
  8. =====
  9. **Inherits:** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  10. Displays plain text in a line or wrapped inside a rectangle. For formatted text, use :ref:`RichTextLabel<class_RichTextLabel>`.
  11. .. rst-class:: classref-introduction-group
  12. Description
  13. -----------
  14. Label displays plain text on the screen. It gives you control over the horizontal and vertical alignment and can wrap the text inside the node's bounding rectangle. It doesn't support bold, italics, or other formatting. For that, use :ref:`RichTextLabel<class_RichTextLabel>` instead.
  15. \ **Note:** Contrarily to most other :ref:`Control<class_Control>`\ s, Label's :ref:`Control.mouse_filter<class_Control_property_mouse_filter>` defaults to :ref:`Control.MOUSE_FILTER_IGNORE<class_Control_constant_MOUSE_FILTER_IGNORE>` (i.e. it doesn't react to mouse input events). This implies that a label won't display any configured :ref:`Control.tooltip_text<class_Control_property_tooltip_text>`, unless you change its mouse filter.
  16. .. rst-class:: classref-introduction-group
  17. Tutorials
  18. ---------
  19. - `2D Dodge The Creeps Demo <https://godotengine.org/asset-library/asset/515>`__
  20. .. rst-class:: classref-reftable-group
  21. Properties
  22. ----------
  23. .. table::
  24. :widths: auto
  25. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  26. | :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` | :ref:`autowrap_mode<class_Label_property_autowrap_mode>` | ``0`` |
  27. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  28. | :ref:`bool<class_bool>` | :ref:`clip_text<class_Label_property_clip_text>` | ``false`` |
  29. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  30. | :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` | :ref:`horizontal_alignment<class_Label_property_horizontal_alignment>` | ``0`` |
  31. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  32. | :ref:`LabelSettings<class_LabelSettings>` | :ref:`label_settings<class_Label_property_label_settings>` | |
  33. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  34. | :ref:`String<class_String>` | :ref:`language<class_Label_property_language>` | ``""`` |
  35. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  36. | :ref:`int<class_int>` | :ref:`lines_skipped<class_Label_property_lines_skipped>` | ``0`` |
  37. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  38. | :ref:`int<class_int>` | :ref:`max_lines_visible<class_Label_property_max_lines_visible>` | ``-1`` |
  39. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  40. | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``2`` (overrides :ref:`Control<class_Control_property_mouse_filter>`) |
  41. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  42. | :ref:`int<class_int>` | size_flags_vertical | ``4`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
  43. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  44. | :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` | :ref:`structured_text_bidi_override<class_Label_property_structured_text_bidi_override>` | ``0`` |
  45. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  46. | :ref:`Array<class_Array>` | :ref:`structured_text_bidi_override_options<class_Label_property_structured_text_bidi_override_options>` | ``[]`` |
  47. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  48. | :ref:`String<class_String>` | :ref:`text<class_Label_property_text>` | ``""`` |
  49. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  50. | :ref:`TextDirection<enum_Control_TextDirection>` | :ref:`text_direction<class_Label_property_text_direction>` | ``0`` |
  51. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  52. | :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` | :ref:`text_overrun_behavior<class_Label_property_text_overrun_behavior>` | ``0`` |
  53. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  54. | :ref:`bool<class_bool>` | :ref:`uppercase<class_Label_property_uppercase>` | ``false`` |
  55. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  56. | :ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` | :ref:`vertical_alignment<class_Label_property_vertical_alignment>` | ``0`` |
  57. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  58. | :ref:`int<class_int>` | :ref:`visible_characters<class_Label_property_visible_characters>` | ``-1`` |
  59. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  60. | :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` | :ref:`visible_characters_behavior<class_Label_property_visible_characters_behavior>` | ``0`` |
  61. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  62. | :ref:`float<class_float>` | :ref:`visible_ratio<class_Label_property_visible_ratio>` | ``1.0`` |
  63. +-----------------------------------------------------------------------------+----------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------+
  64. .. rst-class:: classref-reftable-group
  65. Methods
  66. -------
  67. .. table::
  68. :widths: auto
  69. +-----------------------+--------------------------------------------------------------------------------------------------------------+
  70. | :ref:`int<class_int>` | :ref:`get_line_count<class_Label_method_get_line_count>` **(** **)** |const| |
  71. +-----------------------+--------------------------------------------------------------------------------------------------------------+
  72. | :ref:`int<class_int>` | :ref:`get_line_height<class_Label_method_get_line_height>` **(** :ref:`int<class_int>` line=-1 **)** |const| |
  73. +-----------------------+--------------------------------------------------------------------------------------------------------------+
  74. | :ref:`int<class_int>` | :ref:`get_total_character_count<class_Label_method_get_total_character_count>` **(** **)** |const| |
  75. +-----------------------+--------------------------------------------------------------------------------------------------------------+
  76. | :ref:`int<class_int>` | :ref:`get_visible_line_count<class_Label_method_get_visible_line_count>` **(** **)** |const| |
  77. +-----------------------+--------------------------------------------------------------------------------------------------------------+
  78. .. rst-class:: classref-reftable-group
  79. Theme Properties
  80. ----------------
  81. .. table::
  82. :widths: auto
  83. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  84. | :ref:`Color<class_Color>` | :ref:`font_color<class_Label_theme_color_font_color>` | ``Color(1, 1, 1, 1)`` |
  85. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  86. | :ref:`Color<class_Color>` | :ref:`font_outline_color<class_Label_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
  87. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  88. | :ref:`Color<class_Color>` | :ref:`font_shadow_color<class_Label_theme_color_font_shadow_color>` | ``Color(0, 0, 0, 0)`` |
  89. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  90. | :ref:`int<class_int>` | :ref:`line_spacing<class_Label_theme_constant_line_spacing>` | ``3`` |
  91. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  92. | :ref:`int<class_int>` | :ref:`outline_size<class_Label_theme_constant_outline_size>` | ``0`` |
  93. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  94. | :ref:`int<class_int>` | :ref:`shadow_offset_x<class_Label_theme_constant_shadow_offset_x>` | ``1`` |
  95. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  96. | :ref:`int<class_int>` | :ref:`shadow_offset_y<class_Label_theme_constant_shadow_offset_y>` | ``1`` |
  97. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  98. | :ref:`int<class_int>` | :ref:`shadow_outline_size<class_Label_theme_constant_shadow_outline_size>` | ``1`` |
  99. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  100. | :ref:`Font<class_Font>` | :ref:`font<class_Label_theme_font_font>` | |
  101. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  102. | :ref:`int<class_int>` | :ref:`font_size<class_Label_theme_font_size_font_size>` | |
  103. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  104. | :ref:`StyleBox<class_StyleBox>` | :ref:`normal<class_Label_theme_style_normal>` | |
  105. +---------------------------------+----------------------------------------------------------------------------+-----------------------+
  106. .. rst-class:: classref-section-separator
  107. ----
  108. .. rst-class:: classref-descriptions-group
  109. Property Descriptions
  110. ---------------------
  111. .. _class_Label_property_autowrap_mode:
  112. .. rst-class:: classref-property
  113. :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **autowrap_mode** = ``0``
  114. .. rst-class:: classref-property-setget
  115. - void **set_autowrap_mode** **(** :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` value **)**
  116. - :ref:`AutowrapMode<enum_TextServer_AutowrapMode>` **get_autowrap_mode** **(** **)**
  117. If set to something other than :ref:`TextServer.AUTOWRAP_OFF<class_TextServer_constant_AUTOWRAP_OFF>`, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. To see how each mode behaves, see :ref:`AutowrapMode<enum_TextServer_AutowrapMode>`.
  118. .. rst-class:: classref-item-separator
  119. ----
  120. .. _class_Label_property_clip_text:
  121. .. rst-class:: classref-property
  122. :ref:`bool<class_bool>` **clip_text** = ``false``
  123. .. rst-class:: classref-property-setget
  124. - void **set_clip_text** **(** :ref:`bool<class_bool>` value **)**
  125. - :ref:`bool<class_bool>` **is_clipping_text** **(** **)**
  126. If ``true``, the Label only shows the text that fits inside its bounding rectangle and will clip text horizontally.
  127. .. rst-class:: classref-item-separator
  128. ----
  129. .. _class_Label_property_horizontal_alignment:
  130. .. rst-class:: classref-property
  131. :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **horizontal_alignment** = ``0``
  132. .. rst-class:: classref-property-setget
  133. - void **set_horizontal_alignment** **(** :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` value **)**
  134. - :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` **get_horizontal_alignment** **(** **)**
  135. Controls the text's horizontal alignment. Supports left, center, right, and fill, or justify. Set it to one of the :ref:`HorizontalAlignment<enum_@GlobalScope_HorizontalAlignment>` constants.
  136. .. rst-class:: classref-item-separator
  137. ----
  138. .. _class_Label_property_label_settings:
  139. .. rst-class:: classref-property
  140. :ref:`LabelSettings<class_LabelSettings>` **label_settings**
  141. .. rst-class:: classref-property-setget
  142. - void **set_label_settings** **(** :ref:`LabelSettings<class_LabelSettings>` value **)**
  143. - :ref:`LabelSettings<class_LabelSettings>` **get_label_settings** **(** **)**
  144. A :ref:`LabelSettings<class_LabelSettings>` resource that can be shared between multiple **Label** nodes. Takes priority over theme properties.
  145. .. rst-class:: classref-item-separator
  146. ----
  147. .. _class_Label_property_language:
  148. .. rst-class:: classref-property
  149. :ref:`String<class_String>` **language** = ``""``
  150. .. rst-class:: classref-property-setget
  151. - void **set_language** **(** :ref:`String<class_String>` value **)**
  152. - :ref:`String<class_String>` **get_language** **(** **)**
  153. Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
  154. .. rst-class:: classref-item-separator
  155. ----
  156. .. _class_Label_property_lines_skipped:
  157. .. rst-class:: classref-property
  158. :ref:`int<class_int>` **lines_skipped** = ``0``
  159. .. rst-class:: classref-property-setget
  160. - void **set_lines_skipped** **(** :ref:`int<class_int>` value **)**
  161. - :ref:`int<class_int>` **get_lines_skipped** **(** **)**
  162. The node ignores the first ``lines_skipped`` lines before it starts to display text.
  163. .. rst-class:: classref-item-separator
  164. ----
  165. .. _class_Label_property_max_lines_visible:
  166. .. rst-class:: classref-property
  167. :ref:`int<class_int>` **max_lines_visible** = ``-1``
  168. .. rst-class:: classref-property-setget
  169. - void **set_max_lines_visible** **(** :ref:`int<class_int>` value **)**
  170. - :ref:`int<class_int>` **get_max_lines_visible** **(** **)**
  171. Limits the lines of text the node shows on screen.
  172. .. rst-class:: classref-item-separator
  173. ----
  174. .. _class_Label_property_structured_text_bidi_override:
  175. .. rst-class:: classref-property
  176. :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **structured_text_bidi_override** = ``0``
  177. .. rst-class:: classref-property-setget
  178. - void **set_structured_text_bidi_override** **(** :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` value **)**
  179. - :ref:`StructuredTextParser<enum_TextServer_StructuredTextParser>` **get_structured_text_bidi_override** **(** **)**
  180. Set BiDi algorithm override for the structured text.
  181. .. rst-class:: classref-item-separator
  182. ----
  183. .. _class_Label_property_structured_text_bidi_override_options:
  184. .. rst-class:: classref-property
  185. :ref:`Array<class_Array>` **structured_text_bidi_override_options** = ``[]``
  186. .. rst-class:: classref-property-setget
  187. - void **set_structured_text_bidi_override_options** **(** :ref:`Array<class_Array>` value **)**
  188. - :ref:`Array<class_Array>` **get_structured_text_bidi_override_options** **(** **)**
  189. Set additional options for BiDi override.
  190. .. rst-class:: classref-item-separator
  191. ----
  192. .. _class_Label_property_text:
  193. .. rst-class:: classref-property
  194. :ref:`String<class_String>` **text** = ``""``
  195. .. rst-class:: classref-property-setget
  196. - void **set_text** **(** :ref:`String<class_String>` value **)**
  197. - :ref:`String<class_String>` **get_text** **(** **)**
  198. The text to display on screen.
  199. .. rst-class:: classref-item-separator
  200. ----
  201. .. _class_Label_property_text_direction:
  202. .. rst-class:: classref-property
  203. :ref:`TextDirection<enum_Control_TextDirection>` **text_direction** = ``0``
  204. .. rst-class:: classref-property-setget
  205. - void **set_text_direction** **(** :ref:`TextDirection<enum_Control_TextDirection>` value **)**
  206. - :ref:`TextDirection<enum_Control_TextDirection>` **get_text_direction** **(** **)**
  207. Base text writing direction.
  208. .. rst-class:: classref-item-separator
  209. ----
  210. .. _class_Label_property_text_overrun_behavior:
  211. .. rst-class:: classref-property
  212. :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **text_overrun_behavior** = ``0``
  213. .. rst-class:: classref-property-setget
  214. - void **set_text_overrun_behavior** **(** :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` value **)**
  215. - :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` **get_text_overrun_behavior** **(** **)**
  216. Sets the clipping behavior when the text exceeds the node's bounding rectangle. See :ref:`OverrunBehavior<enum_TextServer_OverrunBehavior>` for a description of all modes.
  217. .. rst-class:: classref-item-separator
  218. ----
  219. .. _class_Label_property_uppercase:
  220. .. rst-class:: classref-property
  221. :ref:`bool<class_bool>` **uppercase** = ``false``
  222. .. rst-class:: classref-property-setget
  223. - void **set_uppercase** **(** :ref:`bool<class_bool>` value **)**
  224. - :ref:`bool<class_bool>` **is_uppercase** **(** **)**
  225. If ``true``, all the text displays as UPPERCASE.
  226. .. rst-class:: classref-item-separator
  227. ----
  228. .. _class_Label_property_vertical_alignment:
  229. .. rst-class:: classref-property
  230. :ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **vertical_alignment** = ``0``
  231. .. rst-class:: classref-property-setget
  232. - void **set_vertical_alignment** **(** :ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` value **)**
  233. - :ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` **get_vertical_alignment** **(** **)**
  234. Controls the text's vertical alignment. Supports top, center, bottom, and fill. Set it to one of the :ref:`VerticalAlignment<enum_@GlobalScope_VerticalAlignment>` constants.
  235. .. rst-class:: classref-item-separator
  236. ----
  237. .. _class_Label_property_visible_characters:
  238. .. rst-class:: classref-property
  239. :ref:`int<class_int>` **visible_characters** = ``-1``
  240. .. rst-class:: classref-property-setget
  241. - void **set_visible_characters** **(** :ref:`int<class_int>` value **)**
  242. - :ref:`int<class_int>` **get_visible_characters** **(** **)**
  243. The number of characters to display. If set to ``-1``, all characters are displayed. This can be useful when animating the text appearing in a dialog box.
  244. \ **Note:** Setting this property updates :ref:`visible_ratio<class_Label_property_visible_ratio>` accordingly.
  245. .. rst-class:: classref-item-separator
  246. ----
  247. .. _class_Label_property_visible_characters_behavior:
  248. .. rst-class:: classref-property
  249. :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **visible_characters_behavior** = ``0``
  250. .. rst-class:: classref-property-setget
  251. - void **set_visible_characters_behavior** **(** :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` value **)**
  252. - :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` **get_visible_characters_behavior** **(** **)**
  253. Sets the clipping behavior when :ref:`visible_characters<class_Label_property_visible_characters>` or :ref:`visible_ratio<class_Label_property_visible_ratio>` is set. See :ref:`VisibleCharactersBehavior<enum_TextServer_VisibleCharactersBehavior>` for more info.
  254. .. rst-class:: classref-item-separator
  255. ----
  256. .. _class_Label_property_visible_ratio:
  257. .. rst-class:: classref-property
  258. :ref:`float<class_float>` **visible_ratio** = ``1.0``
  259. .. rst-class:: classref-property-setget
  260. - void **set_visible_ratio** **(** :ref:`float<class_float>` value **)**
  261. - :ref:`float<class_float>` **get_visible_ratio** **(** **)**
  262. The fraction of characters to display, relative to the total number of characters (see :ref:`get_total_character_count<class_Label_method_get_total_character_count>`). If set to ``1.0``, all characters are displayed. If set to ``0.5``, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box.
  263. \ **Note:** Setting this property updates :ref:`visible_characters<class_Label_property_visible_characters>` accordingly.
  264. .. rst-class:: classref-section-separator
  265. ----
  266. .. rst-class:: classref-descriptions-group
  267. Method Descriptions
  268. -------------------
  269. .. _class_Label_method_get_line_count:
  270. .. rst-class:: classref-method
  271. :ref:`int<class_int>` **get_line_count** **(** **)** |const|
  272. Returns the number of lines of text the Label has.
  273. .. rst-class:: classref-item-separator
  274. ----
  275. .. _class_Label_method_get_line_height:
  276. .. rst-class:: classref-method
  277. :ref:`int<class_int>` **get_line_height** **(** :ref:`int<class_int>` line=-1 **)** |const|
  278. Returns the height of the line ``line``.
  279. If ``line`` is set to ``-1``, returns the biggest line height.
  280. If there are no lines, returns font size in pixels.
  281. .. rst-class:: classref-item-separator
  282. ----
  283. .. _class_Label_method_get_total_character_count:
  284. .. rst-class:: classref-method
  285. :ref:`int<class_int>` **get_total_character_count** **(** **)** |const|
  286. Returns the total number of printable characters in the text (excluding spaces and newlines).
  287. .. rst-class:: classref-item-separator
  288. ----
  289. .. _class_Label_method_get_visible_line_count:
  290. .. rst-class:: classref-method
  291. :ref:`int<class_int>` **get_visible_line_count** **(** **)** |const|
  292. Returns the number of lines shown. Useful if the **Label**'s height cannot currently display all lines.
  293. .. rst-class:: classref-section-separator
  294. ----
  295. .. rst-class:: classref-descriptions-group
  296. Theme Property Descriptions
  297. ---------------------------
  298. .. _class_Label_theme_color_font_color:
  299. .. rst-class:: classref-themeproperty
  300. :ref:`Color<class_Color>` **font_color** = ``Color(1, 1, 1, 1)``
  301. Default text :ref:`Color<class_Color>` of the **Label**.
  302. .. rst-class:: classref-item-separator
  303. ----
  304. .. _class_Label_theme_color_font_outline_color:
  305. .. rst-class:: classref-themeproperty
  306. :ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)``
  307. The color of text outline.
  308. .. rst-class:: classref-item-separator
  309. ----
  310. .. _class_Label_theme_color_font_shadow_color:
  311. .. rst-class:: classref-themeproperty
  312. :ref:`Color<class_Color>` **font_shadow_color** = ``Color(0, 0, 0, 0)``
  313. :ref:`Color<class_Color>` of the text's shadow effect.
  314. .. rst-class:: classref-item-separator
  315. ----
  316. .. _class_Label_theme_constant_line_spacing:
  317. .. rst-class:: classref-themeproperty
  318. :ref:`int<class_int>` **line_spacing** = ``3``
  319. Vertical space between lines in multiline **Label**.
  320. .. rst-class:: classref-item-separator
  321. ----
  322. .. _class_Label_theme_constant_outline_size:
  323. .. rst-class:: classref-themeproperty
  324. :ref:`int<class_int>` **outline_size** = ``0``
  325. Text outline size.
  326. \ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` enabled, its :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the value of :ref:`outline_size<class_Label_theme_constant_outline_size>` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
  327. .. rst-class:: classref-item-separator
  328. ----
  329. .. _class_Label_theme_constant_shadow_offset_x:
  330. .. rst-class:: classref-themeproperty
  331. :ref:`int<class_int>` **shadow_offset_x** = ``1``
  332. The horizontal offset of the text's shadow.
  333. .. rst-class:: classref-item-separator
  334. ----
  335. .. _class_Label_theme_constant_shadow_offset_y:
  336. .. rst-class:: classref-themeproperty
  337. :ref:`int<class_int>` **shadow_offset_y** = ``1``
  338. The vertical offset of the text's shadow.
  339. .. rst-class:: classref-item-separator
  340. ----
  341. .. _class_Label_theme_constant_shadow_outline_size:
  342. .. rst-class:: classref-themeproperty
  343. :ref:`int<class_int>` **shadow_outline_size** = ``1``
  344. The size of the shadow outline.
  345. .. rst-class:: classref-item-separator
  346. ----
  347. .. _class_Label_theme_font_font:
  348. .. rst-class:: classref-themeproperty
  349. :ref:`Font<class_Font>` **font**
  350. :ref:`Font<class_Font>` used for the **Label**'s text.
  351. .. rst-class:: classref-item-separator
  352. ----
  353. .. _class_Label_theme_font_size_font_size:
  354. .. rst-class:: classref-themeproperty
  355. :ref:`int<class_int>` **font_size**
  356. Font size of the **Label**'s text.
  357. .. rst-class:: classref-item-separator
  358. ----
  359. .. _class_Label_theme_style_normal:
  360. .. rst-class:: classref-themeproperty
  361. :ref:`StyleBox<class_StyleBox>` **normal**
  362. Background :ref:`StyleBox<class_StyleBox>` for the **Label**.
  363. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  364. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  365. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
  366. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
  367. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
  368. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`