mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2025-12-31 09:49:22 +03:00
281 lines
11 KiB
ReStructuredText
281 lines
11 KiB
ReStructuredText
:github_url: hide
|
|
|
|
.. _class_ProgressBar:
|
|
|
|
ProgressBar
|
|
===========
|
|
|
|
**继承：** :ref:`Range<class_Range>` **<** :ref:`Control<class_Control>` **<** :ref:`CanvasItem<class_CanvasItem>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
|
|
|
|
将百分比可视化表示的控件。
|
|
|
|
.. rst-class:: classref-introduction-group
|
|
|
|
描述
|
|
----
|
|
|
|
将百分比可视化表示的控件。在中央显示填充百分比。还可以用来显示尚未确定的进度。如果需要更多填充模式，请改用 :ref:`TextureProgressBar<class_TextureProgressBar>`\ 。
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
属性
|
|
----
|
|
|
|
.. table::
|
|
:widths: auto
|
|
|
|
+-------------------------+----------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`editor_preview_indeterminate<class_ProgressBar_property_editor_preview_indeterminate>` | |
|
|
+-------------------------+----------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`int<class_int>` | :ref:`fill_mode<class_ProgressBar_property_fill_mode>` | ``0`` |
|
|
+-------------------------+----------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`indeterminate<class_ProgressBar_property_indeterminate>` | ``false`` |
|
|
+-------------------------+----------------------------------------------------------------------------------------------+-----------+
|
|
| :ref:`bool<class_bool>` | :ref:`show_percentage<class_ProgressBar_property_show_percentage>` | ``true`` |
|
|
+-------------------------+----------------------------------------------------------------------------------------------+-----------+
|
|
|
|
.. rst-class:: classref-reftable-group
|
|
|
|
主题属性
|
|
--------
|
|
|
|
.. 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(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
|
|
|
|
枚举
|
|
----
|
|
|
|
.. _enum_ProgressBar_FillMode:
|
|
|
|
.. rst-class:: classref-enumeration
|
|
|
|
enum **FillMode**: :ref:`🔗<enum_ProgressBar_FillMode>`
|
|
|
|
.. _class_ProgressBar_constant_FILL_BEGIN_TO_END:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_BEGIN_TO_END** = ``0``
|
|
|
|
进度条从开头到结尾水平填充，开头和结尾的位置取决于语言的方向。如果 :ref:`Control.is_layout_rtl()<class_Control_method_is_layout_rtl>` 返回 ``false`` 则为从左至右填充，如果返回 ``true`` 则为从右至左填充。
|
|
|
|
.. _class_ProgressBar_constant_FILL_END_TO_BEGIN:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_END_TO_BEGIN** = ``1``
|
|
|
|
进度条从结尾到开头水平填充，开头和结尾的位置取决于语言的方向。如果 :ref:`Control.is_layout_rtl()<class_Control_method_is_layout_rtl>` 返回 ``false`` 则为从左至右填充，如果返回 ``true`` 则为从右至左填充。
|
|
|
|
.. _class_ProgressBar_constant_FILL_TOP_TO_BOTTOM:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_TOP_TO_BOTTOM** = ``2``
|
|
|
|
进度从上到下填充。
|
|
|
|
.. _class_ProgressBar_constant_FILL_BOTTOM_TO_TOP:
|
|
|
|
.. rst-class:: classref-enumeration-constant
|
|
|
|
:ref:`FillMode<enum_ProgressBar_FillMode>` **FILL_BOTTOM_TO_TOP** = ``3``
|
|
|
|
进度从下到上填充。
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
属性说明
|
|
--------
|
|
|
|
.. _class_ProgressBar_property_editor_preview_indeterminate:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **editor_preview_indeterminate** :ref:`🔗<class_ProgressBar_property_editor_preview_indeterminate>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_editor_preview_indeterminate**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_editor_preview_indeterminate_enabled**\ (\ )
|
|
|
|
如果为 ``false``\ ，则会在编辑器中暂停 :ref:`indeterminate<class_ProgressBar_property_indeterminate>` 动画。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_property_fill_mode:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`int<class_int>` **fill_mode** = ``0`` :ref:`🔗<class_ProgressBar_property_fill_mode>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_fill_mode**\ (\ value\: :ref:`int<class_int>`\ )
|
|
- :ref:`int<class_int>` **get_fill_mode**\ (\ )
|
|
|
|
填充方向。可能的取值见 :ref:`FillMode<enum_ProgressBar_FillMode>`\ 。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_property_indeterminate:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **indeterminate** = ``false`` :ref:`🔗<class_ProgressBar_property_indeterminate>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_indeterminate**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_indeterminate**\ (\ )
|
|
|
|
设为 ``true`` 时，进度表会使用动画来表示正在执行某些操作，但是不会显示填充和具体的值。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_property_show_percentage:
|
|
|
|
.. rst-class:: classref-property
|
|
|
|
:ref:`bool<class_bool>` **show_percentage** = ``true`` :ref:`🔗<class_ProgressBar_property_show_percentage>`
|
|
|
|
.. rst-class:: classref-property-setget
|
|
|
|
- |void| **set_show_percentage**\ (\ value\: :ref:`bool<class_bool>`\ )
|
|
- :ref:`bool<class_bool>` **is_percentage_shown**\ (\ )
|
|
|
|
为 ``true`` 时，将在进度条上显示百分比。
|
|
|
|
.. rst-class:: classref-section-separator
|
|
|
|
----
|
|
|
|
.. rst-class:: classref-descriptions-group
|
|
|
|
主题属性说明
|
|
------------
|
|
|
|
.. _class_ProgressBar_theme_color_font_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_color** = ``Color(0.95, 0.95, 0.95, 1)`` :ref:`🔗<class_ProgressBar_theme_color_font_color>`
|
|
|
|
文本的颜色。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_theme_color_font_outline_color:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Color<class_Color>` **font_outline_color** = ``Color(0, 0, 0, 1)`` :ref:`🔗<class_ProgressBar_theme_color_font_outline_color>`
|
|
|
|
**ProgressBar** 的文本轮廓的色调。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_theme_constant_outline_size:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **outline_size** = ``0`` :ref:`🔗<class_ProgressBar_theme_constant_outline_size>`
|
|
|
|
文字轮廓的大小。
|
|
|
|
\ **注意：**\ 如果使用启用了 :ref:`FontFile.multichannel_signed_distance_field<class_FontFile_property_multichannel_signed_distance_field>` 的字体，其 :ref:`FontFile.msdf_pixel_range<class_FontFile_property_msdf_pixel_range>` 必须至少设置为 :ref:`outline_size<class_ProgressBar_theme_constant_outline_size>` 的\ *两倍*\ ，轮廓渲染才能看起来正确。否则，轮廓可能会比预期的更早被切断。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_theme_font_font:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`Font<class_Font>` **font** :ref:`🔗<class_ProgressBar_theme_font_font>`
|
|
|
|
:ref:`show_percentage<class_ProgressBar_property_show_percentage>` 为 ``true`` 时，用于绘制填充百分比的字体。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_theme_font_size_font_size:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`int<class_int>` **font_size** :ref:`🔗<class_ProgressBar_theme_font_size_font_size>`
|
|
|
|
:ref:`show_percentage<class_ProgressBar_property_show_percentage>` 为 ``true`` 时，用于绘制填充百分比的字体。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_theme_style_background:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **background** :ref:`🔗<class_ProgressBar_theme_style_background>`
|
|
|
|
背景的样式。
|
|
|
|
.. rst-class:: classref-item-separator
|
|
|
|
----
|
|
|
|
.. _class_ProgressBar_theme_style_fill:
|
|
|
|
.. rst-class:: classref-themeproperty
|
|
|
|
:ref:`StyleBox<class_StyleBox>` **fill** :ref:`🔗<class_ProgressBar_theme_style_fill>`
|
|
|
|
进度的样式（即填充进度条的部分）。
|
|
|
|
.. |virtual| replace:: :abbr:`virtual (本方法通常需要用户覆盖才能生效。)`
|
|
.. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)`
|
|
.. |const| replace:: :abbr:`const (本方法无副作用，不会修改该实例的任何成员变量。)`
|
|
.. |vararg| replace:: :abbr:`vararg (本方法除了能接受在此处描述的参数外，还能够继续接受任意数量的参数。)`
|
|
.. |constructor| replace:: :abbr:`constructor (本方法用于构造某个类型。)`
|
|
.. |static| replace:: :abbr:`static (调用本方法无需实例，可直接使用类名进行调用。)`
|
|
.. |operator| replace:: :abbr:`operator (本方法描述的是使用本类型作为左操作数的有效运算符。)`
|
|
.. |bitfield| replace:: :abbr:`BitField (这个值是由下列位标志构成位掩码的整数。)`
|
|
.. |void| replace:: :abbr:`void (无返回值。)`
|