Merge pull request #1598 from Kenshiin13/fix-locale

feat(es_extended/locale): add support for lazy loading locales

[core]/es_extended/fxmanifest.lua

@@ -7,7 +7,6 @@ version '1.12.2'
 
 shared_scripts {
 	'locale.lua',
-	'locales/*.lua',
 
 	'shared/config/main.lua',
     'shared/config/weapons.lua',
@@ -63,6 +62,7 @@ ui_page {
 
 files {
 	'imports.lua',
+	'locales/*.lua',
 	'locale.js',
 	'html/ui.html',
 

[core]/es_extended/locale.lua

@@ -3,21 +3,33 @@ Locales = {}
 function Translate(str, ...) -- Translate string
     if not str then
         error(("Resource ^5%s^1 You did not specify a parameter for the Translate function or the value is nil!"):format(GetInvokingResource() or GetCurrentResourceName()))
-        return "Given translate function parameter is nil!"
     end
-    if Locales[Config.Locale] then
-        if Locales[Config.Locale][str] then
-            return string.format(Locales[Config.Locale][str], ...)
-        elseif Config.Locale ~= "en" and Locales["en"] and Locales["en"][str] then
-            return string.format(Locales["en"][str], ...)
-        else
-            return "Translation [" .. Config.Locale .. "][" .. str .. "] does not exist"
+
+    --- Load the locale file if it hasn't been loaded yet
+    if Locales[Config.Locale] == nil then
+        local success, result = pcall(function()
+            return assert(load(LoadResourceFile(GetCurrentResourceName(), ("locales/%s.lua"):format(Config.Locale))))()
+        end)
+
+        Locales[Config.Locale] = success and result or false
+    end
+
+    local translations = Locales[Config.Locale]
+    if not translations then
+        if Config.Locale == "en" then
+            return "Locale [en] does not exist"
         end
-    elseif Config.Locale ~= "en" and Locales["en"] and Locales["en"][str] then
-        return string.format(Locales["en"][str], ...)
-    else
-        return "Locale [" .. Config.Locale .. "] does not exist"
+
+        -- Fall back to English translation if the current locale is not found
+        Config.Locale = "en"
+        return Translate(str, ...)
+    end
+
+    if translations[str] then
+        return translations[str]:format(...)
     end
+
+    return ("Translation [%s][%s] does not exist"):format(Config.Locale, str)
 end
 
 function TranslateCap(str, ...) -- Translate string first char uppercase
@@ -26,4 +38,4 @@ end
 
 _ = Translate
 -- luacheck: ignore _U
-_U = TranslateCap
+_U = TranslateCap

[core]/es_extended/locales/cs.lua

@@ -1,4 +1,4 @@
-Locales["cs"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventář ( Váha %s / %s )",
     ["use"] = "Použít",
@@ -223,10 +223,10 @@ Locales["cs"] = {
     ["weapon_tactilerifle"] = "Service Carbine",
 
     -- Drug Wars DLC
-    ["weapon_candycane"] = "Candy Cane", -- not translated
+    ["weapon_candycane"] = "Candy Cane",     -- not translated
     ["weapon_acidpackage"] = "Acid Package", -- not translated
-    ["weapon_pistolxm3"] = "WM 29 Pistol", -- not translated
-    ["weapon_railgunxm3"] = "Railgun", -- not translated
+    ["weapon_pistolxm3"] = "WM 29 Pistol",   -- not translated
+    ["weapon_railgunxm3"] = "Railgun",       -- not translated
 
     -- Thrown
     ["weapon_ball"] = "Míček",

[core]/es_extended/locales/de.lua

@@ -1,4 +1,4 @@
-Locales["de"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventar ( Gewicht %s / %s )",
     ["use"] = "Benutzen",

[core]/es_extended/locales/el.lua

@@ -1,4 +1,4 @@
-Locales["el"] = {
+return {
     -- Inventory
     ["inventory"] = "Αποθήκη ( Βάρος %s / %s )",
     ["use"] = "Χρήση",

[core]/es_extended/locales/en.lua

@@ -1,4 +1,4 @@
-Locales["en"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventory ( Weight %s / %s )",
     ["use"] = "Use",

[core]/es_extended/locales/es.lua

@@ -1,4 +1,4 @@
-Locales["es"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventario %s / %s",
     ["use"] = "Usar",

[core]/es_extended/locales/fi.lua

@@ -1,4 +1,4 @@
-Locales["fi"] = {
+return {
     -- Inventory
     ["inventory"] = "Reppu %s / %s",
     ["use"] = "Käytä",

[core]/es_extended/locales/fr.lua

@@ -1,4 +1,4 @@
-Locales["fr"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventaire ( Poids %s / %s )",
     ["use"] = "Utiliser",

[core]/es_extended/locales/he.lua

@@ -1,4 +1,4 @@
-Locales["he"] = {
+return {
     -- Inventory
     ["inventory"] = "מלאי ( משקל %s / %s )",
     ["use"] = "השתמש",

[core]/es_extended/locales/hu.lua

@@ -1,4 +1,4 @@
-Locales["hu"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventory ( Súly %s / %s )",
     ["use"] = "Használ",
@@ -229,10 +229,10 @@ Locales["hu"] = {
     ["weapon_tactilerifle"] = "Service Carbine",
 
     -- Drug Wars DLC
-    ["weapon_candycane"] = "Candy Cane", -- not translated
+    ["weapon_candycane"] = "Candy Cane",     -- not translated
     ["weapon_acidpackage"] = "Acid Package", -- not translated
-    ["weapon_pistolxm3"] = "WM 29 Pistol", -- not translated
-    ["weapon_railgunxm3"] = "Railgun", -- not translated
+    ["weapon_pistolxm3"] = "WM 29 Pistol",   -- not translated
+    ["weapon_railgunxm3"] = "Railgun",       -- not translated
 
     -- Thrown
     ["weapon_ball"] = "Baseball",

[core]/es_extended/locales/id.lua

@@ -1,4 +1,4 @@
-Locales["id"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventaris ( Berat %s / %s )",
     ["use"] = "Gunakan",

[core]/es_extended/locales/it.lua

@@ -1,4 +1,4 @@
-Locales["it"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventario ( Peso %s / %s )",
     ["use"] = "Usa",

[core]/es_extended/locales/nl.lua

@@ -1,4 +1,4 @@
-Locales["nl"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventaris ( Gewicht %s / %s )",
     ["use"] = "Gebruik",

[core]/es_extended/locales/pl.lua

@@ -1,4 +1,4 @@
-Locales["pl"] = {
+return {
     -- Inventory
     ["inventory"] = "ekwipunek %s / %s",
     ["use"] = "użyj",
@@ -202,10 +202,10 @@ Locales["pl"] = {
     ["component_luxary_finish"] = "luksusowe wykończenie broni",
 
     -- Drug Wars DLC
-    ["weapon_candycane"] = "Candy Cane", -- not translated
+    ["weapon_candycane"] = "Candy Cane",     -- not translated
     ["weapon_acidpackage"] = "Acid Package", -- not translated
-    ["weapon_pistolxm3"] = "WM 29 Pistol", -- not translated
-    ["weapon_railgunxm3"] = "Railgun", -- not translated
+    ["weapon_pistolxm3"] = "WM 29 Pistol",   -- not translated
+    ["weapon_railgunxm3"] = "Railgun",       -- not translated
 
     -- Weapon Ammo
     ["ammo_rounds"] = "nabój/oi",

[core]/es_extended/locales/sl.lua

@@ -1,4 +1,4 @@
-Locales["sl"] = {
+return {
     -- Inventory
     ["inventory"] = "Shramba ( Teza %s / %s )",
     ["use"] = "Uporabi",
@@ -229,10 +229,10 @@ Locales["sl"] = {
     ["weapon_tactilerifle"] = "Service Carbine",
 
     -- Drug Wars DLC
-    ["weapon_candycane"] = "Candy Cane", -- not translated
+    ["weapon_candycane"] = "Candy Cane",     -- not translated
     ["weapon_acidpackage"] = "Acid Package", -- not translated
-    ["weapon_pistolxm3"] = "WM 29 Pistol", -- not translated
-    ["weapon_railgunxm3"] = "Railgun", -- not translated
+    ["weapon_pistolxm3"] = "WM 29 Pistol",   -- not translated
+    ["weapon_railgunxm3"] = "Railgun",       -- not translated
 
     -- Thrown
     ["weapon_ball"] = "Baseball",

[core]/es_extended/locales/sr.lua

@@ -1,4 +1,4 @@
-Locales["sr"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventar ( Težina %s / %s )",
     ["use"] = "Koristi",
@@ -229,10 +229,10 @@ Locales["sr"] = {
     ["weapon_tactilerifle"] = "Service Carbine",
 
     -- Drug Wars DLC
-    ["weapon_candycane"] = "Candy Cane", -- not translated
+    ["weapon_candycane"] = "Candy Cane",     -- not translated
     ["weapon_acidpackage"] = "Acid Package", -- not translated
-    ["weapon_pistolxm3"] = "WM 29 Pistol", -- not translated
-    ["weapon_railgunxm3"] = "Railgun", -- not translated
+    ["weapon_pistolxm3"] = "WM 29 Pistol",   -- not translated
+    ["weapon_railgunxm3"] = "Railgun",       -- not translated
 
     -- Thrown
     ["weapon_ball"] = "Baseball",

[core]/es_extended/locales/sv.lua

@@ -1,4 +1,4 @@
-Locales["sv"] = {
+return {
     -- Inventory
     ["inventory"] = "Inventory ( Vikt %s / %s )",
     ["use"] = "Använd",

[core]/es_extended/locales/tr.lua

@@ -1,4 +1,4 @@
-Locales["tr"] = {
+return {
     -- Inventory
     ["inventory"] = "Envanter ( Ağırlık %s / %s )",
     ["use"] = "Kullan",
@@ -36,10 +36,10 @@ Locales["tr"] = {
     ["threw_weapon_already"] = "Bu Silaha Zaten Sahipsiniz",
     ["threw_cannot_pickup"] = "Envanter Dolu, Alınamaz!",
     ["threw_pickup_prompt"] = "Almak İçin E'ye Basın",
-    
+
     -- Key mapping
     ["keymap_showinventory"] = "Envanteri Göster",
-    
+
     -- Salary related
     ["received_salary"] = "Maaşınız Ödendi: $%s",
     ["received_help"] = "Yardım Çekiniz Ödendi: $%s",
@@ -49,11 +49,11 @@ Locales["tr"] = {
     ["account_bank"] = "Banka",
     ["account_black_money"] = "Kirli Para",
     ["account_money"] = "Nakit",
-    
+
     ["act_imp"] = "İşlem Yapılamaz",
     ["in_vehicle"] = "İşlem Yapılamaz, Oyuncu Araçta",
     ["not_in_vehicle"] = "İşlem Yapılamaz, Oyuncu Araçta Değil",
-    
+
     -- Commands
     ["command_bring"] = "Oyuncuyu Yanınıza Getir",
     ["command_car"] = "Araç Spawn Et",
@@ -119,14 +119,14 @@ Locales["tr"] = {
     ["command_giveammo_ammo"] = "Mermi Miktarı",
     ["tpm_nowaypoint"] = "Hiçbir Yol İşareti Ayarlanmadı.",
     ["tpm_success"] = "Başarıyla Teleport Edildi",
-    
+
     ["noclip_message"] = "Noclip %s Yapıldı",
     ["enabled"] = "~g~Aktif Edildi~s~",
     ["disabled"] = "~r~Pasif Edildi~s~",
-    
+
     -- Locale settings
     ["locale_digit_grouping_symbol"] = ",",
-    ["locale_currency"] = "£%s",    
+    ["locale_currency"] = "£%s",
 
     -- Silahlar
 

[core]/es_extended/locales/zh-cn.lua

@@ -1,4 +1,4 @@
-Locales["zh-cn"] = {
+return {
     -- Inventory
     ["inventory"] = "背包 %s / %s",
     ["use"] = "使用",
@@ -229,10 +229,10 @@ Locales["zh-cn"] = {
     ["weapon_tactilerifle"] = "制式卡宾步枪",
 
     -- Drug Wars DLC
-    ["weapon_candycane"] = "Candy Cane", -- not translated
+    ["weapon_candycane"] = "Candy Cane",     -- not translated
     ["weapon_acidpackage"] = "Acid Package", -- not translated
-    ["weapon_pistolxm3"] = "WM 29 Pistol", -- not translated
-    ["weapon_railgunxm3"] = "Railgun", -- not translated
+    ["weapon_pistolxm3"] = "WM 29 Pistol",   -- not translated
+    ["weapon_railgunxm3"] = "Railgun",       -- not translated
 
     -- Thrown
     ["weapon_ball"] = "棒球",

[core]/es_extended/shared/config/main.lua

@@ -1,5 +1,9 @@
 Config = {}
 
+local txAdminLocale = GetConvar("txAdmin-locale", "en")
+local esxLocale = GetConvar("esx:locale", "invalid")
+Config.Locale = (esxLocale ~= "invalid") and esxLocale or (txAdminLocale ~= "custom" and txAdminLocale) or "en"
+
 -- for ox inventory, this will automatically be adjusted, do not change! for other inventories, change to "resource_name"
 Config.CustomInventory = false
 
@@ -60,8 +64,3 @@ if GetResourceState("ox_inventory") ~= "missing" then
 end
 
 Config.EnableDefaultInventory = Config.CustomInventory == false -- Display the default Inventory ( F2 )
-
-local txAdminLocale = GetConvar("txAdmin-locale", "en")
-local esxLocale = GetConvar("esx:locale", "invalid")
-
-Config.Locale = (esxLocale ~= "invalid") and esxLocale or (txAdminLocale ~= "custom" and txAdminLocale) or "en"

[core]/esx_identity/locales/cs.lua

@@ -1,4 +1,4 @@
-Locales["cs"] = {
+return {
     ["show_registration"] = "zobrazit registracni menu",
     ["show_active_character"] = "zobrazit aktivni postavy",
     ["delete_character"] = "smazat svou stavajici postavu a vytvorit novou",

[core]/esx_identity/locales/da.lua

@@ -1,4 +1,4 @@
-Locales["da"] = {
+return {
     ["show_active_character"] = "Vis aktiv karakter",
     ["active_character"] = "Aktiv karakter: %s",
     ["error_active_character"] = "Der opstod en fejl under indhentning af dine data.",

[core]/esx_identity/locales/de.lua

@@ -1,4 +1,4 @@
-Locales["de"] = {
+return {
   ["show_active_character"] = "Aktiven Charakter anzeigen",
   ["active_character"] = "Aktiver Charakter: %s",
   ["error_active_character"] = "Beim Abrufen deiner Daten ist ein Fehler aufgetreten",
@@ -35,4 +35,4 @@ Locales["de"] = {
   ["invalid_dob_format"] = "Ungültiges Format (Geburtstag): Bitte versuche es erneut.",
   ["invalid_sex_format"] = "Ungültiges Format (Geschlecht): Bitte versuche es erneut.",
   ["invalid_height_format"] = "Ungültiges Format (Körpergröße): Bitte versuche es erneut.",
-}
+}

[core]/esx_identity/locales/en.lua

@@ -1,4 +1,4 @@
-Locales["en"] = {
+return {
     ["show_active_character"] = "Show Active Character",
     ["active_character"] = "Active Character: %s",
     ["error_active_character"] = "There was an error obtaining your data.",

[core]/esx_identity/locales/es.lua

@@ -1,4 +1,4 @@
-Locales["es"] = {
+return {
     ["show_active_character"] = "Mostrar personaje actual",
     ["active_character"] = "Personaje actual: %s",
     ["error_active_character"] = "Se produjo un error al recuperar tu nombre. Por favor contacta con un administrador",

[core]/esx_identity/locales/fi.lua

@@ -1,4 +1,4 @@
-Locales["fi"] = {
+return {
     ["show_active_character"] = "Näytä nykyinen hahmosi",
     ["active_character"] = "Nykyinen hahmosi: %s",
     ["error_active_character"] = "Hahmosi hakemisessa ilmeni ongelma. Ota yhteyttä ylläpitoon.",

[core]/esx_identity/locales/fr.lua

@@ -1,4 +1,4 @@
-Locales["fr"] = {
+return {
     ["show_active_character"] = "Afficher le personnage actif",
     ["active_character"] = "Personnage actif: %s",
     ["error_active_character"] = "Une erreur s'est produite lors de l'obtention de vos données.",

[core]/esx_identity/locales/he.lua

@@ -1,4 +1,4 @@
-Locales["he"] = {
+return {
     ["show_active_character"] = "הצג דמות פעילה",
     ["active_character"] = "דמות פעילה: %s",
     ["error_active_character"] = "אירעה שגיאה בקבלת הנתונים שלך.",

[core]/esx_identity/locales/hu.lua

@@ -1,4 +1,4 @@
-Locales["hu"] = {
+return {
     ["show_active_character"] = "Aktív karakterek mutatása",
     ["active_character"] = "Aktív karakter: %s",
     ["error_active_character"] = "A név nem megfelelő",

[core]/esx_identity/locales/it.lua

@@ -1,4 +1,4 @@
-Locales["it"] = {
+return {
     ["show_active_character"] = "Mostra Personaggio Attivo",
     ["active_character"] = "Personaggio Attivo: %s",
     ["error_active_character"] = "Errore nel recuperare i tuoi dati.",

[core]/esx_identity/locales/nl.lua

@@ -1,4 +1,4 @@
-Locales["nl"] = {
+return {
     ["show_active_character"] = "Actieve karakter laten zien",
     ["active_character"] = "Actief karakter: %s",
     ["error_active_character"] = "Er is een probleem opgetreden tijdens het verzamelen van uw data.",