LocalizedLine
Represents a line, ready to be presented to the user in the localisation
they have specified.
public class LocalizedLineInherits from System.Object
#Fields
#Asset
The asset associated with this line, if any.
public Object? Asset;Type Nullable
#InvalidLine
A LocalizedLine object that represents content not
being found.
public static readonly LocalizedLine InvalidLine = new LocalizedLine{Asset = null, Metadata = System.Array.Empty<string>(), RawText = "!! ERROR: Missing line!", Substitutions = System.Array.Empty<string>(), TextID = "<missing>", Text = new Markup.MarkupParseResult("!! ERROR: Missing line!", new System.Collections.Generic.List<Markup.MarkupAttribute>())};Type LocalizedLine
#Metadata
Any metadata associated with this line.
public string[] Metadata = System.Array.Empty<string>();#RawText
DialogueLine's text
public string? RawText;Type String
#Source
The object that created this line.
Most of the time will be the DialogueRunner that passed the presenter the line.
public object? Source;Type Object
This exists for situations where you need the dialogue runner (or your custom equivalent) to send back messages.
In particular this is used by the VoiceOverPresenter to get a reference to the dialogue runner to advance lines after playback is finished without needing a specific reference.
Allowing the presenter to be reused across multiple runners.
#Substitutions
DialogueLine's inline expression's substitution
public string[] Substitutions = System.Array.Empty<string>();#TextID
DialogueLine's ID
public string TextID = "<unknown>";Type String
#Properties
#CharacterName
The name of the character, if present.
public string? CharacterName { get; }Type String
This value will be
null if the line does not have
a character name.#Text
The underlying MarkupParseResult for this
line.
public Markup.MarkupParseResult Text { get; set; }Type MarkupParseResult
#TextWithoutCharacterName
The underlying MarkupParseResult for this
line, with any `character` attribute removed.
public Markup.MarkupParseResult TextWithoutCharacterName { get; }Type MarkupParseResult
If the line has no `character` attribute, this method returns the
same value as Text.
Generated from Yarn Spinner for Unity 3.3.