Property in ConstantTypeProperty

Summary

Gets a string describing this property.

public string Description { get; }

Property in Command

Summary

Gets the text of the command.

public string Text { get; private set; }

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

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 .

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

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

See Also

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

Class in Yarn

Inherits from System.Object

Summary

Represents a property that belongs to a type and contains a read-only value.

public class ConstantTypeProperty : ITypeMember

Remarks

This kind of type member is useful for constant properties, like enum cases.

Properties

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 OptionsHandler is called. When this occurs, the Dialogue is waiting for the user to specify which of the options has been selected, and SetSelectedOption(int) must be called before Continue() is called again.)

• The Program reaches its end. When this occurs, SetNode(string) must be called before Continue() is called again.

• An error occurs while executing the Program.

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

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 .

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

Class in Yarn

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

public class Dialogue : ISmartVariableEvaluator

Constructors

Fields

Methods

Properties

Method in

Summary

Gets a value indicating whether nodeName is the name of a valid node group in the program.

Parameters

Returns

true if nodeName is the name of a node group; false otherwise.

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

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.

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

Immediately stops the Dialogue .

public void Stop()

Method in Dialogue

Summary

Loads all nodes from the provided Program .

public void SetProgram(Program program)

Remarks

This method replaces any existing nodes have been loaded.

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

Property in

Summary

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

Method in

Summary

Evaluate the value of a smart variable named name .

Parameters

Type Parameters

Returns

true if the smart variable was evaluated, false otherwise.

Property in

Summary

Gets or sets the content saliency strategy used by this .

Remarks

A content saliency strategy is a class that implements and selects the most appropriate content in a line group, or any other situation where content saliency is relevant.

Property in

Summary

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

Property in

Summary

Gets or sets the 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 a command is to be delivered to the game.

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

Property in

Summary

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

Remarks

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

Summary

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

Property in

Summary

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

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

Constructor in EnumBase

Summary

public EnumBase()

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 Dialogue

Summary

Invoked when the Dialogue needs to report an error.

public Logger LogErrorMessage { get; set; }

Property in EnumBase

Summary

public override string Name { get };

Property in EnumBase

Summary

public override string Description { get };

Property in EnumBase

Summary

public override IType? Parent { get };

Class in Yarn

Inherits from TypeBase

Summary

public class EnumBase : TypeBase

Constructors

Properties

Constructor in EnumType

Summary

Initializes a new instance of the EnumType class that represents an enum type. This type has no methods of its own, and is a subtype of Any .

public EnumType(string name, string description, TypeBase rawType)

Parameters

Class in

Inherits from

Summary

A type that represents enumerations.

Constructors

Properties

Property in

Summary

Gets a string describing this type.

Property in

Summary

Gets the collection of enum cases in this enum.

Property in

Summary

Gets the name of this type.

Property in

Summary

Gets the parent of this type.

Property in

Summary

Gets the type of this enum's members.

Method in FunctionType

Summary

public string ToString();

Property in FunctionType

Summary

Gets a more verbose description of this type.

public string Description
{
            get; set; }

Class in Yarn

Inherits from System.Object

Summary

A type that represents a function.

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

Constructors

Methods

Properties

Method in FunctionType

Summary

public bool Equals(IType other)

Parameters

Property in

Summary

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

Remarks

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

Constructor in FunctionType

Summary

public FunctionType(IType returnType, params IType[] parameterTypes)

Parameters

Field in

Summary

Field number for the "key" field.

Field in Header

Summary

Field number for the "value" field.

public const int ValueFieldNumber = 2;

Field in Dialogue

Summary

The node that execution will start from.

public const string DefaultStartNodeName = "Start";

Property in ConstantTypeProperty

Summary

Gets the value that is stored in this property.

public IConvertible Value { get; }

Method in Dialogue

Summary

Queries the Dialogue for what content could possibly run if the node group nodeGroup was run.

public IEnumerable<Saliency.ContentSaliencyOption> GetSaliencyOptionsForNodeGroup(string nodeGroup)

Remarks

This method evaluates all nodes in the given node group, and returns a ContentSaliencyOption object for each node. This object contains the current number of passing and failing 'when' clauses on the node, as well as the complexity score for that node. This is the same information that's passed to a IContentSaliencyStrategy object's QueryBestContent(IEnumerable<ContentSaliencyOption>) method. This method is read-only, and calling it will not modify any variable state.

Note that this method does not filter its output, and may include content options whose FailingConditionValueCount is greater than zero. It's up to the caller of this function to filter out these options if they're not wanted.

