From e0d64a53bd9f04eec1294f79e2cc87935e41e4a1 Mon Sep 17 00:00:00 2001 From: Godot Organization Date: Sat, 22 Feb 2025 03:20:53 +0000 Subject: [PATCH] classref: Sync with current master branch (394508d) --- .../class_editortranslationparserplugin.rst | 65 +++++------ classes/class_projectsettings.rst | 110 +++++++++++++----- 2 files changed, 111 insertions(+), 64 deletions(-) diff --git a/classes/class_editortranslationparserplugin.rst b/classes/class_editortranslationparserplugin.rst index 1e82d5288..5b4d01a0e 100644 --- a/classes/class_editortranslationparserplugin.rst +++ b/classes/class_editortranslationparserplugin.rst @@ -21,9 +21,7 @@ Description **EditorTranslationParserPlugin** is invoked when a file is being parsed to extract strings that require translation. To define the parsing and string extraction logic, override the :ref:`_parse_file()` method in script. -Add the extracted strings to argument ``msgids`` or ``msgids_context_plural`` if context or plural is used. - -When adding to ``msgids_context_plural``, you must add the data using the format ``["A", "B", "C"]``, where ``A`` represents the extracted string, ``B`` represents the context, and ``C`` represents the plural version of the extracted string. If you want to add only context but not plural, put ``""`` for the plural slot. The idea is the same if you only want to add plural but not context. See the code below for concrete examples. +The return value should be an :ref:`Array` of :ref:`PackedStringArray`\ s, one for each extracted translatable string. Each entry should contain ``[msgid, msgctxt, msgid_plural, comment]``, where all except ``msgid`` are optional. Empty strings will be ignored. The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu. @@ -37,14 +35,17 @@ Below shows an example of a custom parser that extracts strings from a CSV file @tool extends EditorTranslationParserPlugin - func _parse_file(path, msgids, msgids_context_plural): + func _parse_file(path): + var ret: Array[PackedStringArray] = [] var file = FileAccess.open(path, FileAccess.READ) var text = file.get_as_text() var split_strs = text.split(",", false) for s in split_strs: - msgids.append(s) + msgids.append(PackedStringArray([s])) #print("Extracted string: " + s) + return ret + func _get_recognized_extensions(): return ["csv"] @@ -55,16 +56,18 @@ Below shows an example of a custom parser that extracts strings from a CSV file [Tool] public partial class CustomParser : EditorTranslationParserPlugin { - public override void _ParseFile(string path, Godot.Collections.Array msgids, Godot.Collections.Array msgidsContextPlural) + public override Godot.Collections.Array _ParseFile(string path) { + Godot.Collections.Array ret; using var file = FileAccess.Open(path, FileAccess.ModeFlags.Read); string text = file.GetAsText(); string[] splitStrs = text.Split(",", allowEmpty: false); foreach (string s in splitStrs) { - msgids.Add(s); + ret.Add([s]); //GD.Print($"Extracted string: {s}"); } + return ret; } public override string[] _GetRecognizedExtensions() @@ -75,28 +78,28 @@ Below shows an example of a custom parser that extracts strings from a CSV file -To add a translatable string associated with context or plural, add it to ``msgids_context_plural``: +To add a translatable string associated with a context, plural, or comment: .. tabs:: .. code-tab:: gdscript - # This will add a message with msgid "Test 1", msgctxt "context", and msgid_plural "test 1 plurals". - msgids_context_plural.append(["Test 1", "context", "test 1 plurals"]) + # This will add a message with msgid "Test 1", msgctxt "context", msgid_plural "test 1 plurals", and comment "test 1 comment". + ret.append(PackedStringArray(["Test 1", "context", "test 1 plurals", "test 1 comment"])) # This will add a message with msgid "A test without context" and msgid_plural "plurals". - msgids_context_plural.append(["A test without context", "", "plurals"]) + ret.append(PackedStringArray(["A test without context", "", "plurals"])) # This will add a message with msgid "Only with context" and msgctxt "a friendly context". - msgids_context_plural.append(["Only with context", "a friendly context", ""]) + ret.append(PackedStringArray(["Only with context", "a friendly context"])) .. code-tab:: csharp - // This will add a message with msgid "Test 1", msgctxt "context", and msgid_plural "test 1 plurals". - msgidsContextPlural.Add(["Test 1", "context", "test 1 Plurals"]); + // This will add a message with msgid "Test 1", msgctxt "context", msgid_plural "test 1 plurals", and comment "test 1 comment". + ret.Add(["Test 1", "context", "test 1 plurals", "test 1 comment"]); // This will add a message with msgid "A test without context" and msgid_plural "plurals". - msgidsContextPlural.Add(["A test without context", "", "plurals"]); + ret.Add(["A test without context", "", "plurals"]); // This will add a message with msgid "Only with context" and msgctxt "a friendly context". - msgidsContextPlural.Add(["Only with context", "a friendly context", ""]); + ret.Add(["Only with context", "a friendly context"]); @@ -107,7 +110,7 @@ To add a translatable string associated with context or plural, add it to ``msgi .. code-tab:: gdscript - func _parse_file(path, msgids, msgids_context_plural): + func _parse_file(path): var res = ResourceLoader.load(path, "Script") var text = res.source_code # Parsing logic. @@ -117,7 +120,7 @@ To add a translatable string associated with context or plural, add it to ``msgi .. code-tab:: csharp - public override void _ParseFile(string path, Godot.Collections.Array msgids, Godot.Collections.Array msgidsContextPlural) + public override Godot.Collections.Array _ParseFile(string path) { var res = ResourceLoader.Load