Property in BuiltinTypes

Summary

Gets the type representing any value.

public static IType Any { get; };

Property in BuiltinTypes

Summary

Gets the type representing boolean values.

public static IType Boolean { get; };

Property in BuiltinTypes

Summary

Gets the type representing numbers.

public static IType Number { get; };

Summary

Contains classes for working with compiled Yarn programs.

Classes

Delegates

Interfaces

Namespaces

Structs

Class in Yarn

Inherits from System.Object

Summary

Contains the built-in types available in the Yarn language.

public static class BuiltinTypes

Properties

Property in

Summary

Gets a dictionary that maps CLR types to their corresponding Yarn types.

Delegate in

Inherits from System.MulticastDelegate

Summary

Represents the method that is called when the Dialogue delivers a .

Parameters

See Also

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue delivers an .

• : Represents the method that is called when the Dialogue begins executing a node.

• : Represents the method that is called when the Dialogue reaches the end of a node.

• : Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

Struct in

Inherits from System.ValueType

Summary

A command, sent from the to the game.

Remarks

You do not create instances of this struct yourself. They are created by the during program execution.

Properties

See Also

• : Gets or sets the that is called when a command is to be delivered to the game.

Property in

Summary

Gets the type representing strings.

Class in

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

Constructors

Fields

Methods

Properties

Field in

Summary

The node that execution will start from.

Method in Dialogue

Summary

Loads the nodes from the specified Program , and adds them to the nodes already loaded.

public void AddProgram(Program program)

Remarks

If Yarn.Dialogue.Program is null , this method has the effect as calling SetProgram(Program) .

Parameters

Method in Dialogue

Summary

Returns the tags for the node nodeName .

public IEnumerable<string> GetTagsForNode(string nodeName)

Remarks

The tags for a node are defined by setting the tags header in the node's source code. This header must be a space-separated list.

Parameters

Returns

The node's tags, or null if the node is not present in the Program.

Method in

Summary

Loads all nodes from the provided .

Remarks

This method replaces any existing nodes have been loaded. If you want to load nodes from an additional Program, use the method.

Parameters

Method in

Summary

Prepares the that the user intends to start running a node.

Remarks

After this method is called, you call to start executing it.

If has been set, it may be called when this method is invoked, as the Dialogue determines which lines may be delivered during the startNode node's execution.

Parameters

Method in

Summary

Parses a line of text, and produces a containing the results.

Remarks

The 's will have any select , plural or ordinal markers replaced with the appropriate text, following this 's .

Parameters

Returns

The results of parsing the markup.

Method in

Summary

Starts, or continues, execution of the current Program.

Remarks

This method repeatedly executes instructions until one of the following conditions is encountered:

• The or is called. After calling either of these handlers, the Dialogue will wait until is called. Continue may be called from inside the or , or may be called at any future time.

• The is called. When this occurs, the Dialogue is waiting for the user to specify which of the options has been selected, and must be called before is called again.)

• The Program reaches its end. When this occurs, must be called before is called again.

• An error occurs while executing the Program.

This method has no effect if it is called while the is currently in the process of executing instructions.

See Also

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue delivers an .

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue reaches the end of a node.

• : Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

Property in Dialogue

Summary

Gets the name of the node that this Dialogue is currently executing.

public string CurrentNode
{
            get; }

Remarks

If Continue() has never been called, this value will be null .

Property in Dialogue

Summary

Gets or sets the DialogueCompleteHandler that is called when the dialogue reaches its end.

public DialogueCompleteHandler DialogueCompleteHandler
{
            get; set; }

Method in Dialogue

Summary

Immediately stops the Dialogue .

public void Stop()

Remarks

The DialogueCompleteHandler will not be called if the dialogue is ended by calling Stop() .

Method in Dialogue

Summary

Gets a value indicating whether a specified node exists in the Program.

public bool NodeExists(string nodeName)

Parameters

Returns

true if a node named nodeName exists in the Program, false otherwise.

Method in Dialogue

Summary

Signals to the Dialogue that the user has selected a specified Option .

public void SetSelectedOption(int selectedOptionID)

Remarks

After the Dialogue delivers an OptionSet, this method must be called before Continue() is called.

The ID number that should be passed as the parameter to this method should be the ID field in the Option that represents the user's selection.

Parameters

See Also

• OptionsHandler: Represents the method that is called when the Dialogue delivers an OptionSet .

• OptionSet: A set of Option s, sent from the Dialogue to the game.

