H073.Local 1.1.0

HxLocal API Documentation

Introduction

The Localisation class provides functions to manage and access translations based on language JSON files.

Setup

By default, translations are expected to be stored in a folder named "Lingos", containing JSON files named with their respective language codes, e.g., "en.json", "de.json".

Changing the Default Folder:

If you want to use a different folder, you can change the FilePath property. However, it's crucial to ensure that you set this folder before loading any languages or accessing translations:

Localisation.FilePath = "YourFolderPathHere";

⚠️ Note: Always change the folder path before loading a language or using the API to fetch translations. The order is crucial to ensure the API looks in the correct directory.

Using the API

1. Loading a Language:

To load a specific language, call the LoadLanguage method:

Localisation.LoadLanguage("en");

Where "en" is the language code.

2. Retrieving a String:

To retrieve a translated string, use the GetString method:

var welcomeMessage = Localisation.GetString("welcomeMessage");

If the key contains nested objects, use a dot notation:

var nestedMessage = Localisation.GetString("parent.child.message");

3. Using Format Strings:

You can use string formats and pass arguments to the GetString method:

var formattedMessage = Localisation.GetString("welcomeWithName", "John");

Assuming the translation is something like: "welcomeWithName": "Welcome, {0}!"

4. List Available Languages:

To get a list of available languages:

var languages = Localisation.ListAvailableLanguages();
foreach(var lang in languages)
{
    Console.WriteLine(lang);
}

This will list the names of the JSON files without their extensions.