Field in

Summary

Field in LineParser

Summary

The name of the property in replacement attributes that contains the text of the attribute.

public const string ReplacementMarkerContents = "contents";

Field in LineParser

Summary

The name of the 'name' property, on the implicitly-generated character attribute.

public const string CharacterAttributeNameProperty = "name";

See Also

• LineParser.CharacterAttribute: The name of the implicitly-generated character attribute.

Field in LineParser

Summary

The name of the implicitly-generated character attribute.

public const string CharacterAttribute = "character";

See Also

• LineParser.CharacterAttributeNameProperty: The name of the 'name' property, on the implicitly-generated character attribute.

Field in LineParser

Summary

The name of the property to use to signify that trailing whitespace should be trimmed if a tag had preceding whitespace or begins the line. This property must be a bool value.

public const string TrimWhitespaceProperty = "trimwhitespace";

Field in LineParser

Summary

public const string NoMarkupAttribute = "nomarkup";

Class in Yarn.Markup

Inherits from System.Object

Summary

Parses text and produces markup information.

public class LineParser

Fields

Methods

Structs

Method in LineParser

Summary

public MarkupParseResult ParseString(string input, string localeCode, bool squish = true, bool sort = true, bool addImplicitCharacterAttribute = true)

Parameters

Method in LineParser

Summary

Replaces all substitution markers in a text with the given substitution list.

public static string ExpandSubstitutions(string text, IList<string> substitutions)

Remarks

This method replaces substitution markers - for example, {0}

• with the corresponding entry in substitutions . If text contains a substitution marker whose index is not present in substitutions , it is ignored.

Parameters

Returns

text , with the content from substitutions inserted.

Struct in LineParser

Inherits from System.ValueType

Summary

public struct MarkupDiagnostic

Constructors

Fields

Methods

TYPENAME_UNKNOWN_PLURAL

Method in

Summary

Parameters

Field in MarkupDiagnostic

Summary

public string message;

Field in MarkupDiagnostic

Summary

public int column;

Method in LineParser

Summary

public void DeregisterMarkerProcessor(string attributeName)

Parameters

TYPENAME_UNKNOWN in

Summary

TYPENAME_UNKNOWN in

Summary

Method in MarkupDiagnostic

Summary

public override int GetHashCode()

Constructor in MarkupDiagnostic

Summary

public MarkupDiagnostic(string message, int column = -1)

Parameters

Method in MarkupDiagnostic

Summary

public override bool Equals(object obj)

Parameters

Method in LineParser

Summary

Registers an object as a marker processor for a given marker name.

public void RegisterMarkerProcessor(string attributeName, IAttributeMarkerProcessor markerProcessor)

Remarks

When a marker processor is registered for a marker name, the parser will ask the processor for text to insert into the plain text. This allows users of the LineParser class to dynamically replace text in a line. The nomarkup tag is implemented in this way by the LineParser class directly; the Dialogue class uses this mechanism to implement the select , plural and ordinal markers.

Parameters