| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the TranslationServer.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_TranslationServer:
- TranslationServer
- =================
- **Inherits:** :ref:`Object<class_Object>`
- Server that manages all translations.
- Description
- -----------
- Server that manages all translations. Translations can be set to it and removed from it.
- Tutorials
- ---------
- - :doc:`Internationalizing games <../tutorials/i18n/internationalizing_games>`
- - :doc:`Locales <../tutorials/i18n/locales>`
- Properties
- ----------
- +-------------------------+------------------------------------------------------------------------------------------------+-----------+
- | :ref:`bool<class_bool>` | :ref:`pseudolocalization_enabled<class_TranslationServer_property_pseudolocalization_enabled>` | ``false`` |
- +-------------------------+------------------------------------------------------------------------------------------------+-----------+
- Methods
- -------
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`add_translation<class_TranslationServer_method_add_translation>` **(** :ref:`Translation<class_Translation>` translation **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`clear<class_TranslationServer_method_clear>` **(** **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`int<class_int>` | :ref:`compare_locales<class_TranslationServer_method_compare_locales>` **(** :ref:`String<class_String>` locale_a, :ref:`String<class_String>` locale_b **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_all_countries<class_TranslationServer_method_get_all_countries>` **(** **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_all_languages<class_TranslationServer_method_get_all_languages>` **(** **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`PackedStringArray<class_PackedStringArray>` | :ref:`get_all_scripts<class_TranslationServer_method_get_all_scripts>` **(** **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_country_name<class_TranslationServer_method_get_country_name>` **(** :ref:`String<class_String>` country **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_language_name<class_TranslationServer_method_get_language_name>` **(** :ref:`String<class_String>` language **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Array<class_Array>` | :ref:`get_loaded_locales<class_TranslationServer_method_get_loaded_locales>` **(** **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_locale<class_TranslationServer_method_get_locale>` **(** **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_locale_name<class_TranslationServer_method_get_locale_name>` **(** :ref:`String<class_String>` locale **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_script_name<class_TranslationServer_method_get_script_name>` **(** :ref:`String<class_String>` script **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`get_tool_locale<class_TranslationServer_method_get_tool_locale>` **(** **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`Translation<class_Translation>` | :ref:`get_translation_object<class_TranslationServer_method_get_translation_object>` **(** :ref:`String<class_String>` locale **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`StringName<class_StringName>` | :ref:`pseudolocalize<class_TranslationServer_method_pseudolocalize>` **(** :ref:`StringName<class_StringName>` message **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`reload_pseudolocalization<class_TranslationServer_method_reload_pseudolocalization>` **(** **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`remove_translation<class_TranslationServer_method_remove_translation>` **(** :ref:`Translation<class_Translation>` translation **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_locale<class_TranslationServer_method_set_locale>` **(** :ref:`String<class_String>` locale **)** |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`String<class_String>` | :ref:`standardize_locale<class_TranslationServer_method_standardize_locale>` **(** :ref:`String<class_String>` locale **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`StringName<class_StringName>` | :ref:`translate<class_TranslationServer_method_translate>` **(** :ref:`StringName<class_StringName>` message, :ref:`StringName<class_StringName>` context="" **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`StringName<class_StringName>` | :ref:`translate_plural<class_TranslationServer_method_translate_plural>` **(** :ref:`StringName<class_StringName>` message, :ref:`StringName<class_StringName>` plural_message, :ref:`int<class_int>` n, :ref:`StringName<class_StringName>` context="" **)** |const| |
- +---------------------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_TranslationServer_property_pseudolocalization_enabled:
- - :ref:`bool<class_bool>` **pseudolocalization_enabled**
- +-----------+---------------------------------------+
- | *Default* | ``false`` |
- +-----------+---------------------------------------+
- | *Setter* | set_pseudolocalization_enabled(value) |
- +-----------+---------------------------------------+
- | *Getter* | is_pseudolocalization_enabled() |
- +-----------+---------------------------------------+
- If ``true``, enables the use of pseudolocalization. See :ref:`ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization<class_ProjectSettings_property_internationalization/pseudolocalization/use_pseudolocalization>` for details.
- Method Descriptions
- -------------------
- .. _class_TranslationServer_method_add_translation:
- - void **add_translation** **(** :ref:`Translation<class_Translation>` translation **)**
- Adds a :ref:`Translation<class_Translation>` resource.
- ----
- .. _class_TranslationServer_method_clear:
- - void **clear** **(** **)**
- Clears the server from all translations.
- ----
- .. _class_TranslationServer_method_compare_locales:
- - :ref:`int<class_int>` **compare_locales** **(** :ref:`String<class_String>` locale_a, :ref:`String<class_String>` locale_b **)** |const|
- Compares two locales and return similarity score between ``0``\ (no match) and ``10``\ (full match).
- ----
- .. _class_TranslationServer_method_get_all_countries:
- - :ref:`PackedStringArray<class_PackedStringArray>` **get_all_countries** **(** **)** |const|
- Returns array of known country codes.
- ----
- .. _class_TranslationServer_method_get_all_languages:
- - :ref:`PackedStringArray<class_PackedStringArray>` **get_all_languages** **(** **)** |const|
- Returns array of known language codes.
- ----
- .. _class_TranslationServer_method_get_all_scripts:
- - :ref:`PackedStringArray<class_PackedStringArray>` **get_all_scripts** **(** **)** |const|
- Returns array of known script codes.
- ----
- .. _class_TranslationServer_method_get_country_name:
- - :ref:`String<class_String>` **get_country_name** **(** :ref:`String<class_String>` country **)** |const|
- Returns readable country name for the ``country`` code.
- ----
- .. _class_TranslationServer_method_get_language_name:
- - :ref:`String<class_String>` **get_language_name** **(** :ref:`String<class_String>` language **)** |const|
- Returns readable language name for the ``language`` code.
- ----
- .. _class_TranslationServer_method_get_loaded_locales:
- - :ref:`Array<class_Array>` **get_loaded_locales** **(** **)** |const|
- Returns an array of all loaded locales of the project.
- ----
- .. _class_TranslationServer_method_get_locale:
- - :ref:`String<class_String>` **get_locale** **(** **)** |const|
- Returns the current locale of the project.
- See also :ref:`OS.get_locale<class_OS_method_get_locale>` and :ref:`OS.get_locale_language<class_OS_method_get_locale_language>` to query the locale of the user system.
- ----
- .. _class_TranslationServer_method_get_locale_name:
- - :ref:`String<class_String>` **get_locale_name** **(** :ref:`String<class_String>` locale **)** |const|
- Returns a locale's language and its variant (e.g. ``"en_US"`` would return ``"English (United States)"``).
- ----
- .. _class_TranslationServer_method_get_script_name:
- - :ref:`String<class_String>` **get_script_name** **(** :ref:`String<class_String>` script **)** |const|
- Returns readable script name for the ``script`` code.
- ----
- .. _class_TranslationServer_method_get_tool_locale:
- - :ref:`String<class_String>` **get_tool_locale** **(** **)**
- Returns the current locale of the editor.
- \ **Note:** When called from an exported project returns the same value as :ref:`get_locale<class_TranslationServer_method_get_locale>`.
- ----
- .. _class_TranslationServer_method_get_translation_object:
- - :ref:`Translation<class_Translation>` **get_translation_object** **(** :ref:`String<class_String>` locale **)**
- Returns the :ref:`Translation<class_Translation>` instance based on the ``locale`` passed in.
- It will return ``null`` if there is no :ref:`Translation<class_Translation>` instance that matches the ``locale``.
- ----
- .. _class_TranslationServer_method_pseudolocalize:
- - :ref:`StringName<class_StringName>` **pseudolocalize** **(** :ref:`StringName<class_StringName>` message **)** |const|
- Returns the pseudolocalized string based on the ``p_message`` passed in.
- ----
- .. _class_TranslationServer_method_reload_pseudolocalization:
- - void **reload_pseudolocalization** **(** **)**
- Reparses the pseudolocalization options and reloads the translation.
- ----
- .. _class_TranslationServer_method_remove_translation:
- - void **remove_translation** **(** :ref:`Translation<class_Translation>` translation **)**
- Removes the given translation from the server.
- ----
- .. _class_TranslationServer_method_set_locale:
- - void **set_locale** **(** :ref:`String<class_String>` locale **)**
- 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.
- ----
- .. _class_TranslationServer_method_standardize_locale:
- - :ref:`String<class_String>` **standardize_locale** **(** :ref:`String<class_String>` locale **)** |const|
- Returns ``locale`` string standardized to match known locales (e.g. ``en-US`` would be matched to ``en_US``).
- ----
- .. _class_TranslationServer_method_translate:
- - :ref:`StringName<class_StringName>` **translate** **(** :ref:`StringName<class_StringName>` message, :ref:`StringName<class_StringName>` context="" **)** |const|
- Returns the current locale's translation for the given message (key) and context.
- ----
- .. _class_TranslationServer_method_translate_plural:
- - :ref:`StringName<class_StringName>` **translate_plural** **(** :ref:`StringName<class_StringName>` message, :ref:`StringName<class_StringName>` plural_message, :ref:`int<class_int>` n, :ref:`StringName<class_StringName>` context="" **)** |const|
- 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.)`
|
