yarn.line

Line

Struct in Yarn

Inherits from System.ValueType

Summary

A line of dialogue, sent from the Dialogue to the game.

public struct Line

Remarks

When the game receives a Line, it should do the following things to prepare the line for presentation to the user.

1. Use the value in the ID field to look up the appropriate user-facing text in the string table.
2. Use ExpandSubstitutions(string,IList<string>) to replace all substitutions in the user-facing text.
3. Use Yarn.Markup.LineParser.ParseString(System.String,System.String,System.Boolean,System.Boolean,System.Boolean) to parse all markup in the line.

You typically do not create instances of this struct yourself. They are created by the Dialogue during program execution.

Constructors

Name	Description
Line(string,string[])	Initialises a new instance of the Line struct.

Properties

Name	Description
ID	The string ID for this line.
Substitutions	The values that should be inserted into the user-facing text before delivery.

See Also

• Dialogue.LineHandler: Gets or sets the LineHandler that is called when a line is ready to be shown to the user.