godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4.0
godot-docs/classes/class_progressbar.rst
Godot Organization c39e8f8635 classref: Sync with current 4.0 branch (cfedb0a)
2023-07-24 10:19:37 +00:00

259 lines
9.5 KiB
ReStructuredText
Raw Permalink Blame History

:github_url: hide
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.0/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.0/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>`
A control used for visual representation of a percentage.
.. rst-class:: classref-introduction-group
Description
-----------
A control used for visual representation of a percentage. Shows fill percentage from right to left.
.. rst-class:: classref-reftable-group
Properties
----------
.. table::
:widths: auto
+-------------------------+--------------------------------------------------------------------+----------+
| :ref:`int<class_int>` | :ref:`fill_mode<class_ProgressBar_property_fill_mode>` | ``0`` |
+-------------------------+--------------------------------------------------------------------+----------+
| :ref:`bool<class_bool>` | :ref:`show_percentage<class_ProgressBar_property_show_percentage>` | ``true`` |
+-------------------------+--------------------------------------------------------------------+----------+
.. rst-class:: classref-reftable-group
Theme Properties
----------------
.. table::
:widths: auto
+---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
| :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:`background<class_ProgressBar_theme_style_background>` | |
+---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
| :ref:`StyleBox<class_StyleBox>` | :ref:`fill<class_ProgressBar_theme_style_fill>` | |
+---------------------------------+-----------------------------------------------------------------------------+--------------------------------+
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Enumerations
------------
.. _enum_ProgressBar_FillMode:
.. rst-class:: classref-enumeration
enum **FillMode**:
.. _class_ProgressBar_constant_FILL_BEGIN_TO_END:
.. rst-class:: classref-enumeration-constant
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_BEGIN_TO_END** = ``0``
The progress bar fills from begin to end horizontally, according to the language direction. If :ref:`Control.is_layout_rtl<class_Control_method_is_layout_rtl>` returns ``false``, it fills from left to right, and if it returns ``true``, it fills from right to left.
.. _class_ProgressBar_constant_FILL_END_TO_BEGIN:
.. rst-class:: classref-enumeration-constant
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_END_TO_BEGIN** = ``1``
The progress bar fills from end to begin horizontally, according to the language direction. If :ref:`Control.is_layout_rtl<class_Control_method_is_layout_rtl>` returns ``false``, it fills from right to left, and if it returns ``true``, it fills from left to right.
.. _class_ProgressBar_constant_FILL_TOP_TO_BOTTOM:
.. rst-class:: classref-enumeration-constant
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_TOP_TO_BOTTOM** = ``2``
The progress fills from top to bottom.
.. _class_ProgressBar_constant_FILL_BOTTOM_TO_TOP:
.. rst-class:: classref-enumeration-constant
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_BOTTOM_TO_TOP** = ``3``
The progress fills from bottom to top.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Property Descriptions
---------------------
.. _class_ProgressBar_property_fill_mode:
.. rst-class:: classref-property
:ref:`int<class_int>` **fill_mode** = ``0``
.. rst-class:: classref-property-setget
- void **set_fill_mode** **(** :ref:`int<class_int>` value **)**
- :ref:`int<class_int>` **get_fill_mode** **(** **)**
The fill direction. See :ref:`FillMode<enum_ProgressBar_FillMode>` for possible values.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_property_show_percentage:
.. rst-class:: classref-property
:ref:`bool<class_bool>` **show_percentage** = ``true``
.. rst-class:: classref-property-setget
- void **set_show_percentage** **(** :ref:`bool<class_bool>` value **)**
- :ref:`bool<class_bool>` **is_percentage_shown** **(** **)**
If ``true``, the fill percentage is displayed on the bar.
.. rst-class:: classref-section-separator
----
.. rst-class:: classref-descriptions-group
Theme Property Descriptions
---------------------------
.. _class_ProgressBar_theme_color_font_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_color** = ``Color(0.95, 0.95, 0.95, 1)``
The color of the text.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_color_font_outline_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_outline_color** = ``Color(1, 1, 1, 1)``
The tint of text outline of the **ProgressBar**.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_color_font_shadow_color:
.. rst-class:: classref-themeproperty
:ref:`Color<class_Color>` **font_shadow_color** = ``Color(0, 0, 0, 1)``
The color of the text's shadow.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_constant_outline_size:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **outline_size** = ``0``
The size of the text outline.
\ **Note:** If using a font with :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` enabled, its :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` must be set to at least *twice* the value of :ref:`outline_size<class_ProgressBar_theme_constant_outline_size>` for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_font_font:
.. rst-class:: classref-themeproperty
:ref:`Font<class_Font>` **font**
Font used to draw the fill percentage if :ref:`show_percentage<class_ProgressBar_property_show_percentage>` is ``true``.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_font_size_font_size:
.. rst-class:: classref-themeproperty
:ref:`int<class_int>` **font_size**
Font size used to draw the fill percentage if :ref:`show_percentage<class_ProgressBar_property_show_percentage>` is ``true``.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_style_background:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **background**
The style of the background.
.. rst-class:: classref-item-separator
----
.. _class_ProgressBar_theme_style_fill:
.. rst-class:: classref-themeproperty
:ref:`StyleBox<class_StyleBox>` **fill**
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.)`
Reference in New Issue View Git Blame Copy Permalink