Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

MarkupParseResult

The result of parsing a line of marked-up text.
public struct MarkupParseResult

Inherits from System.ValueType

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

See also

  • Yarn.Markup.LineParser.ParseString

#Constructors

#MarkupParseResult(string, List<MarkupAttribute>)

Initializes a new instance of the MarkupParseResult struct.
public MarkupParseResult(string text, List<MarkupAttribute> attributes)

Parameters

  • textstring
    The plain text.
  • attributesSystem.Collections.Generic.List<Yarn.Markup.MarkupAttribute>
    The list of attributes.

#Properties

#Attributes

The list of MarkupAttributes in this parse result.
public List<MarkupAttribute> Attributes { get; }

Type List

#Text

The original text, with all parsed markers removed.
public string Text { get; }

Type String

#Methods

#DeleteRange(MarkupAttribute)

Deletes an attribute from this markup.
public readonly MarkupParseResult DeleteRange(MarkupAttribute attributeToDelete)

Parameters

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

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.

#TextForAttribute(MarkupAttribute)

Returns the substring of Text covered by attribute Position and Length properties.
public readonly string TextForAttribute(MarkupAttribute attribute)

Parameters

Returns String: The text contained within the attribute.

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.

#TryGetAttributeWithName(string, MarkupAttribute)

Gets the first attribute with the specified name, if present.
public readonly bool TryGetAttributeWithName(string name, out MarkupAttribute attribute)

Parameters

  • namestring
    The name of the attribute to get.
  • When this method returns, contains the attribute with the specified name, if the attribute is found; otherwise, the default MarkupAttribute. This parameter is passed uninitialized.

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

Generated from Yarn Spinner for Unity 3.3.