Oversættelser

Oversættelse

Det skulle være muligt nemt at oversætte hele spillet til et andet sprog. Efter nogle eksperimenter har jeg lavet klassen I18n til engine3. Lige nu er den ikke mere end dette.

function I18n:new()
    self.locale = nil
    self.currentLocaleFile = nil
end

--- Convert string to i18n locale
---@param str? string
---@param replacements? table
function I18n:s(str, replacements)
    if str == nil then
        return
    end

    local strOut = tostring(str)

    -- Maybe there is a overwrite
    if self.locale[strOut] ~= nil then
        strOut = self.locale[strOut]
    end

    -- Maybe there are replacements
    if replacements then
        return string.gsub(strOut, "[%%%d]+", replacements)
    end

    return strOut
end

---@param file string
---@param data table
function I18n:createI18nData(file, data)
    self.locale = data
    self.currentLocaleFile = file
end

--- Load the locale in memory
---@param file string Path to the source file .mp only at the moment
function I18n:load(file)
    if type(file) ~= "string" then
        error("Cannot load i18n file, is not a string")
    end

    if string.find(file, ".mp") == nil then
        error("i18n file is is not supported: " .. file)
    end

    local msgPackData = Msgpack:load(file)
    if msgPackData == nil then
        error("File data is nil for file: " .. file)
        return
    end

    self:createI18nData(file, msgPackData)
end

I spillet kan den derefter bruges overalt som global funktion på følgende måde

-- load the selected language once
i18n:load(config.localeDefault) -- nl.mp

-- use the default english strings into the selected language
local i18nHoverText = i18n:s("Hello")

language.yaml

en:
    "Hello" : null
nl:
    "Hello" : "Hallo"

Som du kan se, står sproget ’en’ også i language.yaml, men med værdien null. Det betyder, at den originale engelske sætning skal bruges. Dermed er det også muligt i fremtiden at oversætte det engelske til andre sætninger.

en:
    "Hello z" : "Hallo y"
nl:
    "Hello z" : "Hallo y"

print(i18n:s("Hello z")) -- Hallo y

Indtil videre er det her nok, og det ser ud til at virke godt og hurtigt.