-- Copyright (c) 2021 Maksim Tuprikov . This code is licensed under MIT license --- Component to wrap over GUI Text nodes with localization helpers -- -- # Overview # -- -- • The initialization of druid.set_text_function is required to enable localization -- using the localization ID. -- -- • The LangText component supports up to 7 string format parameters. -- This limitation exists due to certain issues with using ... arguments. -- -- # Notes # -- -- Example Link -- @module LangText -- @within BaseComponent -- @alias druid.lang_text --- On change text callback -- @tfield druid.event on_change druid.event --- The text component -- @tfield Text text Text --- Text node -- @tfield node node --- local Event = require("druid.event") local settings = require("druid.system.settings") local component = require("druid.component") ---@class druid.lang_text: druid.base_component ---@field text druid.text ---@field node node ---@field on_change druid.event ---@field private last_locale_args table ---@field private last_locale string local M = component.create("lang_text") --- The LangText constructor ---@param self LangText LangText ---@param node string|node The node_id or gui.get_node(node_id) ---@param locale_id string|nil Default locale id or text from node as default ---@param adjust_type string|nil Adjust type for text. By default is DOWNSCALE. Look const.TEXT_ADJUST for reference function M:init(node, locale_id, adjust_type) self.druid = self:get_druid() self.text = self.druid:new_text(node, locale_id, adjust_type) self.node = self.text.node self.last_locale_args = {} self.on_change = Event() self:translate(locale_id or gui.get_text(self.node)) self.text.on_set_text:subscribe(self.on_change.trigger, self.on_change) return self end function M:on_language_change() if self.last_locale then self:translate(self.last_locale, unpack(self.last_locale_args)) end end --- Setup raw text to lang_text component ---@param self LangText LangText ---@param text string Text for text node -- @treturn LangText Current instance function M:set_to(text) self.last_locale = false self.text:set_to(text) self.on_change:trigger() return self end --- Translate the text by locale_id ---@param self LangText LangText ---@param locale_id string Locale id ---@param a string|nil Optional param to string.format ---@param b string|nil Optional param to string.format ---@param c string|nil Optional param to string.format ---@param d string|nil Optional param to string.format ---@param e string|nil Optional param to string.format ---@param f string|nil Optional param to string.format ---@param g string|nil Optional param to string.format -- @treturn LangText Current instance function M:translate(locale_id, a, b, c, d, e, f, g) self.last_locale_args = { a, b, c, d, e, f, g } self.last_locale = locale_id or self.last_locale self.text:set_to(settings.get_text(self.last_locale, a, b, c, d, e, f, g) or "") return self end --- Format string with new text params on localized text ---@param self LangText LangText ---@param a string|nil Optional param to string.format ---@param b string|nil Optional param to string.format ---@param c string|nil Optional param to string.format ---@param d string|nil Optional param to string.format ---@param e string|nil Optional param to string.format ---@param f string|nil Optional param to string.format ---@param g string|nil Optional param to string.format -- @treturn LangText Current instance function M:format(a, b, c, d, e, f, g) self.last_locale_args = { a, b, c, d, e, f, g } self.text:set_to(settings.get_text(self.last_locale, a, b, c, d, e, f, g) or "") return self end return M