Yarn Namespace

Summary

Contains classes for working with compiled Yarn programs.

Classes

Name
Description
​BuiltinTypes​
Contains the built-in types available in the Yarn language.
​Dialogue​
Co-ordinates the execution of Yarn programs.
​DialogueException​
An exception that is thrown by Dialogue when there is an error in executing a Program .
​FunctionType​
A type that represents functions.
​Library​
A collection of functions that can be called from Yarn programs.
A simple concrete implementation of IVariableStorage that keeps all variables in memory.
​Node​
A node of Yarn script, contained within a Program , and containing Yarn.Instruction s.
​Program​
A compiled Yarn program.

Delegates

Name
Description
​CommandHandler​
Represents the method that is called when the Dialogue delivers a Command .
Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.
​LineHandler​
Represents the method that is called when the Dialogue delivers a Line .
​Logger​
Represents a method that receives diagnostic messages and error information from a Dialogue .
Represents the method that is called when the Dialogue reaches the end of a node.
​NodeStartHandler​
Represents the method that is called when the Dialogue begins executing a node.
​OptionsHandler​
Represents the method that is called when the Dialogue delivers an OptionSet .
Represents the method that is called when the dialogue anticipates that it will deliver lines.

Interfaces

Name
Description
​IType​
Defines properties that describe a type in the Yarn language.
​IVariableStorage​
Provides a mechanism for storing and retrieving instances of the Yarn.Value class.

Namespaces

Name
Description
​Yarn.Compiler​
Contains classes for compiling Yarn code.
​Yarn.Markup​
Contains classes for working with markup in Yarn lines.
​Yarn.Unity​
Contains classes for working with Yarn Spinner in the Unity game engine.

Structs

Name
Description
​Command​
A command, sent from the Dialogue to the game.
​Line​
A line of dialogue, sent from the Dialogue to the game.
​OptionSet​
A set of Option s, sent from the Dialogue to the game.
Export as PDF
Copy link
Edit on GitHub