Files
godot-docs/classes/class_progressbar.rst
2019-07-29 21:15:14 +02:00

63 lines
2.0 KiB
ReStructuredText

:github_url: hide
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the ProgressBar.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.
.. _class_ProgressBar:
ProgressBar
===========
**Inherits:** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
-----------------
General purpose progress bar.
Properties
----------
+-------------------------+--------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`percent_visible<class_ProgressBar_property_percent_visible>` |
+-------------------------+--------------------------------------------------------------------+
Theme Properties
----------------
+---------------------------------+-------------------+
| :ref:`StyleBox<class_StyleBox>` | bg |
+---------------------------------+-------------------+
| :ref:`StyleBox<class_StyleBox>` | fg |
+---------------------------------+-------------------+
| :ref:`Font<class_Font>` | font |
+---------------------------------+-------------------+
| :ref:`Color<class_Color>` | font_color |
+---------------------------------+-------------------+
| :ref:`Color<class_Color>` | font_color_shadow |
+---------------------------------+-------------------+
Description
-----------
General purpose progress bar. Shows fill percentage from right to left.
Property Descriptions
---------------------
.. _class_ProgressBar_property_percent_visible:
- :ref:`bool<class_bool>` **percent_visible**
+----------+----------------------------+
| *Setter* | set_percent_visible(value) |
+----------+----------------------------+
| *Getter* | is_percent_visible() |
+----------+----------------------------+
If ``true``, the fill percentage is displayed on the bar. Default value: ``true``.