godot-docs/classes/class_translation.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Translation.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Translation:

Translation
===========

**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`

**Inherited By:** :ref:`PHashTranslation<class_phashtranslation>`

**Category:** Core

Brief Description
-----------------

Language Translation.

Member Functions
----------------

+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`add_message<class_Translation_add_message>` **(** :ref:`String<class_string>` src_message, :ref:`String<class_string>` xlated_message **)** |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`erase_message<class_Translation_erase_message>` **(** :ref:`String<class_string>` src_message **)**                                         |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`                    | :ref:`get_locale<class_Translation_get_locale>` **(** **)** const                                                                                 |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`                    | :ref:`get_message<class_Translation_get_message>` **(** :ref:`String<class_string>` src_message **)** const                                       |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`                          | :ref:`get_message_count<class_Translation_get_message_count>` **(** **)** const                                                                   |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`PoolStringArray<class_poolstringarray>`  | :ref:`get_message_list<class_Translation_get_message_list>` **(** **)** const                                                                     |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+
| void                                           | :ref:`set_locale<class_Translation_set_locale>` **(** :ref:`String<class_string>` locale **)**                                                    |
+------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------+

Member Variables
----------------

  .. _class_Translation_locale:

- :ref:`String<class_string>` **locale**

  .. _class_Translation_messages:

- :ref:`PoolStringArray<class_poolstringarray>` **messages**


Description
-----------

Translations are resources that can be loaded/unloaded on demand. They map a string to another string.

Member Function Description
---------------------------

.. _class_Translation_add_message:

- void **add_message** **(** :ref:`String<class_string>` src_message, :ref:`String<class_string>` xlated_message **)**

Add a message for translation.

.. _class_Translation_erase_message:

- void **erase_message** **(** :ref:`String<class_string>` src_message **)**

Erase a message.

.. _class_Translation_get_locale:

- :ref:`String<class_string>` **get_locale** **(** **)** const

Return the locale of the translation.

.. _class_Translation_get_message:

- :ref:`String<class_string>` **get_message** **(** :ref:`String<class_string>` src_message **)** const

Return a message for translation.

.. _class_Translation_get_message_count:

- :ref:`int<class_int>` **get_message_count** **(** **)** const

.. _class_Translation_get_message_list:

- :ref:`PoolStringArray<class_poolstringarray>` **get_message_list** **(** **)** const

Return all the messages (keys).

.. _class_Translation_set_locale:

- void **set_locale** **(** :ref:`String<class_string>` locale **)**

Set the locale of the translation.