yarn

Yarn Namespace

Summary

Contains classes for working with compiled Yarn programs.

Classes

Name	Description
ConstantTypeProperty	Represents a property that belongs to a type and contains a read-only value.
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 .
EnumBase	The base type for all enumeration types.
EnumType	A type that represents enumerations.
FunctionType	A type that represents a function.
Header
Library	A collection of functions that can be called from Yarn programs.
MemoryVariableStore	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.
TypeBase	Provides the base class for all concrete types.
Types	Contains the built-in types available in the Yarn language.

Delegates

Name	Description
CommandHandler	Represents the method that is called when the Dialogue delivers a Command .
DialogueCompleteHandler	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 .
NodeCompleteHandler	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 .
PrepareForLinesHandler	Represents the method that is called when the dialogue anticipates that it will deliver lines.

Enums

Name	Description
VariableKind	Represents different kinds of variables that can be fetched from a Dialogue using TryGetValue<T>(string,T?) .

Interfaces

Name	Description
IMarkupParser	Contains methods for parsing raw text into a MarkupParseResult .
ISmartVariableEvaluator	Contains methods for evaluating the value of smart variables
IType	Defines properties that describe a type in the Yarn language.
ITypeMember	Provides properties used to work with members of a type.
IVariableAccess	Provides a mechanism for retrieving values.
IVariableStorage	Provides a mechanism for storing values.
IYarnValue	Represents a read-only value in the Yarn Spinner virtual machine.

Namespaces

Name	Description
Yarn.Compiler	Contains classes for compiling Yarn code.
Yarn.Markup	Contains classes for working with markup in Yarn lines.
Yarn.Saliency	Contains classes for choosing the most relevant content out of a set of possible options.
Yarn.Unity	Contains classes for working with Yarn Spinner in the Unity game engine.
Yarn.Utility	Contains utility classes used by Yarn Spinner.

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.