TranslationAPI

Dictionary

• The Dictionary can be accessed within the Translation class
• Usually the Translator class is used for everything

Dictionary dict = Translator.getDictionary();

//Register translations and languages stored in a xml file
dict.registerDictionaryFile(new DictionaryFile(fileInStream) );

//Bukkit Hint: Use .getResource("dictionary.xml") inside your JavaPlugin class to get the input stream! (assuming you have dictionary.xml in your resources)

Translation

• "##" is used as a placeholder for arguments.
• ArgumentConverter can be added to translate a object into a string
• All Translations are stored within a OriginalText object that also contains the used text in your sources.
  
• The MadLinguist editor scans selected files for all tr(..) method calls
• Use LanguageResolver.lang(Player) to get the language key of a player

static import de.maddevs.translator.api.Translator.tr;

Language lang = Translator.getLanguage("en");     //"en" is registered as default
Player player = Bukkit.getPlayerExact("Drayke");  //A Bukkit example, we assume player is != null
String s1 = tr(lang,"Test translation for player ##",player);

//Because of some problems with overloading you need to parse the language parameter as null if you want to use the default language and arguments
String s2 = tr(null,"Test translation for ##","this");

//And now one example with the selected client language of the player
String s3 = tr(LanguageResolver.lang(player),"The language of the minecraft client from the player");

ArgumentConverter

• IArgumentConverter interfaces are used to convert objects to a string
• They need to be registered with the Translator

public class PersonConverter implements IArgumentConverter<Person>
{
  @Override
  public String convert(Person person)
  {
   return person.getName(); //Assuming Person to be a class with a "String name" field
  }

  @Override
  public Person getType()
  {
   return Person.class;
  }
}
//Converter for a certain type can just be added once
Translator.registerConverter(Person.class,new PersonConverter());

//Using the argument converter
Person person = new Person("Peter");
Translator.tr(lang,"Person: ##!",person);
//Would now return: "Person: Peter!"