Scripting API

Scripting API

StringEntry

Class in Abyss.Core, from Abyss.Core.

One entry of a string table: its name, its identity, and what it says in each language, a text, or for a string with a count, a text for each plural form of the language.

public sealed class StringEntry

Properties

Key

public string Key { get; set; }

Its name, which code names it by: Play in Strings.Menu.Play.

Id

public uint Id { get; }

Its identity in the table, given when it was made, kept through a rename, and never another entry's.

Plural

public string? Plural { get; set; }

The argument its plural forms are picked by, count unless it says another; null for an entry with one text a language.

Note

public string? Note { get; set; }

What a translator is told of it — "Main menu button, 12 letters at most" — kept in the table and its spreadsheets, never in a build; null for none.

Texts

public Dictionary<string, string> Texts { get; }

Each language's text, by its code, for an entry with one text a language.

Forms

public Dictionary<string, SortedDictionary<PluralCategory, string>> Forms { get; }

Each language's text for each plural form, by its code, for an entry with plural forms.

Methods

Has

public bool Has(string language)

Whether it says anything in a language: a text, or a form.

Parameters

  • language