class_progressbar.rst 2.0 KB

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