class_progressbar.rst 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  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 ProgressBar.xml source instead.
  4. .. The source is found in doc/classes or modules/<name>/doc_classes.
  5. .. _class_ProgressBar:
  6. ProgressBar
  7. ===========
  8. **Inherits:** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
  9. **Category:** Core
  10. Brief Description
  11. -----------------
  12. General-purpose progress bar.
  13. Properties
  14. ----------
  15. +-------------------------+--------------------------------------------------------------------+------+
  16. | :ref:`bool<class_bool>` | :ref:`percent_visible<class_ProgressBar_property_percent_visible>` | true |
  17. +-------------------------+--------------------------------------------------------------------+------+
  18. Theme Properties
  19. ----------------
  20. +---------------------------------+-------------------+------------------------------+
  21. | :ref:`StyleBox<class_StyleBox>` | bg | |
  22. +---------------------------------+-------------------+------------------------------+
  23. | :ref:`StyleBox<class_StyleBox>` | fg | |
  24. +---------------------------------+-------------------+------------------------------+
  25. | :ref:`Font<class_Font>` | font | |
  26. +---------------------------------+-------------------+------------------------------+
  27. | :ref:`Color<class_Color>` | font_color | Color( 0.94, 0.94, 0.94, 1 ) |
  28. +---------------------------------+-------------------+------------------------------+
  29. | :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 1 ) |
  30. +---------------------------------+-------------------+------------------------------+
  31. Description
  32. -----------
  33. General-purpose progress bar. Shows fill percentage from right to left.
  34. Property Descriptions
  35. ---------------------
  36. .. _class_ProgressBar_property_percent_visible:
  37. - :ref:`bool<class_bool>` **percent_visible**
  38. +-----------+----------------------------+
  39. | *Default* | true |
  40. +-----------+----------------------------+
  41. | *Setter* | set_percent_visible(value) |
  42. +-----------+----------------------------+
  43. | *Getter* | is_percent_visible() |
  44. +-----------+----------------------------+
  45. If ``true``, the fill percentage is displayed on the bar.