• Dialogue.Continue(): Starts, or continues, execution of the current Program.

Property in

Summary

Gets the that this Dialogue uses to locate functions.

Remarks

When the Dialogue is constructed, the Library is initialized with the built-in operators like + , - , and so on.

Property in

Summary

Gets or sets the that is called when a node is complete.

Property in

Summary

Invoked when the Dialogue needs to report debugging information.

Property in

Summary

Gets or sets the that is called when a node is started.

Property in Dialogue

Summary

Gets a value indicating whether the Dialogue is currently executing Yarn instructions.

public bool IsActive { get };

Property in Dialogue

Summary

Gets or sets the OptionsHandler that is called when a set of options are ready to be shown to the user.

public OptionsHandler OptionsHandler
{
            get; set; }

Remarks

The Options Handler delivers an OptionSet to the game. Before Continue() can be called to resume execution, SetSelectedOption(int) must be called to indicate which Option was selected by the user. If SetSelectedOption(int) is not called, an exception is thrown.

Property in Dialogue

Summary

Gets or sets the Dialogue 's locale, as an IETF BCP 47 code.

public string LanguageCode { get; set; }

Remarks

This code is used to determine how the plural and ordinal markers determine the plural class of numbers.

For example, the code "en-US" represents the English language as used in the United States.

Delegate in Yarn

Inherits from System.MulticastDelegate

Summary

Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

public delegate void DialogueCompleteHandler();

See Also

• LineHandler: Represents the method that is called when the Dialogue delivers a Line .

• OptionsHandler: Represents the method that is called when the Dialogue delivers an OptionSet .

• CommandHandler: Represents the method that is called when the Dialogue delivers a Command .

• NodeStartHandler: Represents the method that is called when the Dialogue begins executing a node.

• NodeCompleteHandler: Represents the method that is called when the Dialogue reaches the end of a node.

Property in

Summary

Gets or sets the object that provides access to storing and retrieving the values of variables.

Property in FunctionType

Summary

Gets the collection of methods that are available on this type.

public MethodCollection Methods { get };

Property in IType

Summary

Gets the collection of methods that are available on this type.

MethodCollection Methods { get; }

Property in FunctionType

Summary

Gets the list of the parameter types that this function is called with.

public List<IType> Parameters { get; };

Remarks

