pandemonium_engine_docs/classes/class_progressbar.rst

:github_url: hide

.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/3.5/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/3.5/doc/classes/ProgressBar.xml.

.. _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                                                | ``0`` (overrides :ref:`Control<class_Control_property_size_flags_vertical>`) |
+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+
| :ref:`float<class_float>` | step                                                               | ``0.01`` (overrides :ref:`Range<class_Range_property_step>`)                 |
+---------------------------+--------------------------------------------------------------------+------------------------------------------------------------------------------+

Theme Properties
----------------

+---------------------------------+---------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>`       | :ref:`font_color<class_ProgressBar_theme_color_font_color>`               | ``Color( 0.94, 0.94, 0.94, 1 )`` |
+---------------------------------+---------------------------------------------------------------------------+----------------------------------+
| :ref:`Color<class_Color>`       | :ref:`font_color_shadow<class_ProgressBar_theme_color_font_color_shadow>` | ``Color( 0, 0, 0, 1 )``          |
+---------------------------------+---------------------------------------------------------------------------+----------------------------------+
| :ref:`Font<class_Font>`         | :ref:`font<class_ProgressBar_theme_font_font>`                            |                                  |
+---------------------------------+---------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`bg<class_ProgressBar_theme_style_bg>`                               |                                  |
+---------------------------------+---------------------------------------------------------------------------+----------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`fg<class_ProgressBar_theme_style_fg>`                               |                                  |
+---------------------------------+---------------------------------------------------------------------------+----------------------------------+

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.

Theme Property Descriptions
---------------------------

.. _class_ProgressBar_theme_color_font_color:

- :ref:`Color<class_Color>` **font_color**

+-----------+----------------------------------+
| *Default* | ``Color( 0.94, 0.94, 0.94, 1 )`` |
+-----------+----------------------------------+

The color of the text.

----

.. _class_ProgressBar_theme_color_font_color_shadow:

- :ref:`Color<class_Color>` **font_color_shadow**

+-----------+-------------------------+
| *Default* | ``Color( 0, 0, 0, 1 )`` |
+-----------+-------------------------+

The color of the text's shadow.

----

.. _class_ProgressBar_theme_font_font:

- :ref:`Font<class_Font>` **font**

Font used to draw the fill percentage if :ref:`percent_visible<class_ProgressBar_property_percent_visible>` is ``true``.

----

.. _class_ProgressBar_theme_style_bg:

- :ref:`StyleBox<class_StyleBox>` **bg**

The style of the background.

----

.. _class_ProgressBar_theme_style_fg:

- :ref:`StyleBox<class_StyleBox>` **fg**

The style of the progress (i.e. the part that fills the bar).

.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`