Table of Contents

Class EditorTranslationParserPlugin

Namespace
Godot
Assembly
GodotSharpEditor.dll

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 _ParseFile(string, Array<string>, Array<Array>) 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 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 from a CSV file to write into a POT.

using Godot;

[Tool]
public partial class CustomParser : EditorTranslationParserPlugin
{
public override void _ParseFile(string path, Godot.Collections.Array<string> msgids, Godot.Collections.Array<Godot.Collections.Array> msgidsContextPlural)
{
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);
//GD.Print($"Extracted string: {s}");
}
}


  public override string[] _GetRecognizedExtensions()
  {
      return new string[] { "csv" };
  }



}

To add a translatable string associated with context or plural, add it to msgids_context_plural:

// 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", ""});

Note: If you override parsing logic for standard script types (GDScript, C#, etc.), it would be better to load the path argument using Load(string, string, CacheMode). This is because built-in scripts are loaded as Resource type, not FileAccess type.

For example:

public override void _ParseFile(string path, Godot.Collections.Array<string> msgids, Godot.Collections.Array<Godot.Collections.Array> msgidsContextPlural)
  {
      var res = ResourceLoader.Load<Script>(path, "Script");
      string text = res.SourceCode;
      // Parsing logic.
  }

public override string[] _GetRecognizedExtensions()
{
return new string[] { "gd" };
}

To use EditorTranslationParserPlugin, register it using the AddTranslationParserPlugin(EditorTranslationParserPlugin) method first.

public class EditorTranslationParserPlugin : RefCounted, IDisposable
Inheritance
EditorTranslationParserPlugin
Implements
Inherited Members

Constructors

EditorTranslationParserPlugin() 

public EditorTranslationParserPlugin()

Methods

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

_GetRecognizedExtensions()

Gets the list of file extensions to associate with this parser, e.g. ["csv"].

public virtual string[] _GetRecognizedExtensions()

Returns

string[]

_ParseFile(string, Array<string>, Array<Array>)

Override this method to define a custom parsing logic to extract the translatable strings.

public virtual void _ParseFile(string path, Array<string> msgids, Array<Array> msgidsContextPlural)

Parameters

path string
msgids Array<string>
msgidsContextPlural Array<Array>
Edit this page