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).

YarnLineParser

parses text and produces markup information.
class_name YarnLineParser
extends RefCounted

Inherits from RefCounted

#Nested Types

#Constants

#CHARACTER_ATTRIBUTE

implicitly-generated character attribute name.
const CHARACTER_ATTRIBUTE = "character"

#CHARACTER_ATTRIBUTE_NAME_PROPERTY

'name' property key on the character attribute.
const CHARACTER_ATTRIBUTE_NAME_PROPERTY = "name"

#NO_MARKUP_ATTRIBUTE

attribute to indicate no marker processing.
const NO_MARKUP_ATTRIBUTE = "nomarkup"

#REPLACEMENT_MARKER_CONTENTS

property name in replacement attributes that contains the text.
const REPLACEMENT_MARKER_CONTENTS = "contents"

#TRIM_WHITESPACE_PROPERTY

property to signify trailing whitespace trimming.
const TRIM_WHITESPACE_PROPERTY = "trimwhitespace"

#Methods

#create_with_builtin_replacers()

static func create_with_builtin_replacers() -> YarnLineParser

Returns YarnLineParser

#deregister_marker_processor(String)

func deregister_marker_processor(attribute_name: String) -> void

Parameters

  • attribute_nameString

#expand_substitutions(String, Array)

static func expand_substitutions(text: String, substitutions: Array) -> String

Parameters

  • textString
  • substitutionsArray

Returns String

#parse_string_and_include_markup_diagnostics(String, String, bool)

func parse_string_and_include_markup_diagnostics(input: String, locale_code: String, add_implicit_character: bool = true) -> Dictionary

Parameters

  • inputString
  • locale_codeString
  • add_implicit_characterbool

Returns Dictionary

#parse_string(String, String, bool)

parse a string and produce a markup parse result.
func parse_string(input: String, locale_code: String, add_implicit_character: bool = true) -> YarnMarkupParseResult

Parameters

  • inputString
  • locale_codeString
  • add_implicit_characterbool

Returns YarnMarkupParseResult

#register_marker_processor(String, YarnAttributeMarkerProcessor)

func register_marker_processor(attribute_name: String, processor: YarnAttributeMarkerProcessor) -> void

Parameters

Generated from Yarn Spinner for Godot GDScript 3.3.