All pages
Powered by GitBook
1 of 8

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Metadata

Field in LocalizedLine

Summary

Any metadata associated with this line.

public string[] Metadata;

Substitutions

Field in LocalizedLine

Summary

DialogueLine's inline expression's substitution

public string[] Substitutions;

Text

Property in LocalizedLine

Summary

The underlying Yarn.Markup.MarkupParseResult for this line.

public Markup.MarkupParseResult Text { get; set; }

RawText

Field in LocalizedLine

Summary

DialogueLine's text

public string RawText;

CharacterName

Property in LocalizedLine

Summary

The name of the character, if present.

public string CharacterName
{
            get; }

Remarks

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

TextID

Field in

Summary

DialogueLine's ID

TextWithoutCharacterName

Property in

Summary

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

public string TextID;
LocalizedLine
Remarks

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

public Markup.MarkupParseResult TextWithoutCharacterName
{
            get; }
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

Properties

Name
Description

Metadata

Any metadata associated with this line.

RawText

DialogueLine's text

Substitutions

DialogueLine's inline expression's substitution

TextID

DialogueLine's ID

CharacterName

The name of the character, if present.

Text

The underlying Yarn.Markup.MarkupParseResult for this line.

TextWithoutCharacterName

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