class_textureprogress.rst 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365
  1. :github_url: hide
  2. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  3. .. DO NOT EDIT THIS FILE, but the TextureProgress.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_TextureProgress:
  6. TextureProgress
  7. ===============
  8. **Inherits:** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. Texture-based progress bar. Useful for loading screens and life or stamina bars.
  10. Description
  11. -----------
  12. TextureProgress works like :ref:`ProgressBar<class_ProgressBar>`, but uses up to 3 textures instead of Godot's :ref:`Theme<class_Theme>` resource. It can be used to create horizontal, vertical and radial progress bars.
  13. Properties
  14. ----------
  15. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  16. | :ref:`int<class_int>` | :ref:`fill_mode<class_TextureProgress_property_fill_mode>` | ``0`` |
  17. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  18. | :ref:`MouseFilter<enum_Control_MouseFilter>` | mouse_filter | ``1`` *(parent override)* |
  19. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  20. | :ref:`bool<class_bool>` | :ref:`nine_patch_stretch<class_TextureProgress_property_nine_patch_stretch>` | ``false`` |
  21. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  22. | :ref:`Vector2<class_Vector2>` | :ref:`radial_center_offset<class_TextureProgress_property_radial_center_offset>` | ``Vector2( 0, 0 )`` |
  23. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  24. | :ref:`float<class_float>` | :ref:`radial_fill_degrees<class_TextureProgress_property_radial_fill_degrees>` | ``360.0`` |
  25. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  26. | :ref:`float<class_float>` | :ref:`radial_initial_angle<class_TextureProgress_property_radial_initial_angle>` | ``0.0`` |
  27. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  28. | :ref:`int<class_int>` | :ref:`stretch_margin_bottom<class_TextureProgress_property_stretch_margin_bottom>` | ``0`` |
  29. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  30. | :ref:`int<class_int>` | :ref:`stretch_margin_left<class_TextureProgress_property_stretch_margin_left>` | ``0`` |
  31. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  32. | :ref:`int<class_int>` | :ref:`stretch_margin_right<class_TextureProgress_property_stretch_margin_right>` | ``0`` |
  33. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  34. | :ref:`int<class_int>` | :ref:`stretch_margin_top<class_TextureProgress_property_stretch_margin_top>` | ``0`` |
  35. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  36. | :ref:`Texture<class_Texture>` | :ref:`texture_over<class_TextureProgress_property_texture_over>` | |
  37. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  38. | :ref:`Texture<class_Texture>` | :ref:`texture_progress<class_TextureProgress_property_texture_progress>` | |
  39. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  40. | :ref:`Texture<class_Texture>` | :ref:`texture_under<class_TextureProgress_property_texture_under>` | |
  41. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  42. | :ref:`Color<class_Color>` | :ref:`tint_over<class_TextureProgress_property_tint_over>` | ``Color( 1, 1, 1, 1 )`` |
  43. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  44. | :ref:`Color<class_Color>` | :ref:`tint_progress<class_TextureProgress_property_tint_progress>` | ``Color( 1, 1, 1, 1 )`` |
  45. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  46. | :ref:`Color<class_Color>` | :ref:`tint_under<class_TextureProgress_property_tint_under>` | ``Color( 1, 1, 1, 1 )`` |
  47. +----------------------------------------------+------------------------------------------------------------------------------------+---------------------------+
  48. Methods
  49. -------
  50. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  51. | :ref:`int<class_int>` | :ref:`get_stretch_margin<class_TextureProgress_method_get_stretch_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** |const| |
  52. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  53. | void | :ref:`set_stretch_margin<class_TextureProgress_method_set_stretch_margin>` **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` value **)** |
  54. +-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
  55. Enumerations
  56. ------------
  57. .. _enum_TextureProgress_FillMode:
  58. .. _class_TextureProgress_constant_FILL_LEFT_TO_RIGHT:
  59. .. _class_TextureProgress_constant_FILL_RIGHT_TO_LEFT:
  60. .. _class_TextureProgress_constant_FILL_TOP_TO_BOTTOM:
  61. .. _class_TextureProgress_constant_FILL_BOTTOM_TO_TOP:
  62. .. _class_TextureProgress_constant_FILL_CLOCKWISE:
  63. .. _class_TextureProgress_constant_FILL_COUNTER_CLOCKWISE:
  64. .. _class_TextureProgress_constant_FILL_BILINEAR_LEFT_AND_RIGHT:
  65. .. _class_TextureProgress_constant_FILL_BILINEAR_TOP_AND_BOTTOM:
  66. .. _class_TextureProgress_constant_FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE:
  67. enum **FillMode**:
  68. - **FILL_LEFT_TO_RIGHT** = **0** --- The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills from left to right.
  69. - **FILL_RIGHT_TO_LEFT** = **1** --- The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills from right to left.
  70. - **FILL_TOP_TO_BOTTOM** = **2** --- The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills from top to bottom.
  71. - **FILL_BOTTOM_TO_TOP** = **3** --- The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills from bottom to top.
  72. - **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills clockwise. See :ref:`radial_center_offset<class_TextureProgress_property_radial_center_offset>`, :ref:`radial_initial_angle<class_TextureProgress_property_radial_initial_angle>` and :ref:`radial_fill_degrees<class_TextureProgress_property_radial_fill_degrees>` to control the way the bar fills up.
  73. - **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills counterclockwise. See :ref:`radial_center_offset<class_TextureProgress_property_radial_center_offset>`, :ref:`radial_initial_angle<class_TextureProgress_property_radial_initial_angle>` and :ref:`radial_fill_degrees<class_TextureProgress_property_radial_fill_degrees>` to control the way the bar fills up.
  74. - **FILL_BILINEAR_LEFT_AND_RIGHT** = **6** --- The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills from the center, expanding both towards the left and the right.
  75. - **FILL_BILINEAR_TOP_AND_BOTTOM** = **7** --- The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills from the center, expanding both towards the top and the bottom.
  76. - **FILL_CLOCKWISE_AND_COUNTER_CLOCKWISE** = **8** --- Turns the node into a radial bar. The :ref:`texture_progress<class_TextureProgress_property_texture_progress>` fills radially from the center, expanding both clockwise and counterclockwise. See :ref:`radial_center_offset<class_TextureProgress_property_radial_center_offset>`, :ref:`radial_initial_angle<class_TextureProgress_property_radial_initial_angle>` and :ref:`radial_fill_degrees<class_TextureProgress_property_radial_fill_degrees>` to control the way the bar fills up.
  77. Property Descriptions
  78. ---------------------
  79. .. _class_TextureProgress_property_fill_mode:
  80. - :ref:`int<class_int>` **fill_mode**
  81. +-----------+----------------------+
  82. | *Default* | ``0`` |
  83. +-----------+----------------------+
  84. | *Setter* | set_fill_mode(value) |
  85. +-----------+----------------------+
  86. | *Getter* | get_fill_mode() |
  87. +-----------+----------------------+
  88. The fill direction. See :ref:`FillMode<enum_TextureProgress_FillMode>` for possible values.
  89. ----
  90. .. _class_TextureProgress_property_nine_patch_stretch:
  91. - :ref:`bool<class_bool>` **nine_patch_stretch**
  92. +-----------+-------------------------------+
  93. | *Default* | ``false`` |
  94. +-----------+-------------------------------+
  95. | *Setter* | set_nine_patch_stretch(value) |
  96. +-----------+-------------------------------+
  97. | *Getter* | get_nine_patch_stretch() |
  98. +-----------+-------------------------------+
  99. If ``true``, Godot treats the bar's textures like in :ref:`NinePatchRect<class_NinePatchRect>`. Use the ``stretch_margin_*`` properties like :ref:`stretch_margin_bottom<class_TextureProgress_property_stretch_margin_bottom>` to set up the nine patch's 3×3 grid. When using a radial :ref:`fill_mode<class_TextureProgress_property_fill_mode>`, this setting will enable stretching.
  100. ----
  101. .. _class_TextureProgress_property_radial_center_offset:
  102. - :ref:`Vector2<class_Vector2>` **radial_center_offset**
  103. +-----------+---------------------------------+
  104. | *Default* | ``Vector2( 0, 0 )`` |
  105. +-----------+---------------------------------+
  106. | *Setter* | set_radial_center_offset(value) |
  107. +-----------+---------------------------------+
  108. | *Getter* | get_radial_center_offset() |
  109. +-----------+---------------------------------+
  110. Offsets :ref:`texture_progress<class_TextureProgress_property_texture_progress>` if :ref:`fill_mode<class_TextureProgress_property_fill_mode>` is :ref:`FILL_CLOCKWISE<class_TextureProgress_constant_FILL_CLOCKWISE>` or :ref:`FILL_COUNTER_CLOCKWISE<class_TextureProgress_constant_FILL_COUNTER_CLOCKWISE>`.
  111. ----
  112. .. _class_TextureProgress_property_radial_fill_degrees:
  113. - :ref:`float<class_float>` **radial_fill_degrees**
  114. +-----------+-------------------------+
  115. | *Default* | ``360.0`` |
  116. +-----------+-------------------------+
  117. | *Setter* | set_fill_degrees(value) |
  118. +-----------+-------------------------+
  119. | *Getter* | get_fill_degrees() |
  120. +-----------+-------------------------+
  121. Upper limit for the fill of :ref:`texture_progress<class_TextureProgress_property_texture_progress>` if :ref:`fill_mode<class_TextureProgress_property_fill_mode>` is :ref:`FILL_CLOCKWISE<class_TextureProgress_constant_FILL_CLOCKWISE>` or :ref:`FILL_COUNTER_CLOCKWISE<class_TextureProgress_constant_FILL_COUNTER_CLOCKWISE>`. When the node's ``value`` is equal to its ``max_value``, the texture fills up to this angle.
  122. See :ref:`Range.value<class_Range_property_value>`, :ref:`Range.max_value<class_Range_property_max_value>`.
  123. ----
  124. .. _class_TextureProgress_property_radial_initial_angle:
  125. - :ref:`float<class_float>` **radial_initial_angle**
  126. +-----------+---------------------------------+
  127. | *Default* | ``0.0`` |
  128. +-----------+---------------------------------+
  129. | *Setter* | set_radial_initial_angle(value) |
  130. +-----------+---------------------------------+
  131. | *Getter* | get_radial_initial_angle() |
  132. +-----------+---------------------------------+
  133. Starting angle for the fill of :ref:`texture_progress<class_TextureProgress_property_texture_progress>` if :ref:`fill_mode<class_TextureProgress_property_fill_mode>` is :ref:`FILL_CLOCKWISE<class_TextureProgress_constant_FILL_CLOCKWISE>` or :ref:`FILL_COUNTER_CLOCKWISE<class_TextureProgress_constant_FILL_COUNTER_CLOCKWISE>`. When the node's ``value`` is equal to its ``min_value``, the texture doesn't show up at all. When the ``value`` increases, the texture fills and tends towards :ref:`radial_fill_degrees<class_TextureProgress_property_radial_fill_degrees>`.
  134. ----
  135. .. _class_TextureProgress_property_stretch_margin_bottom:
  136. - :ref:`int<class_int>` **stretch_margin_bottom**
  137. +-----------+---------------------------+
  138. | *Default* | ``0`` |
  139. +-----------+---------------------------+
  140. | *Setter* | set_stretch_margin(value) |
  141. +-----------+---------------------------+
  142. | *Getter* | get_stretch_margin() |
  143. +-----------+---------------------------+
  144. The height of the 9-patch's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders.
  145. ----
  146. .. _class_TextureProgress_property_stretch_margin_left:
  147. - :ref:`int<class_int>` **stretch_margin_left**
  148. +-----------+---------------------------+
  149. | *Default* | ``0`` |
  150. +-----------+---------------------------+
  151. | *Setter* | set_stretch_margin(value) |
  152. +-----------+---------------------------+
  153. | *Getter* | get_stretch_margin() |
  154. +-----------+---------------------------+
  155. The width of the 9-patch's left column.
  156. ----
  157. .. _class_TextureProgress_property_stretch_margin_right:
  158. - :ref:`int<class_int>` **stretch_margin_right**
  159. +-----------+---------------------------+
  160. | *Default* | ``0`` |
  161. +-----------+---------------------------+
  162. | *Setter* | set_stretch_margin(value) |
  163. +-----------+---------------------------+
  164. | *Getter* | get_stretch_margin() |
  165. +-----------+---------------------------+
  166. The width of the 9-patch's right column.
  167. ----
  168. .. _class_TextureProgress_property_stretch_margin_top:
  169. - :ref:`int<class_int>` **stretch_margin_top**
  170. +-----------+---------------------------+
  171. | *Default* | ``0`` |
  172. +-----------+---------------------------+
  173. | *Setter* | set_stretch_margin(value) |
  174. +-----------+---------------------------+
  175. | *Getter* | get_stretch_margin() |
  176. +-----------+---------------------------+
  177. The height of the 9-patch's top row.
  178. ----
  179. .. _class_TextureProgress_property_texture_over:
  180. - :ref:`Texture<class_Texture>` **texture_over**
  181. +----------+-------------------------+
  182. | *Setter* | set_over_texture(value) |
  183. +----------+-------------------------+
  184. | *Getter* | get_over_texture() |
  185. +----------+-------------------------+
  186. :ref:`Texture<class_Texture>` that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of :ref:`texture_progress<class_TextureProgress_property_texture_progress>`.
  187. ----
  188. .. _class_TextureProgress_property_texture_progress:
  189. - :ref:`Texture<class_Texture>` **texture_progress**
  190. +----------+-----------------------------+
  191. | *Setter* | set_progress_texture(value) |
  192. +----------+-----------------------------+
  193. | *Getter* | get_progress_texture() |
  194. +----------+-----------------------------+
  195. :ref:`Texture<class_Texture>` that clips based on the node's ``value`` and :ref:`fill_mode<class_TextureProgress_property_fill_mode>`. As ``value`` increased, the texture fills up. It shows entirely when ``value`` reaches ``max_value``. It doesn't show at all if ``value`` is equal to ``min_value``.
  196. The ``value`` property comes from :ref:`Range<class_Range>`. See :ref:`Range.value<class_Range_property_value>`, :ref:`Range.min_value<class_Range_property_min_value>`, :ref:`Range.max_value<class_Range_property_max_value>`.
  197. ----
  198. .. _class_TextureProgress_property_texture_under:
  199. - :ref:`Texture<class_Texture>` **texture_under**
  200. +----------+--------------------------+
  201. | *Setter* | set_under_texture(value) |
  202. +----------+--------------------------+
  203. | *Getter* | get_under_texture() |
  204. +----------+--------------------------+
  205. :ref:`Texture<class_Texture>` that draws under the progress bar. The bar's background.
  206. ----
  207. .. _class_TextureProgress_property_tint_over:
  208. - :ref:`Color<class_Color>` **tint_over**
  209. +-----------+-------------------------+
  210. | *Default* | ``Color( 1, 1, 1, 1 )`` |
  211. +-----------+-------------------------+
  212. | *Setter* | set_tint_over(value) |
  213. +-----------+-------------------------+
  214. | *Getter* | get_tint_over() |
  215. +-----------+-------------------------+
  216. Multiplies the color of the bar's ``texture_over`` texture. The effect is similar to :ref:`CanvasItem.modulate<class_CanvasItem_property_modulate>`, except it only affects this specific texture instead of the entire node.
  217. ----
  218. .. _class_TextureProgress_property_tint_progress:
  219. - :ref:`Color<class_Color>` **tint_progress**
  220. +-----------+--------------------------+
  221. | *Default* | ``Color( 1, 1, 1, 1 )`` |
  222. +-----------+--------------------------+
  223. | *Setter* | set_tint_progress(value) |
  224. +-----------+--------------------------+
  225. | *Getter* | get_tint_progress() |
  226. +-----------+--------------------------+
  227. Multiplies the color of the bar's ``texture_progress`` texture.
  228. ----
  229. .. _class_TextureProgress_property_tint_under:
  230. - :ref:`Color<class_Color>` **tint_under**
  231. +-----------+-------------------------+
  232. | *Default* | ``Color( 1, 1, 1, 1 )`` |
  233. +-----------+-------------------------+
  234. | *Setter* | set_tint_under(value) |
  235. +-----------+-------------------------+
  236. | *Getter* | get_tint_under() |
  237. +-----------+-------------------------+
  238. Multiplies the color of the bar's ``texture_under`` texture.
  239. Method Descriptions
  240. -------------------
  241. .. _class_TextureProgress_method_get_stretch_margin:
  242. - :ref:`int<class_int>` **get_stretch_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin **)** |const|
  243. ----
  244. .. _class_TextureProgress_method_set_stretch_margin:
  245. - void **set_stretch_margin** **(** :ref:`Margin<enum_@GlobalScope_Margin>` margin, :ref:`int<class_int>` value **)**
  246. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
  247. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
  248. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`