Module yarnspinner::prelude

Everything you need to get started using Yarn Spinner.

Macros

• yarn_library
  Create a Library from a list of named functions.

Structs

• Compilation
  The result of a compilation.
• CompilerError
  A collection of Diagnostic objects that describe problems that occurred during compilation. At least one of these diagnostics will have a severity of DiagnosticSeverity::Error.
• 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”.
• LineId
  The unique ID of a line in a Yarn script. In a Yarn script, line IDs look like this:
• LineInfo
  Contains positional information about an instruction.
• MarkupAttribute
  Represents a range of text in a marked-up string.
• OptionId
  The identifying number for an option. You should not need to create these yourself, since you get them from DialogueOptions.
• StringInfo
  Information about a string. Stored inside a string table, which is produced from the Compiler.
• YarnAnalysisContext
  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.
• YarnCommand
  A custom command found in a Yarn file within the << and >> characters.
• YarnCompiler
  An object that contains Yarn source code to compile, and instructions on how to compile it.
• YarnFile
  Represents the contents of a file to compile.
• YarnLibrary
  A collection of functions that can be called from Yarn scripts.
• YarnLine
  A line of dialogue, sent from the Dialogue to the game.
• YarnProgram

Enums

• CompilationType
  The types of compilation that the compiler will do.
• DialogueError
• DialogueEvent
  An event encountered while running Dialogue::continue_. A caller is expected to handle these events and act accordingly.
• MarkupValue
  A value associated with a markup name.
• YarnValue
  Represents a Yarn value. The chosen variant corresponds to the last assignment of the value, with the type being inferred from the type checker.

Traits

• IntoYarnValueFromNonYarnValue
  The return value of a [YarnFn]. See [YarnFn] for more information on the kinds of signatures that can be registered.
• 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.
• YarnAnalyser
  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.
• YarnFn
  A function that can be registered into and called from Yarn. It must have the following properties:

Type Aliases

• StringTable
• YarnCompilerResult
• YarnRuntimeResult