Scripting API
Scripting API
LocalizedString
Struct in Abyss.Core, from Abyss.Core.
A string of the game's a component names: an entry of a string table, said in the player's language by Localization.Text. Its Inspector slot picks it as Localize picks a UI text's, and code gives it a key: Label = Strings.Menu.Play.
public readonly struct LocalizedStringRemarks
The table's identity and the entry's, never their names, so renaming either breaks nothing: a scene writes the entry's name beside them, for whoever reads it.
Twenty-four bytes, described as one field of three whole numbers: the table's identity's first eight bytes and its last, as PrefabRef holds a prefab's, then the entry's. A component holding one is copied, written and read back as any is.
Constructors
LocalizedString
public LocalizedString(AssetGuid table, uint entry)The entry entry of the table of identity table.
Parameters
tableentry
LocalizedString
public LocalizedString(ulong low, ulong high, ulong entry)A string made of the three numbers it is held as.
Parameters
low: The table's identity's first eight bytes, little-endian.high: Its last eight.entry: The entry's identity.
Properties
None
public static LocalizedString None { get; }No string.
IsNone
public bool IsNone { get; }Whether this names no string.
Table
public AssetGuid Table { get; }The table's identity; AssetGuid.None for none.
Entry
public uint Entry { get; }The entry's identity in its table.
Low
public ulong Low { get; }The table's identity's first eight bytes, as the field's first number holds them.
High
public ulong High { get; }Its last eight, as the field's second number holds them.
Methods
Equals
public bool Equals(LocalizedString other)Parameters
other
Equals
public override bool Equals(object? obj)Parameters
obj
GetHashCode
public override int GetHashCode()ToString
public override string ToString()The table's identity and the entry's, or none.
Operators
implicit operator LocalizedString
public static implicit operator LocalizedString(StringKey key)The string a key names, its name left behind: Label = Strings.Menu.Play.
Parameters
key
operator ==
public static bool operator ==(LocalizedString left, LocalizedString right)Two references to one string.
Parameters
leftright
operator !=
public static bool operator !=(LocalizedString left, LocalizedString right)Two references to different strings.
Parameters
leftright