This method can be used to see if any content will appear when a given node group is run. If the collection returned by this method is empty, then running this node group will not result in any content. This can be used, for example, to decide whether to show a 'character can be spoken to' indicator. You can also examine the individal ContentSaliencyOption objects to see if any content is available that passes a filter, such as whether content might appear that has a user-defined 'plot critical' tag.

Parameters

Returns

A collection of ContentSaliencyOption objects that may appear if and when the node group nodeGroup is run.

Summary

Contains classes for working with compiled Yarn programs.

Classes

Delegates

Enums

Interfaces

Namespaces

Structs

Constructor in Header

Summary

public Header(Header other)

Parameters

Constructor in Dialogue

Summary

Initializes a new instance of the Dialogue class.

public Dialogue(Yarn.IVariableStorage variableStorage)

Parameters

Property in

Summary

Gets the type of value that this function returns.

Property in

Summary

Gets the type of this property.

Method in Header

Summary

public override bool Equals(object other)

Parameters

Method in Header

Summary

public int CalculateSize()

Method in

Summary

Method in

Summary

Parameters

Method in

Summary

Parameters

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 .

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

Parameters

Method in

Summary

Unloads all nodes from the Dialogue.

Method in

Summary

Method in Header

Summary

public void WriteTo(pb::CodedOutputStream output)

Parameters

Property in Header

Summary

public static pbr::MessageDescriptor Descriptor {
      get; }

Property in Dialogue

Summary

Gets the Library that this Dialogue uses to locate functions.

public Library Library { get; internal set; }

Remarks

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

Property in Header

Summary

public static pb::MessageParser<Header> Parser { get; }

Interface in Yarn

Summary

Contains methods for parsing raw text into a MarkupParseResult .

public interface IMarkupParser

Methods

Method in

Summary

Parses a string into markup, given a locale.

Parameters

Property in

Summary

The name of the header.

Interface in Yarn

Summary

Contains methods for evaluating the value of smart variables

public interface ISmartVariableEvaluator

Methods

Method in ISmartVariableEvaluator

Summary

Evaluate the value of a smart variable named name .

bool TryGetSmartVariable<T>(string name, out T result);

Parameters

Type Parameters

Returns

true if the smart variable was evaluated, false otherwise.

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 IType

Summary

Gets a more verbose description of this type.

string Description { get; }

Property in Dialogue

Summary

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

public IEnumerable<string> NodeNames
{
            get; }

Property in IType

Summary

Gets the collection of type information for this type's type members.

System.Collections.Generic.IReadOnlyDictionary<string, ITypeMember> TypeMembers { get; }

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

Property in Header

Summary

The value of the header.

public string Value {
      get; set; }

Property in FunctionType

Summary

Gets the name of this type.

public string Name { get; }

Interface in Yarn

Summary

Provides properties used to work with members of a type.

public interface ITypeMember

Properties

Property in

Summary

Gets or sets the type of this member.

Property in

Summary

Gets the collection of type information for this type's type members.

Method in IVariableAccess

Summary

Gets the kind of variable named name .

VariableKind GetVariableKind(string name);

Parameters

Returns

A VariableKind enum representing the kind of the variable named name .

Constructor in Header

Summary

public Header()

Property in

Summary

Gets or sets the Yarn that stores information about the initial values of variables, and is able to produce values for smart variables.

Method in

Summary

Given a variable name, attempts to fetch a value for the variable, either from storage, initial values found in , or by evaluating a smart variable found in .

Parameters

Type Parameters

Returns

true if a value could be fetched; false otherwise.

Property in IVariableAccess

Summary

Gets or sets the object to use when evaluating smart variables.

ISmartVariableEvaluator SmartVariableEvaluator { get; set; }

Class in Yarn

Inherits from System.Object

Summary

public sealed class Header : pb::IMessage<Header>
#if !GOOGLE_PROTOBUF_REFSTRUCT_COMPATIBILITY_MODE
      , pb::IBufferMessage

Constructors

Fields

Methods

Properties

Interface in Yarn

Summary

Provides a mechanism for storing values.

public interface IVariableStorage : IVariableAccess

Methods

Method in

Summary

Stores a bool in this VariableStorage.

Parameters

Property in

Summary

Gets the parent of this type.

Remarks

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

Method in

Summary

Interface in Yarn

Summary

Defines properties that describe a type in the Yarn language.

public interface IType

Properties

Property in

Summary

Gets the name of this type.

Interface in Yarn

Summary

Provides a mechanism for retrieving values.

public interface IVariableAccess

Methods

Properties

Method in

Summary

Removes all variables from storage.

Method in IVariableStorage

Summary

Stores a float in this VariableStorage.

void SetValue(string variableName, float floatValue);

Parameters