class_progressbar.rst 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  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>` | true |
  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 | Color( 0.94, 0.94, 0.94, 1 ) |
  27. +---------------------------------+-------------------+------------------------------+
  28. | :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 1 ) |
  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. | *Default* | true |
  39. +-----------+----------------------------+
  40. | *Setter* | set_percent_visible(value) |
  41. +-----------+----------------------------+
  42. | *Getter* | is_percent_visible() |
  43. +-----------+----------------------------+
  44. If ``true``, the fill percentage is displayed on the bar.