:github_url: hide .. _class_TranslationDomain: TranslationDomain ================= **Hereda:** :ref:`RefCounted` **<** :ref:`Object` Una colección autónoma de recursos :ref:`Translation`. .. rst-class:: classref-introduction-group Descripción ---------------------- **TranslationDomain** es una colección autocontenida de recursos :ref:`Translation`. Se pueden añadir o eliminar traducciones de ella. Si estás trabajando con el dominio de traducción principal, es más conveniente utilizar los métodos de envoltura en :ref:`TranslationServer`. .. rst-class:: classref-reftable-group Propiedades ---------------------- .. table:: :widths: auto +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`enabled` | ``true`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_accents_enabled` | ``true`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_double_vowels_enabled` | ``false`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_enabled` | ``false`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`float` | :ref:`pseudolocalization_expansion_ratio` | ``0.0`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_fake_bidi_enabled` | ``false`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_override_enabled` | ``false`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`pseudolocalization_prefix` | ``"["`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_skip_placeholders_enabled` | ``true`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ | :ref:`String` | :ref:`pseudolocalization_suffix` | ``"]"`` | +-----------------------------+------------------------------------------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Métodos -------------- .. table:: :widths: auto +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Translation`\] | :ref:`find_translations`\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale_override`\ (\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`Translation`\] | :ref:`get_translations`\ (\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_translation`\ (\ translation\: :ref:`Translation`\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_translation_for_locale`\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_locale_override`\ (\ locale\: :ref:`String`\ ) | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, message_plural\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | +--------------------------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descripciones de Propiedades -------------------------------------------------------- .. _class_TranslationDomain_property_enabled: .. rst-class:: classref-property :ref:`bool` **enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_enabled**\ (\ ) Si es ``true``, la traducción está activada. De lo contrario, :ref:`translate()` y :ref:`translate_plural()` devolverán el mensaje de entrada sin cambios, independientemente de la configuración regional actual. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_accents_enabled: .. rst-class:: classref-property :ref:`bool` **pseudolocalization_accents_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_accents_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_accents_enabled**\ (\ ) Reemplaza todos los caracteres con sus variantes acentuadas durante la seudolocalización. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_double_vowels_enabled: .. rst-class:: classref-property :ref:`bool` **pseudolocalization_double_vowels_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_double_vowels_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_double_vowels_enabled**\ (\ ) Duplica las vocales en las strings durante la seudolocalización para simular el alargamiento del texto debido a la localización. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_enabled: .. rst-class:: classref-property :ref:`bool` **pseudolocalization_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_enabled**\ (\ ) Si es ``true``, activa la seudolocalización para el proyecto. Esto se puede utilizar para detectar strings no traducibles o problemas de diseño que pueden ocurrir una vez que el proyecto se localiza a idiomas que tienen strings más largas que el idioma de origen. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_expansion_ratio: .. rst-class:: classref-property :ref:`float` **pseudolocalization_expansion_ratio** = ``0.0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_expansion_ratio**\ (\ value\: :ref:`float`\ ) - :ref:`float` **get_pseudolocalization_expansion_ratio**\ (\ ) La relación de expansión a utilizar durante la seudolocalización. Un valor de ``0.3`` es suficiente para la mayoría de los propósitos prácticos, y aumentará la longitud de cada string en un 30%. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_fake_bidi_enabled: .. rst-class:: classref-property :ref:`bool` **pseudolocalization_fake_bidi_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_fake_bidi_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_fake_bidi_enabled**\ (\ ) Si es ``true``, emula texto bidireccional (de derecha a izquierda) cuando la seudolocalización está activada. Esto se puede utilizar para detectar problemas con el diseño RTL y la duplicación de la interfaz de usuario que surgirán si el proyecto se localiza a idiomas RTL como el árabe o el hebreo. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_override_enabled: .. rst-class:: classref-property :ref:`bool` **pseudolocalization_override_enabled** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_override_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_override_enabled**\ (\ ) Reemplaza todos los caracteres de la string con ``*``. Útil para encontrar strings no localizables. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_prefix: .. rst-class:: classref-property :ref:`String` **pseudolocalization_prefix** = ``"["`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_prefix**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_pseudolocalization_prefix**\ (\ ) Prefijo que se añadirá a la string pseudolocalizada. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_skip_placeholders_enabled: .. rst-class:: classref-property :ref:`bool` **pseudolocalization_skip_placeholders_enabled** = ``true`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_skip_placeholders_enabled**\ (\ value\: :ref:`bool`\ ) - :ref:`bool` **is_pseudolocalization_skip_placeholders_enabled**\ (\ ) Omite los marcadores de posición para el formato de strings como ``%s`` o ``%f`` durante la seudolocalización. Útil para identificar strings que necesitan caracteres de control adicionales para mostrarse correctamente. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_property_pseudolocalization_suffix: .. rst-class:: classref-property :ref:`String` **pseudolocalization_suffix** = ``"]"`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_pseudolocalization_suffix**\ (\ value\: :ref:`String`\ ) - :ref:`String` **get_pseudolocalization_suffix**\ (\ ) Sufijo que se añadirá a la string pseudolocalizada. \ **Nota:** La actualización de esta propiedad no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la notificación :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente después de que hayas terminado de modificar las opciones relacionadas con la seudolocalización. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Descripciones de Métodos ------------------------------------------------ .. _class_TranslationDomain_method_add_translation: .. rst-class:: classref-method |void| **add_translation**\ (\ translation\: :ref:`Translation`\ ) :ref:`🔗` Añade una traducción. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_clear: .. rst-class:: classref-method |void| **clear**\ (\ ) :ref:`🔗` Elimina todas las traducciones. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_find_translations: .. rst-class:: classref-method :ref:`Array`\[:ref:`Translation`\] **find_translations**\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| :ref:`🔗` Returns the :ref:`Translation` instances that match ``locale`` (see :ref:`TranslationServer.compare_locales()`). If ``exact`` is ``true``, only instances whose locale exactly equals ``locale`` will be returned. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_get_locale_override: .. rst-class:: classref-method :ref:`String` **get_locale_override**\ (\ ) |const| :ref:`🔗` Devuelve la configuración regional del dominio. Si la configuración regional está deshabilitada, devuelve una string vacía. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_get_translation_object: .. rst-class:: classref-method :ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` **Obsoleto:** Use :ref:`find_translations()` instead. Devuelve la instancia de :ref:`Translation` que mejor coincide con ``locale``. Devuelve ``null`` si no hay coincidencias. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_get_translations: .. rst-class:: classref-method :ref:`Array`\[:ref:`Translation`\] **get_translations**\ (\ ) |const| :ref:`🔗` Returns all available :ref:`Translation` instances as added by :ref:`add_translation()`. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_has_translation: .. rst-class:: classref-method :ref:`bool` **has_translation**\ (\ translation\: :ref:`Translation`\ ) |const| :ref:`🔗` Returns ``true`` if this translation domain contains the given ``translation``. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_has_translation_for_locale: .. rst-class:: classref-method :ref:`bool` **has_translation_for_locale**\ (\ locale\: :ref:`String`, exact\: :ref:`bool`\ ) |const| :ref:`🔗` Returns ``true`` if there are any :ref:`Translation` instances that match ``locale`` (see :ref:`TranslationServer.compare_locales()`). If ``exact`` is ``true``, only instances whose locale exactly equals ``locale`` are considered. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_pseudolocalize: .. rst-class:: classref-method :ref:`StringName` **pseudolocalize**\ (\ message\: :ref:`StringName`\ ) |const| :ref:`🔗` Devuelve la string pseudolocalizada basada en el ``message`` pasado. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_remove_translation: .. rst-class:: classref-method |void| **remove_translation**\ (\ translation\: :ref:`Translation`\ ) :ref:`🔗` Elimina la traducción dada. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_set_locale_override: .. rst-class:: classref-method |void| **set_locale_override**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` Establece la sobrescritura de la configuración regional del dominio. Si ``locale`` es una string vacía, la sobrescritura de la configuración regional está desactivada. De lo contrario, ``locale`` se estandarizará para que coincida con las configuraciones regionales conocidas (por ejemplo, ``en-US`` se correspondería con ``en_US``). \ **Nota:** Llamar a este método no actualiza automáticamente los textos en el árbol de escenas. Por favor, propaga la señal :ref:`MainLoop.NOTIFICATION_TRANSLATION_CHANGED` manualmente. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_translate: .. rst-class:: classref-method :ref:`StringName` **translate**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Devuelve la traducción de la configuración regional actual para el mensaje y el contexto dados. .. rst-class:: classref-item-separator ---- .. _class_TranslationDomain_method_translate_plural: .. rst-class:: classref-method :ref:`StringName` **translate_plural**\ (\ message\: :ref:`StringName`, message_plural\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Devuelve la traducción de la configuración regional actual para el mensaje, el mensaje plural y el contexto dados. El número ``n`` es el número o la cantidad del objeto plural. Se utilizará para guiar al sistema de traducción para obtener la forma plural correcta para el idioma seleccionado. .. |virtual| replace:: :abbr:`virtual (Normalmente, este método debería ser sobreescrito por el usuario para que tenga algún efecto.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |const| replace:: :abbr:`const (Este método no tiene efectos secundarios. No modifica ninguna de las variables miembro de la instancia.)` .. |vararg| replace:: :abbr:`vararg (Este método permite agregar cualquier número de argumentos después de los descritos aquí.)` .. |constructor| replace:: :abbr:`constructor (Este método se utiliza para construir un tipo.)` .. |static| replace:: :abbr:`static (Este método no necesita una instancia para ser llamado, por lo que puede llamarse directamente utilizando el nombre de la clase.)` .. |operator| replace:: :abbr:`operator (Este método describe un operador válido para usar con este tipo como operando izquierdo.)` .. |bitfield| replace:: :abbr:`BitField (Este valor es un entero compuesto como una máscara de bits de las siguientes banderas.)` .. |void| replace:: :abbr:`void (Sin valor de retorno.)`