mirror of
https://github.com/godotengine/godot-docs.git
synced 2025-12-31 17:49:03 +03:00
67 lines
3.3 KiB
ReStructuredText
67 lines
3.3 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 | ``0`` *(parent override)* |
|
|
+---------------------------+--------------------------------------------------------------------+------------------------------+
|
|
| :ref:`float<class_float>` | step | ``0.01`` *(parent override)* |
|
|
+---------------------------+--------------------------------------------------------------------+------------------------------+
|
|
|
|
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.
|
|
|
|
.. |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.)`
|