2020-06-23 19:48:59 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "EditorTranslationParserPlugin" inherits= "RefCounted" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2020-06-23 19:48:59 +08:00
<brief_description >
Plugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.).
</brief_description>
<description >
2021-10-15 20:30:58 +08:00
[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 [method _parse_file] method in script.
2020-07-23 06:07:35 +08:00
Add the extracted strings to argument [code]msgids[/code] or [code]msgids_context_plural[/code] if context or plural is used.
2020-08-07 19:17:12 +08:00
When adding to [code]msgids_context_plural[/code], you must add the data using the format [code]["A", "B", "C"][/code], where [code]A[/code] represents the extracted string, [code]B[/code] represents the context, and [code]C[/code] represents the plural version of the extracted string. If you want to add only context but not plural, put [code]""[/code] 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.
2020-06-23 19:48:59 +08:00
The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu.
2020-07-23 06:07:35 +08:00
Below shows an example of a custom parser that extracts strings from a CSV file to write into a POT.
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
2022-09-22 04:49:03 +08:00
@tool
2020-06-23 19:48:59 +08:00
extends EditorTranslationParserPlugin
2021-05-16 05:48:59 +08:00
func _parse_file(path, msgids, msgids_context_plural):
2023-01-30 22:21:36 +08:00
var file = FileAccess.open(path, FileAccess.READ)
2020-07-04 02:24:54 +08:00
var text = file.get_as_text()
2020-09-13 20:45:36 +08:00
var split_strs = text.split(",", false)
2020-06-23 19:48:59 +08:00
for s in split_strs:
2020-07-23 06:07:35 +08:00
msgids.append(s)
2020-06-23 19:48:59 +08:00
#print("Extracted string: " + s)
2021-05-16 05:48:59 +08:00
func _get_recognized_extensions():
2020-06-23 19:48:59 +08:00
return ["csv"]
2020-09-13 20:45:36 +08:00
[/gdscript]
[csharp]
using Godot;
[Tool]
2023-02-01 01:21:09 +08:00
public partial class CustomParser : EditorTranslationParserPlugin
2020-09-13 20:45:36 +08:00
{
2023-02-01 01:21:09 +08:00
public override void _ParseFile(string path, Godot.Collections.Array< string> msgids, Godot.Collections.Array< Godot.Collections.Array> msgidsContextPlural)
2020-09-13 20:45:36 +08:00
{
2023-02-01 01:21:09 +08:00
using var file = FileAccess.Open(path, FileAccess.ModeFlags.Read);
2020-09-13 20:45:36 +08:00
string text = file.GetAsText();
2023-02-01 01:21:09 +08:00
string[] splitStrs = text.Split(",", allowEmpty: false);
foreach (string s in splitStrs)
2020-09-13 20:45:36 +08:00
{
msgids.Add(s);
2023-02-01 01:21:09 +08:00
//GD.Print($"Extracted string: {s}");
2020-09-13 20:45:36 +08:00
}
}
2023-02-01 01:21:09 +08:00
public override string[] _GetRecognizedExtensions()
2020-09-13 20:45:36 +08:00
{
2023-02-01 01:21:09 +08:00
return new string[] { "csv" };
2020-09-13 20:45:36 +08:00
}
}
[/csharp]
[/codeblocks]
2020-07-23 06:07:35 +08:00
To add a translatable string associated with context or plural, add it to [code]msgids_context_plural[/code]:
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
2020-08-07 19:17:12 +08:00
# 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 "A test without context" and msgid_plural "plurals".
msgids_context_plural.append(["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", ""])
2020-09-13 20:45:36 +08:00
[/gdscript]
[csharp]
// This will add a message with msgid "Test 1", msgctxt "context", and msgid_plural "test 1 plurals".
msgidsContextPlural.Add(new Godot.Collections.Array{"Test 1", "context", "test 1 Plurals"});
// This will add a message with msgid "A test without context" and msgid_plural "plurals".
msgidsContextPlural.Add(new Godot.Collections.Array{"A test without context", "", "plurals"});
// This will add a message with msgid "Only with context" and msgctxt "a friendly context".
msgidsContextPlural.Add(new Godot.Collections.Array{"Only with context", "a friendly context", ""});
[/csharp]
[/codeblocks]
2024-09-06 06:25:59 +08:00
[b]Note:[/b] If you override parsing logic for standard script types (GDScript, C#, etc.), it would be better to load the [code]path[/code] argument using [method ResourceLoader.load]. This is because built-in scripts are loaded as [Resource] type, not [FileAccess] type. For example:
2020-09-13 20:45:36 +08:00
[codeblocks]
[gdscript]
2021-05-16 05:48:59 +08:00
func _parse_file(path, msgids, msgids_context_plural):
2020-07-04 02:24:54 +08:00
var res = ResourceLoader.load(path, "Script")
2020-09-13 20:45:36 +08:00
var text = res.source_code
2020-07-04 02:24:54 +08:00
# Parsing logic.
2021-05-16 05:48:59 +08:00
func _get_recognized_extensions():
2020-07-26 03:38:34 +08:00
return ["gd"]
2020-09-13 20:45:36 +08:00
[/gdscript]
[csharp]
2023-02-01 01:21:09 +08:00
public override void _ParseFile(string path, Godot.Collections.Array< string> msgids, Godot.Collections.Array< Godot.Collections.Array> msgidsContextPlural)
2020-09-13 20:45:36 +08:00
{
var res = ResourceLoader.Load< Script> (path, "Script");
string text = res.SourceCode;
// Parsing logic.
}
2023-02-01 01:21:09 +08:00
public override string[] _GetRecognizedExtensions()
2020-09-13 20:45:36 +08:00
{
2023-02-01 01:21:09 +08:00
return new string[] { "gd" };
2020-09-13 20:45:36 +08:00
}
[/csharp]
[/codeblocks]
2021-10-15 20:30:58 +08:00
To use [EditorTranslationParserPlugin], register it using the [method EditorPlugin.add_translation_parser_plugin] method first.
2020-06-23 19:48:59 +08:00
</description>
<tutorials >
</tutorials>
<methods >
2024-10-11 22:35:28 +08:00
<method name= "_get_comments" qualifiers= "virtual" >
<return type= "void" />
<param index= "0" name= "msgids_comment" type= "String[]" />
<param index= "1" name= "msgids_context_plural_comment" type= "String[]" />
<description >
If overridden, called after [method _parse_file] to get comments for the parsed entries. This method should fill the arrays with the same number of elements and in the same order as [method _parse_file].
</description>
</method>
2021-08-22 09:52:44 +08:00
<method name= "_get_recognized_extensions" qualifiers= "virtual const" >
<return type= "PackedStringArray" />
2020-06-23 19:48:59 +08:00
<description >
Gets the list of file extensions to associate with this parser, e.g. [code]["csv"][/code].
</description>
</method>
2021-05-16 05:48:59 +08:00
<method name= "_parse_file" qualifiers= "virtual" >
2021-07-30 21:28:05 +08:00
<return type= "void" />
2022-08-07 02:11:48 +08:00
<param index= "0" name= "path" type= "String" />
2022-09-01 01:24:04 +08:00
<param index= "1" name= "msgids" type= "String[]" />
<param index= "2" name= "msgids_context_plural" type= "Array[]" />
2020-06-23 19:48:59 +08:00
<description >
Override this method to define a custom parsing logic to extract the translatable strings.
</description>
</method>
</methods>
</class>