Translations

class Translations : LinkedHashMap<String, TranslationEntry>

This collection holds all translations for the game.

The collection may be instantiated loading any number of languages, but normally it contains either one (player-selected) language or all of them for the translation file writer.

Translatables have two forms: normal or containing placeholders (delimited by square brackets). Translation requests can have a third form: containing {subsentences} - these are split into their components and passed individually back into the translator, therefore they need no entry in this collection

See also

String.tr

for more explanations (below)

Constructors

Translations
Link copied to clipboard
fun Translations()

Types

Companion
Link copied to clipboard
object Companion

Functions

afterNodeAccess
Link copied to clipboard
open override fun afterNodeAccess(p0: HashMap.Node<String, TranslationEntry>)
afterNodeInsertion
Link copied to clipboard
open override fun afterNodeInsertion(p0: Boolean)
afterNodeRemoval
Link copied to clipboard
open override fun afterNodeRemoval(p0: HashMap.Node<String, TranslationEntry>)
capacity
Link copied to clipboard
fun capacity(): Int
clear
Link copied to clipboard
open override fun clear()
clone
Link copied to clipboard
open override fun clone(): Any
compute
Link copied to clipboard
open override fun compute(p0: String, p1: BiFunction<in String, in TranslationEntry?, out TranslationEntry?>): TranslationEntry?
computeIfAbsent
Link copied to clipboard
open override fun computeIfAbsent(p0: String, p1: Function<in String, out TranslationEntry>): TranslationEntry
computeIfPresent
Link copied to clipboard
open override fun computeIfPresent(p0: String, p1: BiFunction<in String, in TranslationEntry, out TranslationEntry?>): TranslationEntry?
containsKey
Link copied to clipboard
open override fun containsKey(key: String): Boolean
containsValue
Link copied to clipboard
open override fun containsValue(value: TranslationEntry): Boolean
createTranslations
Link copied to clipboard
private fun createTranslations(language: String, languageTranslations: HashMap<String, String>)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
forEach
Link copied to clipboard
open override fun forEach(p0: BiConsumer<in String, in TranslationEntry>)
get
Link copied to clipboard
open operator override fun get(key: String): TranslationEntry?
fun get(text: String, language: String, activeMods: HashSet<String>? = null): TranslationEntry?

Searches for the translation entry of a given text for a given language. This includes translations provided by mods from activeMods

getConditionalOrder
Link copied to clipboard
fun getConditionalOrder(language: String): String
getLanguages
Link copied to clipboard
fun getLanguages(): LinkedHashSet<String>

Get all languages present in this, used for TranslationFileWriter and TranslationTests

getLanguagesWithTranslationFile
Link copied to clipboard
private fun getLanguagesWithTranslationFile(): List<String>

Get a list of supported languages for readAllLanguagesTranslation

getNode
Link copied to clipboard
fun getNode(p0: Int, p1: Any): HashMap.Node<String, TranslationEntry>
getOrDefault
Link copied to clipboard
open override fun getOrDefault(key: String, defaultValue: TranslationEntry): TranslationEntry
getSpaceEquivalent
Link copied to clipboard
fun getSpaceEquivalent(language: String): String

Returns the equivalent of a space in the given language Defaults to a space if no translation is provided

getText
Link copied to clipboard
fun getText(text: String, language: String, activeMods: HashSet<String>? = null): String
hashCode
Link copied to clipboard
open override fun hashCode(): Int
internalWriteEntries
Link copied to clipboard
open override fun internalWriteEntries(p0: ObjectOutputStream)
isEmpty
Link copied to clipboard
open override fun isEmpty(): Boolean
linkNodeLast
Link copied to clipboard
private open fun linkNodeLast(p0: LinkedHashMap.Entry<String, TranslationEntry>)
loadFactor
Link copied to clipboard
fun loadFactor(): Float
loadPercentageCompleteOfLanguages
Link copied to clipboard
fun loadPercentageCompleteOfLanguages()
merge
Link copied to clipboard
open override fun merge(p0: String, p1: TranslationEntry, p2: BiFunction<in TranslationEntry, in TranslationEntry, out TranslationEntry?>): TranslationEntry?
newNode
Link copied to clipboard
open override fun newNode(p0: Int, p1: String, p2: TranslationEntry, p3: HashMap.Node<String, TranslationEntry>): HashMap.Node<String, TranslationEntry>
newTreeNode
Link copied to clipboard
open override fun newTreeNode(p0: Int, p1: String, p2: TranslationEntry, p3: HashMap.Node<String, TranslationEntry>): HashMap.TreeNode<String, TranslationEntry>
placeConditionalsAfterUnique
Link copied to clipboard
fun placeConditionalsAfterUnique(language: String): Boolean
put
Link copied to clipboard
open override fun put(key: String, value: TranslationEntry): TranslationEntry?
putAll
Link copied to clipboard
open override fun putAll(from: Map<out String, TranslationEntry>)
putIfAbsent
Link copied to clipboard
open override fun putIfAbsent(p0: String, p1: TranslationEntry): TranslationEntry?
putMapEntries
Link copied to clipboard
fun putMapEntries(p0: MutableMap<out String, out TranslationEntry>, p1: Boolean)
putVal
Link copied to clipboard
fun putVal(p0: Int, p1: String, p2: TranslationEntry, p3: Boolean, p4: Boolean): TranslationEntry
readAllLanguagesTranslation
Link copied to clipboard
fun readAllLanguagesTranslation(printOutput: Boolean = false)

Ensure all languages are loaded, used by TranslationFileWriter and TranslationTests

readObject
Link copied to clipboard
private open fun readObject(p0: ObjectInputStream)
reinitialize
Link copied to clipboard
open override fun reinitialize()
remove
Link copied to clipboard
open override fun remove(key: String): TranslationEntry?
open override fun remove(key: String, value: TranslationEntry): Boolean
removeEldestEntry
Link copied to clipboard
open fun removeEldestEntry(p0: MutableMap.MutableEntry<String, TranslationEntry>): Boolean
removeNode
Link copied to clipboard
fun removeNode(p0: Int, p1: Any, p2: Any, p3: Boolean, p4: Boolean): HashMap.Node<String, TranslationEntry>
replace
Link copied to clipboard
open override fun replace(p0: String, p1: TranslationEntry): TranslationEntry?
open override fun replace(p0: String, p1: TranslationEntry, p2: TranslationEntry): Boolean
replaceAll
Link copied to clipboard
open override fun replaceAll(p0: BiFunction<in String, in TranslationEntry, out TranslationEntry>)
replacementNode
Link copied to clipboard
replacementTreeNode
Link copied to clipboard
resize
Link copied to clipboard
fun resize(): Array<HashMap.Node<String, TranslationEntry>>
shouldCapitalize
Link copied to clipboard
fun shouldCapitalize(language: String): Boolean
toString
Link copied to clipboard
open override fun toString(): String
transferLinks
Link copied to clipboard
private open fun transferLinks(p0: LinkedHashMap.Entry<String, TranslationEntry>, p1: LinkedHashMap.Entry<String, TranslationEntry>)
treeifyBin
Link copied to clipboard
fun treeifyBin(p0: Array<HashMap.Node<String, TranslationEntry>>, p1: Int)
tryReadTranslationForCurrentLanguage
Link copied to clipboard
fun tryReadTranslationForCurrentLanguage()
tryReadTranslationForLanguage
Link copied to clipboard
private fun tryReadTranslationForLanguage(language: String, printOutput: Boolean)

This reads all translations for a specific language, including all installed mods. Vanilla translations go into this instance, mod translations into modsWithTranslations.

writeObject
Link copied to clipboard
private open fun writeObject(p0: ObjectOutputStream)

Properties

accessOrder
Link copied to clipboard
val accessOrder: Boolean
entries
Link copied to clipboard
open override val entries: MutableSet<MutableMap.MutableEntry<String, TranslationEntry>>
entrySet
Link copied to clipboard
head
Link copied to clipboard
val head: LinkedHashMap.Entry<String, TranslationEntry>
keys
Link copied to clipboard
open override val keys: MutableSet<String>
keySet
Link copied to clipboard
val keySet: MutableSet<String>
loadFactor
Link copied to clipboard
val loadFactor: Float
modCount
Link copied to clipboard
val modCount: Int
modsWithTranslations
Link copied to clipboard
internal var modsWithTranslations: HashMap<String, Translations>
percentCompleteOfLanguages
Link copied to clipboard
var percentCompleteOfLanguages: HashMap<String, Int>

: Holds the completion percentage for each language, read from its file "completionPercentages.properties" which is generated by the TranslationFileWriter utility.

size
Link copied to clipboard
open override val size: Int
size
Link copied to clipboard
val size: Int
table
Link copied to clipboard
val table: Array<HashMap.Node<String, TranslationEntry>>
tail
Link copied to clipboard
val tail: LinkedHashMap.Entry<String, TranslationEntry>
threshold
Link copied to clipboard
val threshold: Int
translationActiveMods
Link copied to clipboard
var translationActiveMods: LinkedHashSet<String>
values
Link copied to clipboard
open override val values: MutableCollection<TranslationEntry>
values
Link copied to clipboard
val values: MutableCollection<TranslationEntry>

Sources

jvm source
Link copied to clipboard