Property in BuiltinTypes

Summary

Gets the type representing numbers.

public static IType Number { get; };

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

Gets the type representing any value.

Property in

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

Property in

Gets the text of the command.

Property in

Gets the type representing boolean values.

Property in

Gets the type representing strings.

Property in Dialogue

Summary

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

public NodeStartHandler NodeStartHandler
{
            get; set; }

Property in Dialogue

Summary

Invoked when the Dialogue needs to report debugging information.

public Logger LogDebugMessage { get; set; }

Struct in Yarn

Inherits from System.ValueType

Summary

A command, sent from the Dialogue to the game.

public struct Command

Remarks

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

Properties

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

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

Unloads all nodes from the Dialogue.

Field in

The node that execution will start from.

Constructor in

Initializes a new instance of the class.

Method in

Returns the tags for the node nodeName .

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.

Property in

Gets the that this Dialogue uses to locate functions.

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

Property in

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

Property in

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

Property in

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

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

Property in

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

Method in

Immediately stops the .

The will not be called if the dialogue is ended by calling .

Method in

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

Property in

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

Property in

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

Property in

Invoked when the Dialogue needs to report an error.

Method in

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

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

Property in

Gets a more verbose description of this type.

Property in

Gets the parent of this type.

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

Property in

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

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

Property in

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

Method in

Stores a float in this VariableStorage.

Property in

Gets a more verbose description of this type.

Property in

Gets the parent of this type.

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

Property in

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

Method in

Removes all variables from storage.

Property in

The list of instructions in this node.

Property in

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

Method in

Removes all variables from storage.

Property in

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

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.

Property in IType

Summary

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

MethodCollection Methods { get; }

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 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 FunctionType

Summary

Gets the type of value that this function returns.

public IType ReturnType { get; internal set; }

Property in FunctionType

Summary

Gets the name of this type.

public string Name { get; }

Property in IType

Summary

Gets the name of this type.

string Name { get; }

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; }

Property in Node

Summary

The name of this node.

public string Name {
      get; set; }

Property in Node

Summary

The tags associated with this node.

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

Property in Dialogue

Summary

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

public PrepareForLinesHandler PrepareForLinesHandler
{
            get; set; }

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 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 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.

Delegate in Yarn

Inherits from System.MulticastDelegate

Summary

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

public delegate void CommandHandler(Command command);

Parameters

• : 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.

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

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

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

• : Starts, or continues, execution of the current Program.

Method in Dialogue

Summary

Starts, or continues, execution of the current Program.

public void Continue()

Remarks

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

• The LineHandler or CommandHandler is called. After calling either of these handlers, the Dialogue will wait until Continue() is called. Continue may be called from inside the LineHandler or CommandHandler, 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.

• : 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 .

Interface in Yarn

Summary

Defines properties that describe a type in the Yarn language.

public interface IType

Properties

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, TResult>(string name, Func<T1, T2, TResult> implementation)

Parameters

Interface in Yarn

Summary

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

public interface IVariableStorage

Methods

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

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

text , with the content from substitutions inserted.

Method in MemoryVariableStore

Summary

Retrieves a value of type T by name.

public bool TryGetValue<T>(string variableName, out T result)

Parameters

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

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

Method in Library

Summary

Removes a function from the Library.

public void DeregisterFunction(string name)

Remarks

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

Parameters

Method in Dialogue

Summary

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

public void SetNode(string startNode = DefaultStartNodeName)

Remarks

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

If PrepareForLinesHandler 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 MemoryVariableStore

Summary

Stores a float in this VariableStorage.

public void SetValue(string variableName, float floatValue)

Parameters

Method in IVariableStorage

Summary

Stores a string in this VariableStorage.

void SetValue(string variableName, string stringValue);

Parameters

Method in IVariableStorage

Summary

Stores a bool in this VariableStorage.

void SetValue(string variableName, bool boolValue);

Parameters

Method in Library

Summary

Returns a System.Delegate with a given name.

public Delegate GetFunction(string name)

Parameters

The System.Delegate .

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

Contains classes for working with compiled Yarn programs.

Class in

Inherits from System.Object

A type that represents functions.

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 methods or similar.)

Method in

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

Method in

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

Method in

Loads all nodes from the provided .

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

Class in

Inherits from System.Object

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

Delegate in

Inherits from System.MulticastDelegate

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

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.

Delegate in

Inherits from System.MulticastDelegate

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

Delegate in

Inherits from System.MulticastDelegate

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

Delegate in

Inherits from System.MulticastDelegate

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

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

Method in

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

Struct in

Inherits from System.ValueType

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

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

Delegate in

Inherits from System.MulticastDelegate

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

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

Method in

Stores a bool in this VariableStorage.

Property in

Gets the s that should be presented to the user.

• : An option to be presented to the user.

Field in

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

Class in

Inherits from System.Exception

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

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 to replace all substitutions in the user-facing text.

3. Use to parse all markup in the line.

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

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

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

The string ID.

Method in

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

Class in

Inherits from System.Object

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

Struct in

Inherits from System.ValueType

An option to be presented to the user.

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

• : Co-ordinates the execution of Yarn programs.

Class in Yarn

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

public class Dialogue : IAttributeMarkerProcessor

Constructors

Method in Library

Summary

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

public bool FunctionExists(string name)

Parameters

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

Method in

Field in

The string ID for this line.

Method in MemoryVariableStore

Summary

Stores a string in this VariableStorage.

public void SetValue(string variableName, string stringValue)

Parameters

Method in IVariableStorage

Summary

Retrieves a value of type T by name.

bool TryGetValue<T>(string variableName, out T result);

Parameters

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