godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TranslationServer.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

194 lines
8.2 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="TranslationServer" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
The server responsible for language translations.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
The translation server is the API backend that manages all language translations.
Make editor use translation domains How editor plugins use this feature: 1. Pick a unique translation domain name. 2. `_enter_tree()`: load translations into that translation domain. 3. Call `set_translation_domain()` for its root UI node. 4. `_exit_tree()`: remove that translation domain. Plugins can also set the translation domain to `godot.editor` for nested nodes that should use editor translations. `EditorFileDialog` automatically does this.
2024-08-16 14:19:14 +00:00
Translations are stored in [TranslationDomain]s, which can be accessed by name. The most commonly used translation domain is the main translation domain. It always exists and can be accessed using an empty [StringName]. The translation server provides wrapper methods for accessing the main translation domain directly, without having to fetch the translation domain first. Custom translation domains are mainly for advanced usages like editor plugins. Names starting with [code]godot.[/code] are reserved for engine internals.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="Internationalizing games">$DOCS_URL/tutorials/i18n/internationalizing_games.html</link>
<link title="Locales">$DOCS_URL/tutorials/i18n/locales.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="add_translation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="translation" type="Translation" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
Adds a translation to the main translation domain.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="clear">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
Removes all translations from the main translation domain.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<method name="compare_locales" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="locale_a" type="String" />
<param index="1" name="locale_b" type="String" />
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Compares two locales and returns a similarity score between [code]0[/code] (no match) and [code]10[/code] (full match).
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
<method name="get_all_countries" qualifiers="const">
<return type="PackedStringArray" />
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Returns an array of known country codes.
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
<method name="get_all_languages" qualifiers="const">
<return type="PackedStringArray" />
<description>
Returns array of known language codes.
</description>
</method>
<method name="get_all_scripts" qualifiers="const">
<return type="PackedStringArray" />
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Returns an array of known script codes.
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
<method name="get_country_name" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="country" type="String" />
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Returns a readable country name for the [param country] code.
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
<method name="get_language_name" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="language" type="String" />
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Returns a readable language name for the [param language] code.
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
Added docs to AudioStreamPlayer for get_mix_time
2019-04-27 17:11:39 +00:00
<method name="get_loaded_locales" qualifiers="const">
Replace Array return types with TypedArray 3
2022-08-07 22:52:20 +00:00
<return type="PackedStringArray" />
Added docs to AudioStreamPlayer for get_mix_time
2019-04-27 17:11:39 +00:00
<description>
Implement `OS::get_locale_language()` helper method This method extracts the 2 or 3-letter language code from `OS::get_locale()`, making it easier for users to identify the "main" language code for users that might have different OS locales due to different OS or region, but should be matched to the same translation (e.g. "generic" Spanish). Fixes #40703.
2021-09-16 07:27:56 +00:00
Returns an array of all loaded locales of the project.
Added docs to AudioStreamPlayer for get_mix_time
2019-04-27 17:11:39 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_locale" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Implement `OS::get_locale_language()` helper method This method extracts the 2 or 3-letter language code from `OS::get_locale()`, making it easier for users to identify the "main" language code for users that might have different OS locales due to different OS or region, but should be matched to the same translation (e.g. "generic" Spanish). Fixes #40703.
2021-09-16 07:27:56 +00:00
Returns the current locale of the project.
See also [method OS.get_locale] and [method OS.get_locale_language] to query the locale of the user system.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
classref: Apply doctool to fix formatting Fixes regression from #12396 which caused #12466. [ci skip]
2017-10-29 11:09:14 +00:00
<method name="get_locale_name" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="locale" type="String" />
classref: Apply doctool to fix formatting Fixes regression from #12396 which caused #12466. [ci skip]
2017-10-29 11:09:14 +00:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21 23:04:47 +00:00
Returns a locale's language and its variant (e.g. [code]"en_US"[/code] would return [code]"English (United States)"[/code]).
classref: Apply doctool to fix formatting Fixes regression from #12396 which caused #12466. [ci skip]
2017-10-29 11:09:14 +00:00
</description>
</method>
Add translation domain
2024-08-15 01:14:41 +00:00
<method name="get_or_add_domain">
<return type="TranslationDomain" />
<param index="0" name="domain" type="StringName" />
<description>
Returns the translation domain with the specified name. An empty translation domain will be created and added if it does not exist.
</description>
</method>
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<method name="get_script_name" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="script" type="String" />
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Returns a readable script name for the [param script] code.
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
[GDExtension] Add binds for missing methods, operators, and constants required for GDExtension TextServer implementation.
2022-02-08 07:49:14 +00:00
<method name="get_tool_locale">
<return type="String" />
<description>
Returns the current locale of the editor.
[b]Note:[/b] When called from an exported project returns the same value as [method get_locale].
</description>
</method>
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
<method name="get_translation_object">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Translation" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="locale" type="String" />
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
Returns the [Translation] instance that best matches [param locale] in the main translation domain. Returns [code]null[/code] if there are no matches.
</description>
</method>
<method name="has_domain" qualifiers="const">
<return type="bool" />
<param index="0" name="domain" type="StringName" />
<description>
Returns [code]true[/code] if a translation domain with the specified name exists.
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
</description>
</method>
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
<method name="pseudolocalize" qualifiers="const">
<return type="StringName" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="message" type="StringName" />
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the pseudolocalized string based on the [param message] passed in.
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
</description>
</method>
<method name="reload_pseudolocalization">
<return type="void" />
<description>
Reparses the pseudolocalization options and reloads the translation.
</description>
</method>
Add translation domain
2024-08-15 01:14:41 +00:00
<method name="remove_domain">
<return type="void" />
<param index="0" name="domain" type="StringName" />
<description>
Removes the translation domain with the specified name.
[b]Note:[/b] Trying to remove the main translation domain is an error.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="remove_translation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="translation" type="Translation" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
Removes the given translation from the main translation domain.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_locale">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="locale" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Sets the locale of the project. The [param locale] string will be standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
Implement `OS::get_locale_language()` helper method This method extracts the 2 or 3-letter language code from `OS::get_locale()`, making it easier for users to identify the "main" language code for users that might have different OS locales due to different OS or region, but should be matched to the same translation (e.g. "generic" Spanish). Fixes #40703.
2021-09-16 07:27:56 +00:00
If translations have been loaded beforehand for the new locale, they will be applied.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<method name="standardize_locale" qualifiers="const">
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="locale" type="String" />
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Returns a [param locale] string standardized to match known locales (e.g. [code]en-US[/code] would be matched to [code]en_US[/code]).
Improve locale detection. Use separate language, script and country lists. Add locale selection dialog and property hint.
2021-09-23 11:08:50 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="translate" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="message" type="StringName" />
Fix some DEFVALs to use the right type - Use `StringName()` in DEFVAL for StringNames. - Use `Variant()` in DEFVAL for Variants.
2024-01-30 20:03:28 +00:00
<param index="1" name="context" type="StringName" default="&amp;&quot;&quot;" />
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
Returns the current locale's translation for the given message and context.
[b]Note:[/b] This method always uses the main translation domain.
Updated Translation architecture to have TranslationPO, did some commit fixes and updated class Reference.
2020-08-07 11:17:12 +00:00
</description>
</method>
<method name="translate_plural" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="message" type="StringName" />
<param index="1" name="plural_message" type="StringName" />
<param index="2" name="n" type="int" />
Fix some DEFVALs to use the right type - Use `StringName()` in DEFVAL for StringNames. - Use `Variant()` in DEFVAL for Variants.
2024-01-30 20:03:28 +00:00
<param index="3" name="context" type="StringName" default="&amp;&quot;&quot;" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Add translation domain
2024-08-15 01:14:41 +00:00
Returns the current locale's translation for the given message, plural message and context.
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
The number [param 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.
Add translation domain
2024-08-15 01:14:41 +00:00
[b]Note:[/b] This method always uses the main translation domain.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
add pseudolocalization to Godot
2021-08-08 15:07:57 +00:00
<members>
<member name="pseudolocalization_enabled" type="bool" setter="set_pseudolocalization_enabled" getter="is_pseudolocalization_enabled" default="false">
If [code]true[/code], enables the use of pseudolocalization. See [member ProjectSettings.internationalization/pseudolocalization/use_pseudolocalization] for details.
</member>
</members>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</class>