Class: LocaleManager

LocaleManager


new LocaleManager()

SubModule managing language choices.
Source:
Listens to Events:
  • Command#event:language
  • Command#event:lang
  • Command#event:locale
  • Command#event:setlanguage
  • Command#event:setlang
  • Command#event:setlocale
  • Command#event:changelanguage
  • Command#event:changelang
  • Command#event:changelocale

Extends

Members


<private, static, constant> _localeMapFilename :string

Filename relative to cwd to find language to locale mapping information.
Type:
  • string
Source:

<private, static, constant> _localeSaveFile :string

Filename relative to guild directory storing the guild's locale settings.
Type:
  • string
Source:

<private, constant> _guilds :object.<string>

Locale settings set for specific guilds. If a guild is not included in here, they are expected to use the default locale settings. Mapped by guild ID.
Type:
  • object.<string>
Default Value:
  • {}
Source:

<private> _mappings :object.<string>

Language mappings read from file. This maps the common ways to type a language, to the locale string we understand. All keys are lower-case UTF-8 strings.
Type:
  • object.<string>
Default Value:
  • {"english":"en_US"}
Source:

<private, constant> _strings :Strings

Instance of locale strings helper.
Type:
Source:

<nullable> bot :SpikeyBot

The parent SpikeyBot instance. Defaults to required cache value for autocompletion, updates to current reference at init.
Type:
Inherited From:
Overrides:
Source:

client :Discord~Client

The current bot client. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord~Client
Inherited From:
Overrides:
Source:

command :Command

The command object for registering command listeners. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Overrides:
Source:

<constant> commit :string

The commit at HEAD at the time this module was loaded. Essentially the version of this submodule.
Type:
  • string
Inherited From:
Overrides:
Source:

common :Common

The common object. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
Inherited From:
Overrides:
Source:

Discord :Discord

The current Discord object instance of the bot. Defaults to require cache value for editor autocompletion, updates to current reference at init.
Type:
  • Discord
Inherited From:
Overrides:
Source:

<abstract> helpMessage :undefined|string|Discord~MessageEmbed

The help message to show the user in the main help message.
Type:
  • undefined | string | Discord~MessageEmbed
Inherited From:
Overrides:
Source:

<protected, readonly> initialized :boolean

Has this subModule been initialized yet (Has begin() been called).
Type:
  • boolean
Inherited From:
Overrides:
Source:

<constant> loadTime :number

The time at which this module was loaded for use in checking if the module needs to be reloaded because the file has been modified since loading.
Type:
  • number
Inherited From:
Overrides:
Source:

<protected> myName :string

The name of this submodule. Used for differentiating in the log. Should be defined before begin().
Type:
  • string
Inherited From:
Overrides:
Source:

<abstract> postPrefix :string

The postfix for the global prefix for this subModule. Must be defined before begin(), otherwise it is ignored.
Type:
  • string
Inherited From:
Overrides:
Source:

Methods


<private> _commandLanguage(msg)

User typed the language command.
Parameters:
Name Type Description
msg Discord~Message Message that triggered command.
Source:
Listens to Events:
  • Command#event:language
  • Command#event:lang
  • Command#event:locale
  • Command#event:setlanguage
  • Command#event:setlang
  • Command#event:setlocale
  • Command#event:changelanguage
  • Command#event:changelang
  • Command#event:changelocale

<private> _readLocaleMap()

Read the current locale mapping information from file.
Source:

begin(Discord, client, command, common, bot)

Initialize this submodule.
Parameters:
Name Type Description
Discord Discord The Discord object for the API library.
client Discord~Client The client that represents this bot.
command Command The command instance in which to register command listeners.
common Common Class storing common functions.
bot SpikeyBot The parent SpikeyBot instance.
Inherited From:
Overrides:
Source:

changeLocale(gId, locale)

Change the chosen locale value in a specific guild.
Parameters:
Name Type Description
gId string The guild ID.
locale string The valid locale string to set the value to.
Source:

<protected> debug(msg)

Log using common.logDebug, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source:

end()

Trigger subModule to shutdown and get ready for process terminating.
Inherited From:
Overrides:
Source:

<protected> error(msg)

Log using common.error, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source:

getLocale(gId)

Get the locale string for a specified guild.
Parameters:
Name Type Description
gId string The ID of the guild to fetch.
Source:
Returns:
Locale string, or null if default.
Type
string

<protected> initialize()

The function called at the end of begin() for further initialization specific to the subModule. Must be defined before begin() is called.
Inherited From:
Overrides:
Source:

langToLocale(lang)

Get the locale of the given language strings.
Parameters:
Name Type Description
lang string The language string to lookup in the map.
Source:
Returns:
Locale string, or null if unable to find.
Type
string

<protected> log(msg)

Log using common.log, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source:

<abstract> reloadable()

Check if this module is in a state that is ready to be reloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state. This is different from unloadable, which checks if this module can be stopped completely, this checks if the module can be stopped and restarted.
Inherited From:
Overrides:
Source:
See:
  • SubModule~unloadable
Returns:
True if can be reloaded, false if cannot.
Type
boolean

<abstract> save( [opt])

Saves all data to files necessary for saving current state.
Parameters:
Name Type Argument Default Description
opt string <optional>
'sync' Can be 'async', otherwise defaults to synchronous.
Inherited From:
Overrides:
Source:

<protected> shutdown()

Shutdown and disable this submodule. Removes all event listeners.
Inherited From:
Overrides:
Source:

<abstract> unloadable()

Check if this module is in a state that is ready to be unloaded. If false is returned, this module should not be unloaded and doing such may risk putting the module into an uncontrollable state.
Inherited From:
Overrides:
Source:
See:
  • SubModule~reloadable
Returns:
True if can be unloaded, false if cannot.
Type
boolean

<protected> warn(msg)

Log using common.logWarning, but automatically set name.
Parameters:
Name Type Description
msg string The message to log.
Inherited From:
Overrides:
Source: