Class TimbnPluginText

Namespace

Timbn.GraveyardKeeperTwo.Core.Framework

Assembly

Timbn.GraveyardKeeperTwo.Core.dll

Adds or overrides the game's text on behalf of a plugin. Quest names, dialog lines, item names, and any other text the game shows is looked up by localization key, and the keys added here are written into the loaded language and every language loaded later. They are removed when the plugin unloads, putting back any shipped text they overrode. Reach it through the plugin's Text property.

public sealed class TimbnPluginText

Inheritance

object

TimbnPluginText

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Core also loads the plugin's lang folder next to its DLL when the plugin starts, so players can translate a mod without rebuilding it. Each file is named after a game language id, such as lang/en.txt, lang/de.txt, or lang/pt-br.txt, and holds one "timbn_larry_boards_given = Here, take these." line per key. Lines starting with # are comments, and \n in a text is a line break. The game shows the line for its current language and falls back to en.txt for any key a translation lacks, so en.txt should hold every key. Switching language in the game's options picks up the new text. Text from lang files wins over text added in code for the same key. Ship the files by marking them CopyToOutputDirectory in the csproj.

Methods

Add(IReadOnlyDictionary<string, string>)

Adds or overrides several localization keys. When the same key is added more than once, the most recently added text wins, except that text from a lang file always beats text added in code.

public IDisposable Add(IReadOnlyDictionary<string, string> texts)

Parameters

texts IReadOnlyDictionary<string, string>

Text by key.

Returns

IDisposable

A handle that removes the keys early when disposed. You don't need to keep it.

Add(string, string)

Adds or overrides one localization key.

public IDisposable Add(string key, string text)

Parameters

key string

The key the game looks the text up by.

text string

The text to show.

Returns

IDisposable

A handle that removes the key early when disposed. You don't need to keep it.