All pages
Powered by GitBook
1 of 11

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Asset

Field in

The asset associated with this line, if any.

InvalidLine

Field in

A object that represents content not being found.

public Object? Asset;

Summary

LocalizedLine
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>())};

Summary

LocalizedLine
LocalizedLine

LocalizedLine

Class in Yarn.Unity

Inherits from System.Object

Summary

Represents a line, ready to be presented to the user in the localisation they have specified.

public class LocalizedLine

Fields

Name
Description

Name
Description

Metadata

Field in

Any metadata associated with this line.

public string[] Metadata = System.Array.Empty<string>();

Summary

LocalizedLine

The asset associated with this line, if any.

A object that represents content not being found.

Any metadata associated with this line.

DialogueLine's text

The object that created this line. Most of the time will be the that passed the presenter the line.

DialogueLine's inline expression's substitution

DialogueLine's ID

The name of the character, if present.

The underlying for this line.

Properties

Asset

The underlying for this line, with any character attribute removed.

InvalidLine
LocalizedLine
Metadata
RawText
Source
DialogueRunner
Substitutions
TextID
CharacterName
Text
MarkupParseResult
TextWithoutCharacterName
MarkupParseResult

Source

Field in

The object that created this line. Most of the time will be the that passed the presenter the line.

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 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.

public object? Source;

Summary

Remarks

LocalizedLine
DialogueRunner
VoiceOverPresenter

Text

Property in

The underlying for this line.

public Markup.MarkupParseResult Text { get; set; }

Summary

LocalizedLine
MarkupParseResult

CharacterName

Property in

The name of the character, if present.

This value will be null if the line does not have a character name.

public string? CharacterName { get; }

Summary

Remarks

LocalizedLine

TextWithoutCharacterName

Property in

The underlying for this line, with any character attribute removed.

If the line has no character attribute, this method returns the same value as .

public Markup.MarkupParseResult TextWithoutCharacterName { get; }

Summary

Remarks

LocalizedLine
MarkupParseResult
Text

Substitutions

Field in

DialogueLine's inline expression's substitution

public string[] Substitutions = System.Array.Empty<string>();

Summary

LocalizedLine

RawText

Field in

DialogueLine's text

public string? RawText;

Summary

LocalizedLine

TextID

Field in

DialogueLine's ID

public string TextID = "<unknown>";

Summary

LocalizedLine