Module yarnspinner::runtime

Types and traits used by the runtime, in particular the Dialogue struct.

Structs

• Command
  A custom command found in a Yarn file within the << and >> characters.
• Context
  A structure that holds several CompiledProgramAnalysers which are used to analyse one or more compiled Yarn programs with Dialogue::analyse. To get the analysis results, call Context::finish_analysis afterwards.
• Diagnosis
  A result of analysing a compiled Yarn program with [Dialogue::analyse]. Created by the [CompiledProgramAnalyser]s used in the given [Context].
• Dialogue
  Co-ordinates the execution of Yarn programs.
• DialogueOption
  An option to be presented to the user.
• Language
  IETF BCP 47 code. The default is “en-US”.
• Line
  A line of dialogue, sent from the Dialogue to the game.
• MarkupAttribute
  Represents a range of text in a marked-up string.
• MemoryVariableStorage
  A simple concrete implementation of VariableStorage that keeps all variables in memory.
• OptionId
  The identifying number for an option. You should not need to create these yourself, since you get them from DialogueOptions.
• StringTableTextProvider
  A basic implementation of TextProvider which keeps the text for the base language, i.e. the language the Yarn files are written in, and the text for the currently selected translation in memory.

Enums

• DiagnosisSeverity
  The severity of a Diagnosis, as reported by a [CompiledProgramAnalyser].
• DialogueError
• DialogueEvent
  An event encountered while running Dialogue::continue_. A caller is expected to handle these events and act accordingly.
• MarkupParseError
• MarkupValue
  A value associated with a markup name.
• VariableStorageError

Constants

• CHARACTER_ATTRIBUTE
  The name of the implicitly-generated character attribute.
• CHARACTER_ATTRIBUTE_NAME_PROPERTY
  The name of the ‘name’ property, on the implicitly-generated character attribute.
• TRIM_WHITESPACE_PROPERTY
  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.

Traits

• CompiledProgramAnalyser
  A trait for analysing a compiled Yarn program. Can be used by adding them to a Context with Context::add_analyser and then applied to a compiled Yarn program with Dialogue::analyse.
• TextProvider
  A trait for providing text to a Dialogue. The default implementation is StringTableTextProvider, which keeps the text for the base language, i.e. the language the Yarn files are written in, and the text for the currently selected translation in memory.
• VariableStorage
  Provides a mechanism for storing and retrieving instances of the YarnValue type.

Type Aliases

• Result
• StringTable