mirror of
https://github.com/godotengine/godot-docs-l10n.git
synced 2026-01-04 10:09:56 +03:00
317 lines
17 KiB
ReStructuredText
317 lines
17 KiB
ReStructuredText
:github_url: hide
|
||
|
||
.. _class_CharFXTransform:
|
||
|
||
CharFXTransform
|
||
===============
|
||
|
||
**Наследует:** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
|
||
|
||
Управляет тем, как будет отображаться отдельный символ в :ref:`RichTextEffect<class_RichTextEffect>`.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Описание
|
||
----------------
|
||
|
||
Задавая различные свойства этого объекта, вы можете управлять тем, как будут отображаться отдельные символы в :ref:`RichTextEffect<class_RichTextEffect>`.
|
||
|
||
.. rst-class:: classref-introduction-group
|
||
|
||
Обучающие материалы
|
||
--------------------------------------
|
||
|
||
- :doc:`BBCode в RichTextLabel <../tutorials/ui/bbcode_in_richtextlabel>`
|
||
|
||
.. rst-class:: classref-reftable-group
|
||
|
||
Свойства
|
||
----------------
|
||
|
||
.. table::
|
||
:widths: auto
|
||
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`Color<class_Color>` | :ref:`color<class_CharFXTransform_property_color>` | ``Color(0, 0, 0, 1)`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`float<class_float>` | :ref:`elapsed_time<class_CharFXTransform_property_elapsed_time>` | ``0.0`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`Dictionary<class_Dictionary>` | :ref:`env<class_CharFXTransform_property_env>` | ``{}`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`RID<class_RID>` | :ref:`font<class_CharFXTransform_property_font>` | ``RID()`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`glyph_count<class_CharFXTransform_property_glyph_count>` | ``0`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`glyph_flags<class_CharFXTransform_property_glyph_flags>` | ``0`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`glyph_index<class_CharFXTransform_property_glyph_index>` | ``0`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`Vector2<class_Vector2>` | :ref:`offset<class_CharFXTransform_property_offset>` | ``Vector2(0, 0)`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`outline<class_CharFXTransform_property_outline>` | ``false`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`Vector2i<class_Vector2i>` | :ref:`range<class_CharFXTransform_property_range>` | ``Vector2i(0, 0)`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`int<class_int>` | :ref:`relative_index<class_CharFXTransform_property_relative_index>` | ``0`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`Transform2D<class_Transform2D>` | :ref:`transform<class_CharFXTransform_property_transform>` | ``Transform2D(1, 0, 0, 1, 0, 0)`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
| :ref:`bool<class_bool>` | :ref:`visible<class_CharFXTransform_property_visible>` | ``true`` |
|
||
+---------------------------------------+----------------------------------------------------------------------+-----------------------------------+
|
||
|
||
.. rst-class:: classref-section-separator
|
||
|
||
----
|
||
|
||
.. rst-class:: classref-descriptions-group
|
||
|
||
Описания свойств
|
||
--------------------------------
|
||
|
||
.. _class_CharFXTransform_property_color:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Color<class_Color>` **color** = ``Color(0, 0, 0, 1)`` :ref:`🔗<class_CharFXTransform_property_color>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_color**\ (\ value\: :ref:`Color<class_Color>`\ )
|
||
- :ref:`Color<class_Color>` **get_color**\ (\ )
|
||
|
||
Цвет, которым будет нарисован персонаж.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_elapsed_time:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`float<class_float>` **elapsed_time** = ``0.0`` :ref:`🔗<class_CharFXTransform_property_elapsed_time>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_elapsed_time**\ (\ value\: :ref:`float<class_float>`\ )
|
||
- :ref:`float<class_float>` **get_elapsed_time**\ (\ )
|
||
|
||
Время, прошедшее с момента добавления :ref:`RichTextLabel<class_RichTextLabel>` в дерево сцены (в секундах). Время останавливается, когда :ref:`RichTextLabel<class_RichTextLabel>` приостанавливается (см. :ref:`Node.process_mode<class_Node_property_process_mode>`). Сбрасывается, когда текст в :ref:`RichTextLabel<class_RichTextLabel>` изменяется.
|
||
|
||
\ **Примечание:** Время все еще идет, пока :ref:`RichTextLabel<class_RichTextLabel>` скрыт.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_env:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Dictionary<class_Dictionary>` **env** = ``{}`` :ref:`🔗<class_CharFXTransform_property_env>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_environment**\ (\ value\: :ref:`Dictionary<class_Dictionary>`\ )
|
||
- :ref:`Dictionary<class_Dictionary>` **get_environment**\ (\ )
|
||
|
||
Содержит аргументы, переданные в открывающем теге BBCode. По умолчанию аргументы являются строками; если их содержимое соответствует типу, например :ref:`bool<class_bool>`, :ref:`int<class_int>` или :ref:`float<class_float>`, они будут преобразованы автоматически. Цветовые коды в форме ``#rrggbb`` или ``#rgb`` будут преобразованы в непрозрачный :ref:`Color<class_Color>`. Строковые аргументы не могут содержать пробелы, даже если они заключены в кавычки.
|
||
|
||
Если они присутствуют, кавычки также будут присутствовать в конечной строке. Например, открывающий тег BBCode ``[example foo=hello bar=true baz=42 color=#ffffff]`` будет сопоставлен со следующим :ref:`Dictionary<class_Dictionary>`:
|
||
|
||
::
|
||
|
||
{"foo": "hello", "bar": true, "baz": 42, "color": Color(1, 1, 1, 1)}
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_font:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`RID<class_RID>` **font** = ``RID()`` :ref:`🔗<class_CharFXTransform_property_font>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_font**\ (\ value\: :ref:`RID<class_RID>`\ )
|
||
- :ref:`RID<class_RID>` **get_font**\ (\ )
|
||
|
||
:ref:`TextServer<class_TextServer>` RID шрифта, используемого для отображения глифа, это значение можно использовать с методами ``TextServer.font_*`` для получения информации о шрифте.
|
||
|
||
\ **Примечание:** Только для чтения. Установка этого свойства не повлияет на рисование.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_glyph_count:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **glyph_count** = ``0`` :ref:`🔗<class_CharFXTransform_property_glyph_count>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_glyph_count**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_glyph_count**\ (\ )
|
||
|
||
Количество глифов в кластере графем. Это значение задается в первом глифе кластера.
|
||
|
||
\ **Примечание:** Только для чтения. Установка этого свойства не повлияет на рисование.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_glyph_flags:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **glyph_flags** = ``0`` :ref:`🔗<class_CharFXTransform_property_glyph_flags>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_glyph_flags**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_glyph_flags**\ (\ )
|
||
|
||
Флаги глифов. См. :ref:`GraphemeFlag<enum_TextServer_GraphemeFlag>` для получения дополнительной информации.
|
||
|
||
\ **Примечание:** Только для чтения. Установка этого свойства не повлияет на рисование.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_glyph_index:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **glyph_index** = ``0`` :ref:`🔗<class_CharFXTransform_property_glyph_index>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_glyph_index**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_glyph_index**\ (\ )
|
||
|
||
Индекс глифа, специфичный для :ref:`font<class_CharFXTransform_property_font>`. Если вы хотите заменить этот глиф, используйте :ref:`TextServer.font_get_glyph_index()<class_TextServer_method_font_get_glyph_index>` с :ref:`font<class_CharFXTransform_property_font>`, чтобы получить новый индекс глифа для одного символа.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_offset:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Vector2<class_Vector2>` **offset** = ``Vector2(0, 0)`` :ref:`🔗<class_CharFXTransform_property_offset>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_offset**\ (\ value\: :ref:`Vector2<class_Vector2>`\ )
|
||
- :ref:`Vector2<class_Vector2>` **get_offset**\ (\ )
|
||
|
||
Смещение позиции, с которой будет нарисован символ (в пикселях).
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_outline:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **outline** = ``false`` :ref:`🔗<class_CharFXTransform_property_outline>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_outline**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_outline**\ (\ )
|
||
|
||
Если ``true``, FX-преобразование вызывается для контурного рисования.
|
||
|
||
\ **Примечание:** Только для чтения. Установка этого свойства не повлияет на рисование.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_range:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Vector2i<class_Vector2i>` **range** = ``Vector2i(0, 0)`` :ref:`🔗<class_CharFXTransform_property_range>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_range**\ (\ value\: :ref:`Vector2i<class_Vector2i>`\ )
|
||
- :ref:`Vector2i<class_Vector2i>` **get_range**\ (\ )
|
||
|
||
Абсолютный диапазон символов в строке, соответствующий глифу.
|
||
|
||
\ **Примечание:** Только для чтения. Установка этого свойства не повлияет на рисование.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_relative_index:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`int<class_int>` **relative_index** = ``0`` :ref:`🔗<class_CharFXTransform_property_relative_index>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_relative_index**\ (\ value\: :ref:`int<class_int>`\ )
|
||
- :ref:`int<class_int>` **get_relative_index**\ (\ )
|
||
|
||
Смещение символа глифа относительно текущего пользовательского блока :ref:`RichTextEffect<class_RichTextEffect>`.
|
||
|
||
\ **Примечание:** Только для чтения. Установка этого свойства не повлияет на рисование.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_transform:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`Transform2D<class_Transform2D>` **transform** = ``Transform2D(1, 0, 0, 1, 0, 0)`` :ref:`🔗<class_CharFXTransform_property_transform>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_transform**\ (\ value\: :ref:`Transform2D<class_Transform2D>`\ )
|
||
- :ref:`Transform2D<class_Transform2D>` **get_transform**\ (\ )
|
||
|
||
Текущее преобразование текущего глифа. Его можно переопределить (например, управляя положением и вращением из кривой). Вы также можете изменить существующее значение, чтобы применить преобразования поверх других эффектов.
|
||
|
||
.. rst-class:: classref-item-separator
|
||
|
||
----
|
||
|
||
.. _class_CharFXTransform_property_visible:
|
||
|
||
.. rst-class:: classref-property
|
||
|
||
:ref:`bool<class_bool>` **visible** = ``true`` :ref:`🔗<class_CharFXTransform_property_visible>`
|
||
|
||
.. rst-class:: classref-property-setget
|
||
|
||
- |void| **set_visibility**\ (\ value\: :ref:`bool<class_bool>`\ )
|
||
- :ref:`bool<class_bool>` **is_visible**\ (\ )
|
||
|
||
Если ``true``, символ будет нарисован. Если ``false``, символ будет скрыт. Символы вокруг скрытых символов будут переформатированы, чтобы занять пространство скрытых символов. Если это нежелательно, вместо этого установите их :ref:`color<class_CharFXTransform_property_color>` на ``Color(1, 1, 1, 0)``.
|
||
|
||
.. |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 (Нет возвращаемого значения.)`
|