The length of this list also determines the number of parameters this function accepts (also known as the function's arity ).

Property in FunctionType

Summary

Gets the name of this type.

public string Name { get; }

Interface in Yarn

Summary

Defines properties that describe a type in the Yarn language.

public interface IType

Properties

Method in IVariableStorage

Summary

Stores a bool in this VariableStorage.

void SetValue(string variableName, bool boolValue);

Parameters

Method in

Summary

Retrieves a value of type T by name.

Parameters

Type Parameters

Returns

true if a value named variableName of type T was retrieved; false otherwise.

Interface in Yarn

Summary

Provides a mechanism for storing and retrieving instances of the Yarn.Value class.

public interface IVariableStorage

Methods

Method in IVariableStorage

Summary

Stores a float in this VariableStorage.

void SetValue(string variableName, float floatValue);

Parameters

Method in

Summary

Removes all variables from storage.

Method in

Summary

Removes a function from the Library.

Remarks

If no function with the given name is present in the Library, this method does nothing.

Parameters

Method in Library

Summary

Gets a value indicating whether this Library contains a function named name .

public bool FunctionExists(string name)

Parameters

Returns

true if a function exists in this Library; false otherwise.

Class in Yarn

Inherits from System.Object

Summary

A type that represents functions.

public class FunctionType : IType

Remarks

Functions have parameters and a return type, and can be called from script. Instances of this type are created when the host application registers new functions (such as through using the RegisterFunction(string,Delegate) methods or similar.)

Properties

Class in Yarn

Inherits from System.Object

Summary

A collection of functions that can be called from Yarn programs.

public class Library

Remarks

You do not create instances of this class yourself. The Dialogue class creates one of its own, which you can access via the Library property.

Methods

See Also

• Dialogue: Co-ordinates the execution of Yarn programs.

Method in

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

Parameters

Type Parameters

Property in

Summary

Gets the text of the command.

Method in Dialogue

Summary

Returns the string ID that contains the original, uncompiled source text for a node.

public string GetStringIDForNode(string nodeName)

Remarks

A node's source text will only be present in the string table if its tags header contains rawText.

Because the Dialogue class is designed to be unaware of the contents of the string table, this method does not test to see if the string table contains an entry with the line ID. You will need to test for that yourself.

Parameters

Returns

The string ID.

Method in Dialogue

Summary

Replaces all substitution markers in a text with the given substitution list.

public static string ExpandSubstitutions(string text, IList<string> substitutions)

Remarks

This method replaces substitution markers - for example, {0}

• with the corresponding entry in substitutions . If text contains a substitution marker whose index is not present in substitutions , it is ignored.

Parameters

Returns

text , with the content from substitutions inserted.

Method in IVariableStorage

Summary

Stores a string in this VariableStorage.

void SetValue(string variableName, string stringValue);

Parameters

Method in

Summary

Returns a System.Delegate with a given name.

Parameters

Returns

The System.Delegate .

Constructor in

Summary

Initializes a new instance of the class.

Parameters

Property in Dialogue

Summary

Gets or sets the CommandHandler that is called when a command is to be delivered to the game.

public CommandHandler CommandHandler
{
            get; set; }

Method in Dialogue

Summary

Unloads all nodes from the Dialogue.

public void UnloadAll()

Property in Dialogue

Summary

Gets or sets the LineHandler that is called when a line is ready to be shown to the user.

public LineHandler LineHandler
{
            get; set; }

Property in Dialogue

Summary

Invoked when the Dialogue needs to report an error.

public Logger LogErrorMessage { get; set; }

Property in Dialogue

Summary

Gets the names of the nodes in the currently loaded Program.

public IEnumerable<string> NodeNames
{
            get; }

Method in Library

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

public void RegisterFunction<T1, T2, T3, TResult>(string name, Func<T1, T2, T3, TResult> implementation)

Parameters

Type Parameters

Property in FunctionType

Summary

Gets a more verbose description of this type.

public string Description
{
            get; set; }

Property in IType

Summary

Gets the parent of this type.

IType Parent { get; }

Remarks

All types have Any as their ultimate parent type (except for Any itself.)

Method in Library

Summary

Loads functions from another Library .

public void ImportLibrary(Library otherLibrary)

Remarks

If the other library contains a function with the same name as one in this library, the function in the other library takes precedence.

Parameters

Property in

Summary

Gets the parent of this type.

Remarks

All types have as their ultimate parent type (except for itself.)

Class in Yarn

Inherits from System.Exception

Summary

An exception that is thrown by Dialogue when there is an error in executing a Program .

public class DialogueException : System.Exception

Struct in Yarn

Inherits from System.ValueType

Summary

A line of dialogue, sent from the Dialogue to the game.

public struct Line

Remarks

When the game receives a Line, it should do the following things to prepare the line for presentation to the user.

1. Use the value in the ID field to look up the appropriate user-facing text in the string table.

2. Use ExpandSubstitutions(string,IList<string>) to replace all substitutions in the user-facing text.

3. Use ParseMarkup(string) to parse all markup in the line.

You do not create instances of this struct yourself. They are created by the Dialogue during program execution.

Fields

See Also

• Dialogue.LineHandler: Gets or sets the LineHandler that is called when a line is ready to be shown to the user.

Property in

Summary

Gets or sets the that is called when the dialogue anticipates delivering some lines.

Method in Library

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

public void RegisterFunction<T1, T2, T3, T4, TResult>(string name, Func<T1, T2, T3, T4, TResult> implementation)

Parameters

Type Parameters

Property in FunctionType

Summary

Gets the type of value that this function returns.

public IType ReturnType { get; internal set; }

Method in Library

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

public void RegisterFunction<T1, TResult>(string name, Func<T1, TResult> implementation)

Parameters

Type Parameters

Method in Library

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

public void RegisterFunction<TResult>(string name, Func<TResult> implementation)

Parameters

Type Parameters

Method in

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

Parameters

Type Parameters

Class in

Inherits from System.Object

Summary

A simple concrete implementation of that keeps all variables in memory.

Methods

Property in

Summary

Gets a more verbose description of this type.

Property in

Summary

Gets the name of this type.

Delegate in

Inherits from System.MulticastDelegate

Summary

Represents a method that receives diagnostic messages and error information from a .

Remarks

The text that this delegate receives may be output to a console, or sent to a log.

Parameters

Delegate in Yarn

Inherits from System.MulticastDelegate

Summary

Represents the method that is called when the Dialogue delivers a Line .

public delegate void LineHandler(Line line);

Parameters

See Also

• OptionsHandler: Represents the method that is called when the Dialogue delivers an OptionSet .

• CommandHandler: Represents the method that is called when the Dialogue delivers a Command .

• NodeStartHandler: Represents the method that is called when the Dialogue begins executing a node.

• NodeCompleteHandler: Represents the method that is called when the Dialogue reaches the end of a node.

• DialogueCompleteHandler: Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

Method in

Summary

Stores a string in this VariableStorage.

Parameters

Field in

Summary

The values that should be inserted into the user-facing text before delivery.

Method in Library

Summary

Registers a new function that returns a value, which can be called from a Yarn program.

public void RegisterFunction<T1, T2, T3, T4, T5, TResult>(string name, Func<T1, T2, T3, T4, T5, TResult> implementation)

Parameters

Type Parameters

Method in MemoryVariableStore

Summary

Removes all variables from storage.

public void Clear()

Method in MemoryVariableStore

Summary

Stores a float in this VariableStorage.

public void SetValue(string variableName, float floatValue)

Parameters

Method in

Summary

Retrieves a value of type T by name.

Parameters

Type Parameters

Returns

true if a value named variableName of type T was retrieved; false otherwise.

Method in MemoryVariableStore

Summary

Stores a bool in this VariableStorage.

public void SetValue(string variableName, bool boolValue)

Parameters

Method in Node

Summary

public override string ToString()

Property in Node

Summary

A jump table, mapping the names of labels to positions in the instructions list.

public pbc::MapField<string, int> Labels {
      get; }

Property in Node

Summary

The list of instructions in this node.

public pbc::RepeatedField<global::Yarn.Instruction> Instructions {
      get; }

Field in

Summary

The string ID for this line.

Property in Node

Summary

the entry in the program's string table that contains the original text of this node; null if this is not available

public string SourceTextStringID {
      get; set; }

Class in Yarn

Inherits from System.Object

Summary

A node of Yarn script, contained within a Program , and containing Yarn.Instruction s.

public class Node

Methods

Properties

Struct in

Inherits from System.ValueType

Summary

A set of s, sent from the to the game.

Remarks

You do not create instances of this struct yourself. They are created by the during program execution.

Properties

Structs

See Also

• : Gets or sets the that is called when a set of options are ready to be shown to the user.

Delegate in

Inherits from System.MulticastDelegate

Summary

Represents the method that is called when the Dialogue reaches the end of a node.

Remarks

This method may be called multiple times over the course of code execution. A node being complete does not necessarily represent the end of the conversation.

Parameters

See Also

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue delivers an .

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue begins executing a node.

• : Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

Delegate in

Inherits from System.MulticastDelegate

Summary

Represents the method that is called when the Dialogue begins executing a node.

Parameters

See Also

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue delivers an .

• : Represents the method that is called when the Dialogue delivers a .

• : Represents the method that is called when the Dialogue reaches the end of a node.

• : Represents the method that is called when the dialogue has reached its end, and no more code remains to be run.

Property in

Summary

The name of this node.

Property in Node

Summary

The tags associated with this node.

public pbc::RepeatedField<string> Tags {
      get; }

Property in OptionSet

Summary

Gets the Option s that should be presented to the user.

public Option[] Options { get; private set; }

See Also

• Option: An option to be presented to the user.

Struct in OptionSet

Inherits from System.ValueType

Summary

An option to be presented to the user.

public struct Option

Properties

Property in Option

Summary

Gets the Line that should be presented to the user for this option.

public Line Line { get; private set; }

Remarks

See the documentation for the Line class for information on how to prepare a line before presenting it to the user.

Property in Option

Summary

Gets a value indicating whether the player should be permitted to select this option.

public bool IsAvailable { get; private set; }

Remarks

If this value is false, this option had a line condition on it that failed. The option will still be delivered to the game, but, depending on the needs of the game, the game may decide to not allow the player to select it, or not offer it to the player at all.

This is intended for situations where games wish to show options that the player _could_ have taken, if some other condition had been met (e.g. having enough "charisma" points).

Property in Option

Summary

Gets the identifying number for this option.

public int ID { get; private set; }

Remarks

When the user selects this option, this value should be used as the parameter for SetSelectedOption(int) .

Property in Option

Summary

Gets the name of the node that will be run if this option is selected.

public string DestinationNode { get; private set; }

Remarks

The value of this property not be valid if this is a shortcut option.