Files
godot-docs/classes/class_progressbar.rst
Rémi Verschelde 782dd64a19 classref: Use code markup for default values/overrides
Sync with godotengine/godot#35357.
Fixes #3071.
2020-01-20 12:41:39 +01:00

64 lines
2.9 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>`
General-purpose progress bar.
Description
-----------
General-purpose progress bar. Shows fill percentage from right to left.
Properties
----------
+---------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`bool<class_bool>` | :ref:`percent_visible<class_ProgressBar_property_percent_visible>` | ``true`` |
+---------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`int<class_int>` | size_flags_vertical | **O:** ``0`` |
+---------------------------+--------------------------------------------------------------------+-----------------+
| :ref:`float<class_float>` | step | **O:** ``0.01`` |
+---------------------------+--------------------------------------------------------------------+-----------------+
Theme Properties
----------------
+---------------------------------+-------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | bg | |
+---------------------------------+-------------------+------------------------------+
| :ref:`StyleBox<class_StyleBox>` | fg | |
+---------------------------------+-------------------+------------------------------+
| :ref:`Font<class_Font>` | font | |
+---------------------------------+-------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color | Color( 0.94, 0.94, 0.94, 1 ) |
+---------------------------------+-------------------+------------------------------+
| :ref:`Color<class_Color>` | font_color_shadow | Color( 0, 0, 0, 1 ) |
+---------------------------------+-------------------+------------------------------+
Property Descriptions
---------------------
.. _class_ProgressBar_property_percent_visible:
- :ref:`bool<class_bool>` **percent_visible**
+-----------+----------------------------+
| *Default* | ``true`` |
+-----------+----------------------------+
| *Setter* | set_percent_visible(value) |
+-----------+----------------------------+
| *Getter* | is_percent_visible() |
+-----------+----------------------------+
If ``true``, the fill percentage is displayed on the bar.