2020-06-23 13:48:59 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name= "EditorTranslationParserPlugin" inherits= "Reference" version= "4.0" >
<brief_description >
Plugin for adding custom parsers to extract strings that are to be translated from custom files (.csv, .json etc.).
</brief_description>
<description >
2020-07-03 20:24:54 +02:00
Plugins are registered via [method EditorPlugin.add_translation_parser_plugin] method. To define the parsing and string extraction logic, override the [method parse_file] method in script.
2020-06-23 13:48:59 +02:00
The extracted strings will be written into a POT file selected by user under "POT Generation" in "Localization" tab in "Project Settings" menu.
Below shows an example of a custom parser that extracts strings in a CSV file to write into a POT.
[codeblock]
tool
extends EditorTranslationParserPlugin
2020-07-03 20:24:54 +02:00
func parse_file(path, extracted_strings):
var file = File.new()
file.open(path, File.READ)
var text = file.get_as_text()
2020-06-23 13:48:59 +02:00
var split_strs = text.split(",", false, 0)
for s in split_strs:
extracted_strings.append(s)
#print("Extracted string: " + s)
2020-07-03 20:24:54 +02:00
2020-06-23 13:48:59 +02:00
func get_recognized_extensions():
return ["csv"]
2020-07-03 16:09:12 +02:00
[/codeblock]
2020-07-03 20:24:54 +02: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 [File] type.
For example:
[codeblock]
func parse_file(path, extracted_strings):
var res = ResourceLoader.load(path, "Script")
var text = res.get_source_code()
# Parsing logic.
func get_recognized_extensions():
2020-07-25 21:38:34 +02:00
return ["gd"]
2020-07-03 20:24:54 +02:00
[/codeblock]
2020-06-23 13:48:59 +02:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "get_recognized_extensions" qualifiers= "virtual" >
<return type= "Array" >
</return>
<description >
Gets the list of file extensions to associate with this parser, e.g. [code]["csv"][/code].
</description>
</method>
2020-07-03 20:24:54 +02:00
<method name= "parse_file" qualifiers= "virtual" >
2020-06-23 13:48:59 +02:00
<return type= "void" >
</return>
2020-07-03 20:24:54 +02:00
<argument index= "0" name= "path" type= "String" >
2020-06-23 13:48:59 +02:00
</argument>
<argument index= "1" name= "extracted_strings" type= "Array" >
</argument>
<description >
Override this method to define a custom parsing logic to extract the translatable strings.
</description>
</method>
</methods>
<constants >
</constants>
</class>