Class: Messages

Messages


new Messages()

Create the instance managing the filesystem.
Source:

Members


<private> _messages :EnUsHGMessages

All messages to show for games. Parsed from locale file.
Type:
  • EnUsHGMessages
Source:

Methods


get(type [, locale] [, rep])

Get a random message of a given type from hgMessages.json.
Parameters:
Name Type Argument Description
type string The message type to get.
locale string <optional>
Language locale of string to get.
rep string <optional>
<repeatable>
Values to replace tags in the chosen string.
Source:
See:
  • (@link Strings~get}
Returns:
A random message of the given type.
Type
string

getMessages( [locale])

Get all messages for the given locale as a serializable object.
Parameters:
Name Type Argument Description
locale string <optional>
The language locale to fetch strings in.
Source:
Returns:
The key-pair mapping of available messages, or null if unable to find locale group.
Type
object

shutdown()

Stop watching for file changes.
Source: