Summary

Contains classes for working with markup in Yarn lines.

Classes

Enums

Interfaces

Structs

Class in Yarn.Markup

Inherits from System.Object

Summary

A marker processor that handles the built-in markers [select] [plural] , and [ordinal] .

public class BuiltInMarkupReplacer : IAttributeMarkerProcessor

Methods

Method in BuiltInMarkupReplacer

Summary

Produces replacement text for a marker.

Parameters

Returns

The collection of diagnostics produced during processing, and the number of invisible characters created during processing.

Interface in Yarn.Markup

Summary

Provides a mechanism for producing replacement text for a marker.

Methods

See Also

• LineParser.RegisterMarkerProcessor(string,IAttributeMarkerProcessor): Registers an object as a marker processor for a given marker name.

• LineParser.DeregisterMarkerProcessor(string): Removes any marker processor associated with a given marker name.

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 '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 attribute to use to indicate that no marker processing should occur.

public const string NoMarkupAttribute = "nomarkup";

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 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";

Method in LineParser

Summary

Removes any marker processor associated with a given marker name.

public void DeregisterMarkerProcessor(string attributeName)

Parameters

Method in LineParser

Summary

public void Dispose()

Method in LineParser

Summary

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

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.

Constructor in MarkupDiagnostic

Summary

Initialises a new instance of the MarkupDiagnostic struct.

Parameters

Method in MarkupDiagnostic

Summary

public override readonly bool Equals(object obj)

Parameters

Method in MarkupDiagnostic

Summary

public readonly bool Equals(MarkupDiagnostic other)

Parameters

Method in MarkupDiagnostic

Summary

public override readonly int GetHashCode()

TYPENAME_UNKNOWN in MarkupDiagnostic

Summary

(no declaration available)

TYPENAME_UNKNOWN in MarkupDiagnostic

Summary

(no declaration available)

Property in MarkupDiagnostic

Summary

Gets the zero-based column index of the start of the range at which this diagnostic appears.

public int Column { get; }

Property in MarkupDiagnostic

Summary

Gets the text of the diagnostic.

public string Message { get; }

Method in MarkupAttribute

Summary

Creates a new MarkupAttribute based on the current instance whose Position is shifted towards the end of the string by shift characters.

Parameters

Returns

A new MarkupAttribute with an updated Position .

Method in MarkupAttribute

Summary

public override readonly string ToString()

Method in MarkupAttribute

Summary

Gets a boolean property named name from this attribute, if present.

Parameters

Returns

true if a property named name was found; false otherwise.

Method in MarkupAttribute

Summary

Gets an integer property named name from this attribute, if present.

Parameters

Returns

true if a property named name was found; false otherwise.

Method in MarkupAttribute

Summary

Gets a float property named name from this attribute, if present.

Parameters

Returns

true if a property named name was found; false otherwise.

Method in MarkupAttribute

Summary

Gets a string property named name from this attribute, if present.

Parameters

Returns

true if a property named name was found; false otherwise.

Property in MarkupAttribute

Summary

Gets the number of text elements in the plain text that this attribute covers.

public int Length { get; internal set; }

Property in MarkupAttribute

Summary

Gets the name of the attribute.

public string Name { get; internal set; }

Property in MarkupAttribute

Summary

Gets the position in the plain text where this attribute begins.

public int Position { get; internal set; }

Property in MarkupAttribute

Summary

Gets the properties associated with this attribute.

public IReadOnlyDictionary<string, MarkupValue> Properties { get; internal set; }

Class in Yarn.Markup

Inherits from System.Exception

Summary

An exception representing something going wrong when parsing markup.

public class MarkupParseException : Exception

See Also

• LineParser: Parses text and produces markup information.

Constructor in MarkupParseResult

Summary

Initializes a new instance of the MarkupParseResult struct.

Parameters

Property in MarkupParseResult

Summary

The list of MarkupAttribute s in this parse result.

public List<MarkupAttribute> Attributes { get; }

Property in MarkupParseResult

Summary

The original text, with all parsed markers removed.

public string Text { get; }

Property in MarkupProperty

Summary

Gets the name of the property.

public string Name { get; private set; }

Property in MarkupProperty

Summary

Gets the value of the property.

public MarkupValue Value { get; private set; }

Method in MarkupValue

Summary

public readonly override string ToString()

Method in MarkupValue

Summary

public readonly string ToString(IFormatProvider formatProvider)

Parameters

Property in MarkupValue

Summary

Gets the bool value of this property.

public bool BoolValue { get; internal set; }

Remarks

This property is only defined when the property's Type is Bool .

Property in MarkupValue

Summary

Gets the float value of this property.

public float FloatValue { get; internal set; }

Remarks

This property is only defined when the property's Type is Float .

Property in MarkupValue

Summary

Gets the string value of this property.

public string StringValue { get; internal set; }

Remarks

This property is only defined when the property's Type is String .

Property in MarkupValue

Summary

Gets the value's type.

public MarkupValueType Type { get; internal set; }

Enumeration Member in MarkupValueType

Summary

A bool.

Bool

Enumeration Member in MarkupValueType

Summary

A float.

Float

Enumeration Member in MarkupValueType

Summary

An integer.

Integer

Field in ReplacementMarkerResult

Summary

The collection of diagnostics produced during processing, if any.

public List<LineParser.MarkupDiagnostic> Diagnostics;

Method in LineParser

Summary

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

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

Method in LineParser

Summary

Parses a string of text and produces a markup parse result.

Parameters

Returns

A markup parse result.

Method in MarkupParseResult

Summary

Returns the substring of Text covered by attribute Position and Length properties.

Remarks

If the attribute's Length property is zero, this method returns the empty string.

This method does not check to see if attribute is an attribute belonging to this MarkupParseResult. As a result, if you pass an attribute that doesn't belong, it may describe a range of text that does not appear in Text. If this occurs, an System.IndexOutOfRangeException will be thrown.

Parameters

Returns

The text contained within the attribute.

Struct in Yarn.Markup

Inherits from System.ValueType

Summary

A property associated with a MarkupAttribute .

Remarks

You do not create instances of this struct yourself. It is created by objects that can parse markup, such as LineParser .

Properties

See Also

• Yarn.Markup.LineParser.ParseString(System.String,System.String,System.Boolean,System.Boolean,System.Boolean):

Method in MarkupParseResult

Summary

Deletes an attribute from this markup.

Remarks

This method deletes the range of text covered by attributeToDelete , and updates the other attributes in this markup as follows:

• Attributes that start and end before the deleted attribute are unmodified.

• Attributes that start before the deleted attribute and end inside it are truncated to remove the part overlapping the deleted attribute.

• Attributes that have the same position and length as the deleted attribute are deleted, if they apply to any text.

• Attributes that start and end within the deleted attribute are deleted.

• Attributes that start within the deleted attribute, and end outside it, have their start truncated to remove the part overlapping the deleted attribute.

• Attributes that start after the deleted attribute have their start point adjusted to account for the deleted text.

This method does not modify the current object. A new MarkupParseResult is returned.

If attributeToDelete is not an attribute of this MarkupParseResult, the behaviour is undefined.

Parameters

Returns

A new MarkupParseResult object, with the plain text modified and an updated collection of attributes.

Method in IAttributeMarkerProcessor

Summary

Produces replacement text for a marker.

Parameters

Returns

The collection of diagnostics produced during processing, and the number of invisible characters created during processing.

Enumeration Member in MarkupValueType

Summary

A string.

String

Property in MarkupValue

Summary

Gets the integer value of this property.

public int IntegerValue { get; internal set; }

Remarks

This property is only defined when the property's Type is Integer .

Enumeration Member in TagType

Summary

A closing marker. For example, [/a] .

Close

Constructor in ReplacementMarkerResult

Summary

Convenience constructor for replacement markup results.

Parameters

Enumeration Member in TagType

Summary

The close-all marker, [/] .

CloseAll

Enumeration Member in TagType

Summary

An open marker. For example, [a] .

Open

Field in ReplacementMarkerResult

Summary

The number of invisible characters added into the line during processing.

Remarks

This will vary depending on what the replacement markup needs to do.

• When only inserting rich-text tags, this should be the length of all inserted text. For example "this is text with [bold]some bold[/bold] elements" translated into Unity style rich-text become "this is text with <b>some bold</b> elements". In this case then the value of InvisibleCharacters would be seven.

• When only modifying the content of the children text, such as making all text upper case, this should be 0. For example "this is text with [upper]some uppercased[/upper] elements" is transformed into "this is text with SOME UPPERCASED elements". The number of invisible character will be zero.

• When adding new content into the line (regardless of being added at the start, end, or middle) this should be zero but the replacement processor should make sure to shift along it's children attributes where appropriate. For example "this is text with [emph]some emphasised[/emph] elements" transformed into "this is text with !!some emphasised!! elements" the value of InvisibleCharacters would be zero. In this case however the childAttributes in ProcessReplacementMarker(MarkupAttribute,System.Text.StringBuilder,List<MarkupAttribute>,string) would need to be shifted down two.

Enumeration Member in TagType

Summary

A self-closing marker. For example, [a/] .

SelfClosing

Constructor in ReplacementMarkerResult

Summary

Convenience form of ReplacementMarkerResult(List<LineParser.MarkupDiagnostic>,int) for when there are no diagnostics.

public ReplacementMarkerResult(int invisibleCharacters)

Parameters

Class in Yarn.Markup

Inherits from System.Object

Summary

Parses text and produces markup information.

public sealed class LineParser : IDisposable

Fields

Methods

Structs

Struct in LineParser

Inherits from System.ValueType

Summary

Represents a diagnostic message produced during markup parsing.

public struct MarkupDiagnostic : IEquatable<MarkupDiagnostic>

Constructors

Methods

Properties

TYPENAME_UNKNOWN_PLURAL

Method in MarkupAttribute

Summary

Gets a property named name from this attribute, if present.

public readonly bool TryGetProperty(string name, out MarkupValue result)

Parameters

Returns

true if a property named name was found; false otherwise.

Struct in Yarn.Markup

Inherits from System.ValueType

Summary

The result of parsing a line of marked-up text.

public struct MarkupParseResult

Remarks

You do not create instances of this struct yourself. It is created by objects that can parse markup, such as Dialogue .

Constructors

Methods

Properties

See Also

• Yarn.Markup.LineParser.ParseString(System.String,System.String,System.Boolean,System.Boolean,System.Boolean):

Method in MarkupParseResult

Summary

Gets the first attribute with the specified name, if present.

public readonly bool TryGetAttributeWithName(string name, out MarkupAttribute attribute)

Parameters

Returns

true if the MarkupParseResult contains an attribute with the specified name; otherwise, false .

Struct in Yarn.Markup

Inherits from System.ValueType

Summary

Represents a range of text in a marked-up string.

public struct MarkupAttribute

Remarks

You do not create instances of this struct yourself. It is created by objects that can parse markup, such as LineParser .

Methods

• Yarn.Markup.LineParser.ParseString(System.String,System.String,System.Boolean,System.Boolean,System.Boolean):

Enum in Yarn.Markup

Inherits from System.Enum

Summary

A type of MarkupValue .

public enum MarkupValueType
{
    Integer,
    Float,
    String,
    Bool
#pragma warning restore CA1720
}

Members

Struct in Yarn.Markup

Inherits from System.ValueType

Summary

A bundle of results from processing replacement markers.

public struct ReplacementMarkerResult

Constructors

• : Provides a mechanism for producing replacement text for a marker.

Enum in Yarn.Markup

Inherits from System.Enum

Summary

A type of Yarn.Markup.MarkupAttributeMarker .

public enum TagType
{
    Open,
    Close,
    SelfClosing,
    CloseAll
}

Members

Struct in Yarn.Markup

Inherits from System.ValueType

Summary

A value associated with a MarkupProperty .

public struct MarkupValue

Remarks

You do not create instances of this struct yourself. It is created by objects that can parse markup, such as LineParser .

Methods

• Yarn.Markup.LineParser.ParseString(System.String,System.String,System.Boolean,System.Boolean,System.Boolean):