Dictionary system | WIP

[LuaFan2]

closes #1
Work In Progress

[benank]

Should this be a singleton?

EDIT: Added comment in review.

[rdev34]

Since we don't expect the current language to be changed during runtime, lets move this to the global config so it's easily configured.
Please make a class like this in napi/shared to store a config value for current language:

NapiConfig = class()

function NapiConfig:__init()
   self.Language = LanguageEnum.English
end

NapiConfig = NapiConfig()

Now we can access it with NapiConfig.Language

[rdev34]

There's no need to inherit ValueStorage for Dictionary since all we're doing with it is storing some data in this class. You could just have a self.current_language variable in this class which would be more readable and simple. We use ValueStorage for in-game entities for easily setting and getting data on them.

[benank]

Don't forget to initialize the singleton at the end of the file, with

Dictionary = Dictionary()

(applies to any/all singletons)

[rdev34]

We should refactor all this code like this:

1. LanguageEnum class to define languages
2. PhraseEnum class to define phrases
3. Phrases class as the interface for any gamemode logic

I see it working like this:

LanguageEnum = immediate_class(Enum)

function LanguageEnum:__init()
  self:EnumInit()
  
  self.English = 1
  self.Spanish = 2

  self:SetDescription(self.English, "English")
  self:SetDescription(self.Spanish, "Spanish")
end

LanguageEnum = LanguageEnum()

PhraseEnum = immediate_class(Enum)

function PhraseEnum:__init()
  self:EnumInit()

  self.WelcomeText = 1
end

PhraseEnum = PhraseEnum()

Phrases = class()

function Phrases:__init()
  self.translations = {
    [PhraseEnum.WelcomeText] = {
        [LanguageEnum.English] = "Welcome to the server!",
        [LanguageEnum.Spanish] = "Bienvenidos!"
    }
    -- etc
  }
end

function Phrases:GetPhrase(phrase_enum)
  local language = NapiConfig.Language
  local translation = self.translations[phrase_enum]
  assert(phrase_enum ~= nil, "Phrase does not have any translation")
  assert(translation[language] ~= nil, "Phrase does not have a translation in " .. LanguageEnum:GetDescription(language))
  return translation[language]
end

Phrases = Phrases()

Now we can do local text = Phrases:GetPhrase(PhraseEnum.WelcomeText)

[LuaFan2]

Didn't better will be to create language enums and phrases in different files (not in class)?(one for each language in special directory)

[LuaFan2]

This will at least make it easier to add phrases in different languages to the repository.

[rdev34]

Yes - it would be good to put all the phrases for each language in its own file. You could create a directory in napi/shared and come up with a way to do this. Then, you could use that data to set-up the self.translations variable in Phrases. I would probably create a class for each language and map a string to a PhraseEnum.

Also, we are not creating the enums in the Phrases class. We are just creating a table so we can look up a translation for a Phrase in a given Language. The enums are good practice and should be kept for readability and for the sake of providing a unique id to each Phrase and Language.

[LuaFan2]

Also such system where all is Enum it's a wildness for me if we want to make it simple to use by develoler in his own gamemode. If languages are initialized in only one place, it creates certain limitations.
Not better to make it to work so?:
-- russian.lua
Russian = Language("Russian")

Russian:Phrase("greetings", "Добро пожаловать!")
Russian:Phrase("kicked", "Вы были кикнуты с сервера")

-- config.lua
NapiConfig:SetLanguage("Russian")
or
NapiConfig.language = "Russian"
-- script.lua
print(Language:GetPhrase("kicked"))

it seems to be the most simplified and dev-friendly variant. If SetLanguage not exists then we take English Language, if phrase not exists then we took it in English.