Home Verkennen Help
Inloggen
Godot
/
godot-docs
spiegel van https://github.com/godotengine/godot-docs.git
2
0
Vork 0
Bestanden Issues 0 Wiki
Boom: ace47f729c
Aftakkingen Labels
godot-docs
/
classes
/
class_textureprogress.rst

class_textureprogress.rst 13 KB
Geschiedenis Ruwe

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176 
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
    2. 

  2. .. DO NOT EDIT THIS FILE, but the TextureProgress.xml source instead.
    3. 

  3. .. The source is found in doc/classes or modules/<name>/doc_classes.
    4. 

  4. 

  5. .. _class_TextureProgress:
    6. 

  6. 

  7. TextureProgress
    8. 

  8. ===============
    9. 

  9. 

  10. **Inherits:** :ref:`Range<class_range>` **<** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
    11. 

  11. 

  12. **Category:** Core
    13. 

  13. 

  14. Brief Description
    15. 

  15. -----------------
    16. 

  16. 

  17. Texture-based progress bar. Useful for loading screens and life or stamina bars.
    18. 

  18. 

  19. Member Functions
    20. 

  20. ----------------
    21. 

  21. 

  22. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    23. 

  23. | :ref:`float<class_float>`      | :ref:`get_fill_degrees<class_TextureProgress_get_fill_degrees>`  **(** **)**                                                                |
    24. 

  24. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    25. 

  25. | :ref:`int<class_int>`          | :ref:`get_fill_mode<class_TextureProgress_get_fill_mode>`  **(** **)**                                                                      |
    26. 

  26. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    27. 

  27. | :ref:`bool<class_bool>`        | :ref:`get_nine_patch_stretch<class_TextureProgress_get_nine_patch_stretch>`  **(** **)** const                                              |
    28. 

  28. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    29. 

  29. | :ref:`Texture<class_texture>`  | :ref:`get_over_texture<class_TextureProgress_get_over_texture>`  **(** **)** const                                                          |
    30. 

  30. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    31. 

  31. | :ref:`Texture<class_texture>`  | :ref:`get_progress_texture<class_TextureProgress_get_progress_texture>`  **(** **)** const                                                  |
    32. 

  32. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    33. 

  33. | :ref:`Vector2<class_vector2>`  | :ref:`get_radial_center_offset<class_TextureProgress_get_radial_center_offset>`  **(** **)**                                                |
    34. 

  34. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    35. 

  35. | :ref:`float<class_float>`      | :ref:`get_radial_initial_angle<class_TextureProgress_get_radial_initial_angle>`  **(** **)**                                                |
    36. 

  36. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    37. 

  37. | :ref:`int<class_int>`          | :ref:`get_stretch_margin<class_TextureProgress_get_stretch_margin>`  **(** :ref:`int<class_int>` margin  **)** const                        |
    38. 

  38. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39. | :ref:`Texture<class_texture>`  | :ref:`get_under_texture<class_TextureProgress_get_under_texture>`  **(** **)** const                                                        |
    40. 

  40. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41. | void                           | :ref:`set_fill_degrees<class_TextureProgress_set_fill_degrees>`  **(** :ref:`float<class_float>` mode  **)**                                |
    42. 

  42. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43. | void                           | :ref:`set_fill_mode<class_TextureProgress_set_fill_mode>`  **(** :ref:`int<class_int>` mode  **)**                                          |
    44. 

  44. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45. | void                           | :ref:`set_nine_patch_stretch<class_TextureProgress_set_nine_patch_stretch>`  **(** :ref:`bool<class_bool>` stretch  **)**                   |
    46. 

  46. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47. | void                           | :ref:`set_over_texture<class_TextureProgress_set_over_texture>`  **(** :ref:`Texture<class_texture>` tex  **)**                             |
    48. 

  48. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49. | void                           | :ref:`set_progress_texture<class_TextureProgress_set_progress_texture>`  **(** :ref:`Texture<class_texture>` tex  **)**                     |
    50. 

  50. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51. | void                           | :ref:`set_radial_center_offset<class_TextureProgress_set_radial_center_offset>`  **(** :ref:`Vector2<class_vector2>` mode  **)**            |
    52. 

  52. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53. | void                           | :ref:`set_radial_initial_angle<class_TextureProgress_set_radial_initial_angle>`  **(** :ref:`float<class_float>` mode  **)**                |
    54. 

  54. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. | void                           | :ref:`set_stretch_margin<class_TextureProgress_set_stretch_margin>`  **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` value  **)** |
    56. 

  56. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    57. 

  57. | void                           | :ref:`set_under_texture<class_TextureProgress_set_under_texture>`  **(** :ref:`Texture<class_texture>` tex  **)**                           |
    58. 

  58. +--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
    59. 

  59. 

  60. Member Variables
    61. 

  61. ----------------
    62. 

  62. 

  63. - :ref:`int<class_int>` **fill_mode** - The fill direction. Uses FILL_* constants.
    64. 

  64. - :ref:`bool<class_bool>` **nine_patch_stretch** - If [code]true[/code] Godot treats the bar's textures like [NinePatchRect]. Use [code]stretch_margin_*[/code], like [member stretch_margin_bottom], to set up the nine patch's 3x3 grid. Default value: [code]false[/code].
    65. 

  65. - :ref:`Vector2<class_vector2>` **radial_center_offset** - Offsets [member texture_progress] if [member fill_mode] is [code]FILL_CLOCKWISE[/code] or [code]FILL_COUNTER_CLOCKWISE[/code].
    66. 

  66. - :ref:`float<class_float>` **radial_fill_degrees** - Upper limit for the fill of [member texture_progress] if [member fill_mode] is [code]FILL_CLOCKWISE[/code] or [code]FILL_COUNTER_CLOCKWISE[/code]. When the node's [code]value[/code] is equal to its [code]max_value[/code], the texture fills up to this angle.
    67. 

  67. 			See [member Range.value], [member Range.max_value].
    68. 

  68. - :ref:`float<class_float>` **radial_initial_angle** - Starting angle for the fill of [member texture_progress] if [member fill_mode] is [code]FILL_CLOCKWISE[/code] or [code]FILL_COUNTER_CLOCKWISE[/code]. When the node's [code]value[/code] is equal to its [code]min_value[/code], the texture doesn't show up at all. When the [code]value[/code] increases, the texture fills and tends towards [member radial_fill_degrees].
    69. 

  69. - :ref:`int<class_int>` **stretch_margin_bottom** - 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.
    70. 

  70. - :ref:`int<class_int>` **stretch_margin_left** - The width of the 9-patch's left column.
    71. 

  71. - :ref:`int<class_int>` **stretch_margin_right** - The width of the 9-patch's right column.
    72. 

  72. - :ref:`int<class_int>` **stretch_margin_top** - The height of the 9-patch's top row.
    73. 

  73. - :ref:`Texture<class_texture>` **texture_over** - [Texture] that draws over the progress bar. Use it to add highlights or an upper-frame that hides part of [member texture_progress].
    74. 

  74. - :ref:`Texture<class_texture>` **texture_progress** - [Texture] that clips based on the node's [code]value[/code] and [member fill_mode]. As [code]value[/code] increased, the texture fills up. It shows entirely when [code]value[/code] reaches [code]max_value[/code]. It doesn't show at all if [code]value[/code] is equal to [code]min_value[/code].
    75. 

  75. 			The [code]value[/code] property comes from [Range]. See [member Range.value], [member Range.min_value], [member Range.max_value].
    76. 

  76. - :ref:`Texture<class_texture>` **texture_under** - [Texture] that draws under the progress bar. The bar's background.
    77. 

  77. 

  78. Numeric Constants
    79. 

  79. -----------------
    80. 

  80. 

  81. - **FILL_LEFT_TO_RIGHT** = **0** --- The member texture_progress fills from left to right.
    82. 

  82. - **FILL_RIGHT_TO_LEFT** = **1** --- The member texture_progress fills from right to left.
    83. 

  83. - **FILL_TOP_TO_BOTTOM** = **2** --- The member texture_progress fills from top to bototm.
    84. 

  84. - **FILL_BOTTOM_TO_TOP** = **3** --- The member texture_progress fills from bottom to top.
    85. 

  85. - **FILL_CLOCKWISE** = **4** --- Turns the node into a radial bar. The member texture_progress fills clockwise. See member radial_center_offset, member radial_initial_angle and member radial_fill_degrees to refine its behavior.
    86. 

  86. - **FILL_COUNTER_CLOCKWISE** = **5** --- Turns the node into a radial bar. The member texture_progress fills counter-clockwise. See member radial_center_offset, member radial_initial_angle and member radial_fill_degrees to refine its behavior.
    87. 

  87. 

  88. Description
    89. 

  89. -----------
    90. 

  90. 

  91. TextureProgress works like :ref:`ProgressBar<class_progressbar>` but it uses up to 3 textures instead of Godot's :ref:`Theme<class_theme>` resource. Works horizontally, vertically, and radially.
    92. 

  92. 

  93. Member Function Description
    94. 

  94. ---------------------------
    95. 

  95. 

  96. .. _class_TextureProgress_get_fill_degrees:
    97. 

  97. 

  98. - :ref:`float<class_float>`  **get_fill_degrees**  **(** **)**
    99. 

  99. 

  100. .. _class_TextureProgress_get_fill_mode:
    101. 

  101. 

  102. - :ref:`int<class_int>`  **get_fill_mode**  **(** **)**
    103. 

  103. 

  104. .. _class_TextureProgress_get_nine_patch_stretch:
    105. 

  105. 

  106. - :ref:`bool<class_bool>`  **get_nine_patch_stretch**  **(** **)** const
    107. 

  107. 

  108. Returns true if textures are stretched as nine-patches or false otherwise.
    109. 

  109. 

  110. .. _class_TextureProgress_get_over_texture:
    111. 

  111. 

  112. - :ref:`Texture<class_texture>`  **get_over_texture**  **(** **)** const
    113. 

  113. 

  114. .. _class_TextureProgress_get_progress_texture:
    115. 

  115. 

  116. - :ref:`Texture<class_texture>`  **get_progress_texture**  **(** **)** const
    117. 

  117. 

  118. .. _class_TextureProgress_get_radial_center_offset:
    119. 

  119. 

  120. - :ref:`Vector2<class_vector2>`  **get_radial_center_offset**  **(** **)**
    121. 

  121. 

  122. .. _class_TextureProgress_get_radial_initial_angle:
    123. 

  123. 

  124. - :ref:`float<class_float>`  **get_radial_initial_angle**  **(** **)**
    125. 

  125. 

  126. .. _class_TextureProgress_get_stretch_margin:
    127. 

  127. 

  128. - :ref:`int<class_int>`  **get_stretch_margin**  **(** :ref:`int<class_int>` margin  **)** const
    129. 

  129. 

  130. Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
    131. 

  131. 

  132. .. _class_TextureProgress_get_under_texture:
    133. 

  133. 

  134. - :ref:`Texture<class_texture>`  **get_under_texture**  **(** **)** const
    135. 

  135. 

  136. .. _class_TextureProgress_set_fill_degrees:
    137. 

  137. 

  138. - void  **set_fill_degrees**  **(** :ref:`float<class_float>` mode  **)**
    139. 

  139. 

  140. .. _class_TextureProgress_set_fill_mode:
    141. 

  141. 

  142. - void  **set_fill_mode**  **(** :ref:`int<class_int>` mode  **)**
    143. 

  143. 

  144. .. _class_TextureProgress_set_nine_patch_stretch:
    145. 

  145. 

  146. - void  **set_nine_patch_stretch**  **(** :ref:`bool<class_bool>` stretch  **)**
    147. 

  147. 

  148. Set if textures should be stretched as nine-patches.
    149. 

  149. 

  150. .. _class_TextureProgress_set_over_texture:
    151. 

  151. 

  152. - void  **set_over_texture**  **(** :ref:`Texture<class_texture>` tex  **)**
    153. 

  153. 

  154. .. _class_TextureProgress_set_progress_texture:
    155. 

  155. 

  156. - void  **set_progress_texture**  **(** :ref:`Texture<class_texture>` tex  **)**
    157. 

  157. 

  158. .. _class_TextureProgress_set_radial_center_offset:
    159. 

  159. 

  160. - void  **set_radial_center_offset**  **(** :ref:`Vector2<class_vector2>` mode  **)**
    161. 

  161. 

  162. .. _class_TextureProgress_set_radial_initial_angle:
    163. 

  163. 

  164. - void  **set_radial_initial_angle**  **(** :ref:`float<class_float>` mode  **)**
    165. 

  165. 

  166. .. _class_TextureProgress_set_stretch_margin:
    167. 

  167. 

  168. - void  **set_stretch_margin**  **(** :ref:`int<class_int>` margin, :ref:`int<class_int>` value  **)**
    169. 

  169. 

  170. Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
    171. 

  171. 

  172. .. _class_TextureProgress_set_under_texture:
    173. 

  173. 

  174. - void  **set_under_texture**  **(** :ref:`Texture<class_texture>` tex  **)**
    175. 

  175. 

  176.