| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.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`` (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.95, 0.95, 0.95, 1)`` |
- +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_outline_color<class_ProgressBar_theme_color_font_outline_color>` | ``Color(1, 1, 1, 1)`` |
- +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
- | :ref:`Color<class_Color>` | :ref:`font_shadow_color<class_ProgressBar_theme_color_font_shadow_color>` | ``Color(0, 0, 0, 1)`` |
- +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
- | :ref:`int<class_int>` | :ref:`outline_size<class_ProgressBar_theme_constant_outline_size>` | ``0`` |
- +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
- | :ref:`Font<class_Font>` | :ref:`font<class_ProgressBar_theme_font_font>` | |
- +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
- | :ref:`int<class_int>` | :ref:`font_size<class_ProgressBar_theme_font_size_font_size>` | |
- +---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
- | :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.95, 0.95, 0.95, 1)`` |
- +-----------+--------------------------------+
- The color of the text.
- ----
- .. _class_ProgressBar_theme_color_font_outline_color:
- - :ref:`Color<class_Color>` **font_outline_color**
- +-----------+-----------------------+
- | *Default* | ``Color(1, 1, 1, 1)`` |
- +-----------+-----------------------+
- The tint of text outline of the ``ProgressBar``.
- ----
- .. _class_ProgressBar_theme_color_font_shadow_color:
- - :ref:`Color<class_Color>` **font_shadow_color**
- +-----------+-----------------------+
- | *Default* | ``Color(0, 0, 0, 1)`` |
- +-----------+-----------------------+
- The color of the text's shadow.
- ----
- .. _class_ProgressBar_theme_constant_outline_size:
- - :ref:`int<class_int>` **outline_size**
- +-----------+-------+
- | *Default* | ``0`` |
- +-----------+-------+
- The size of the text outline.
- ----
- .. _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_font_size_font_size:
- - :ref:`int<class_int>` **font_size**
- Font size 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.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
