:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/doc/classes/TranslationServer.xml. .. _class_TranslationServer: TranslationServer ================= **Inherits:** :ref:`Object` The server responsible for language translations. .. rst-class:: classref-introduction-group Description ----------- The server that manages all language translations. Translations can be added to or removed from it. .. rst-class:: classref-introduction-group Tutorials --------- - :doc:`Internationalizing games <../tutorials/i18n/internationalizing_games>` - :doc:`Locales <../tutorials/i18n/locales>` .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+------------------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`pseudolocalization_enabled` | ``false`` | +-------------------------+------------------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`add_translation`\ (\ translation\: :ref:`Translation`\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear`\ (\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`compare_locales`\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_all_countries`\ (\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_all_languages`\ (\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_all_scripts`\ (\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_country_name`\ (\ country\: :ref:`String`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_language_name`\ (\ language\: :ref:`String`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_loaded_locales`\ (\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale`\ (\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_locale_name`\ (\ locale\: :ref:`String`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_script_name`\ (\ script\: :ref:`String`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_tool_locale`\ (\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Translation` | :ref:`get_translation_object`\ (\ locale\: :ref:`String`\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`pseudolocalize`\ (\ message\: :ref:`StringName`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`reload_pseudolocalization`\ (\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`remove_translation`\ (\ translation\: :ref:`Translation`\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`set_locale`\ (\ locale\: :ref:`String`\ ) | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`standardize_locale`\ (\ locale\: :ref:`String`\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate`\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`translate_plural`\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| | +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_TranslationServer_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**\ (\ ) If ``true``, enables the use of pseudolocalization. See :ref:`ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization` for details. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_TranslationServer_method_add_translation: .. rst-class:: classref-method |void| **add_translation**\ (\ translation\: :ref:`Translation`\ ) :ref:`🔗` Adds a :ref:`Translation` resource. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_clear: .. rst-class:: classref-method |void| **clear**\ (\ ) :ref:`🔗` Clears the server from all translations. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_compare_locales: .. rst-class:: classref-method :ref:`int` **compare_locales**\ (\ locale_a\: :ref:`String`, locale_b\: :ref:`String`\ ) |const| :ref:`🔗` Compares two locales and returns a similarity score between ``0`` (no match) and ``10`` (full match). .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_all_countries: .. rst-class:: classref-method :ref:`PackedStringArray` **get_all_countries**\ (\ ) |const| :ref:`🔗` Returns an array of known country codes. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_all_languages: .. rst-class:: classref-method :ref:`PackedStringArray` **get_all_languages**\ (\ ) |const| :ref:`🔗` Returns array of known language codes. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_all_scripts: .. rst-class:: classref-method :ref:`PackedStringArray` **get_all_scripts**\ (\ ) |const| :ref:`🔗` Returns an array of known script codes. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_country_name: .. rst-class:: classref-method :ref:`String` **get_country_name**\ (\ country\: :ref:`String`\ ) |const| :ref:`🔗` Returns a readable country name for the ``country`` code. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_language_name: .. rst-class:: classref-method :ref:`String` **get_language_name**\ (\ language\: :ref:`String`\ ) |const| :ref:`🔗` Returns a readable language name for the ``language`` code. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_loaded_locales: .. rst-class:: classref-method :ref:`PackedStringArray` **get_loaded_locales**\ (\ ) |const| :ref:`🔗` Returns an array of all loaded locales of the project. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_locale: .. rst-class:: classref-method :ref:`String` **get_locale**\ (\ ) |const| :ref:`🔗` Returns the current locale of the project. See also :ref:`OS.get_locale` and :ref:`OS.get_locale_language` to query the locale of the user system. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_locale_name: .. rst-class:: classref-method :ref:`String` **get_locale_name**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"English (United States)"``). .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_script_name: .. rst-class:: classref-method :ref:`String` **get_script_name**\ (\ script\: :ref:`String`\ ) |const| :ref:`🔗` Returns a readable script name for the ``script`` code. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_tool_locale: .. rst-class:: classref-method :ref:`String` **get_tool_locale**\ (\ ) :ref:`🔗` Returns the current locale of the editor. \ **Note:** When called from an exported project returns the same value as :ref:`get_locale`. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_get_translation_object: .. rst-class:: classref-method :ref:`Translation` **get_translation_object**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` Returns the :ref:`Translation` instance based on the ``locale`` passed in. It will return ``null`` if there is no :ref:`Translation` instance that matches the ``locale``. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_pseudolocalize: .. rst-class:: classref-method :ref:`StringName` **pseudolocalize**\ (\ message\: :ref:`StringName`\ ) |const| :ref:`🔗` Returns the pseudolocalized string based on the ``message`` passed in. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_reload_pseudolocalization: .. rst-class:: classref-method |void| **reload_pseudolocalization**\ (\ ) :ref:`🔗` Reparses the pseudolocalization options and reloads the translation. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_remove_translation: .. rst-class:: classref-method |void| **remove_translation**\ (\ translation\: :ref:`Translation`\ ) :ref:`🔗` Removes the given translation from the server. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_set_locale: .. rst-class:: classref-method |void| **set_locale**\ (\ locale\: :ref:`String`\ ) :ref:`🔗` Sets the locale of the project. The ``locale`` string will be standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``). If translations have been loaded beforehand for the new locale, they will be applied. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_standardize_locale: .. rst-class:: classref-method :ref:`String` **standardize_locale**\ (\ locale\: :ref:`String`\ ) |const| :ref:`🔗` Returns a ``locale`` string standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``). .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_translate: .. rst-class:: classref-method :ref:`StringName` **translate**\ (\ message\: :ref:`StringName`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns the current locale's translation for the given message (key) and context. .. rst-class:: classref-item-separator ---- .. _class_TranslationServer_method_translate_plural: .. rst-class:: classref-method :ref:`StringName` **translate_plural**\ (\ message\: :ref:`StringName`, plural_message\: :ref:`StringName`, n\: :ref:`int`, context\: :ref:`StringName` = &""\ ) |const| :ref:`🔗` Returns the current locale's translation for the given message (key), plural message and context. The number ``n`` is the number or quantity of the plural object. It will be used to guide the translation system to fetch the correct plural form for the selected language. .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`