Class: Messages

Members

---

<private> _messages :EnUsHGMessages

All messages to show for games. Parsed from locale file.

Type:

• EnUsHGMessages

Source:

• hg/Messages.js, line 22

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:

• hg/Messages.js, line 71

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:

• hg/Messages.js, line 42

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:

• hg/Messages.js, line 30