Summary

Contains utility classes used by Yarn Spinner.

Classes

Property in ConstantTypeProperty

Summary

Gets the value that is stored in this property.

public IConvertible Value { get; }

Method in Dialogue

Summary

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

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

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

Parameters

Returns

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

Method in Dialogue

Summary

Unloads all nodes from the Dialogue.

public void UnloadAll()

Property in Dialogue

Summary

Gets or sets the content saliency strategy used by this Dialogue .

public Saliency.IContentSaliencyStrategy ContentSaliencyStrategy { get; set; }

Remarks

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

Method in Dialogue

Summary

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

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 Dialogue

Summary

Returns the tags for the node 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.

Class in Yarn.Utility

Inherits from System.Object

Summary

Provides a method for generating CRC32 hashes of strings.

Methods

Delegate in Yarn

Inherits from System.MulticastDelegate

Summary

Represents the method that is called when the Dialogue delivers a 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.

Method in Dialogue

Summary

Loads all nodes from the provided Program .

Remarks

This method replaces any existing nodes have been loaded.

Parameters

Constructor in Dialogue

Summary

Initializes a new instance of the Dialogue class.

Parameters

Method in Dialogue

Summary

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

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.

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

public Logger? LogDebugMessage { get; set; }

Property in Dialogue

Summary

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

public NodeCompleteHandler? NodeCompleteHandler { get; set; }

Property in Dialogue

Summary

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

public IEnumerable<string> NodeNames { get; }

Remarks

If no program is currently loaded, an empty collection is returned.

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

Initialises a new instance of the EnumBase class.

public EnumBase()

Property in EnumBase

Summary

Gets the parent of this type.

public override IType? Parent { get }

Property in EnumType

Summary

Gets the collection of enum cases in this enum.

public IEnumerable<KeyValuePair<string, ConstantTypeProperty>> EnumCases { get; }

Property in EnumType

Summary

Gets the name of this type.

public override string Name { get }

Property in EnumType

Summary

Gets the parent of this type.

public override IType Parent { get }

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 type of value that this type of function accepts as a variadic parameter.

public IType? VariadicParameterType { get; internal set; }

Remarks

This value is null if this type of function does not accept variadic parameters.

Method in Header

Summary

public int CalculateSize()

Method in Header

Summary

public bool Equals(Header other)

Parameters

Method in Header

Summary

public Header Clone()

Method in Header

Summary

public override int GetHashCode()

Constructor in Header

Summary

public Header()

Property in Header

Summary

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

Field in Header

Summary

Field number for the "key" field.

public const int KeyFieldNumber = 1;

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

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

Method in IMarkupParser

Summary

Parses a string into markup, given a locale.

public MarkupParseResult ParseMarkup(string rawText, string localeCode);

Parameters

Method in Header

Summary

public void MergeFrom(Header other)

Parameters

Interface in Yarn

Summary

Contains methods for parsing raw text into a MarkupParseResult .

public interface IMarkupParser

Methods

Class in

Inherits from

The base type for all enumeration types.

Method in

Class in Yarn

Inherits from System.Object

Summary

Co-ordinates the execution of Yarn programs.

public class Dialogue : ISmartVariableEvaluator

Constructors

Fields

Method in

Method in Dialogue

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.

Property in

The value of the header.

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

Summary

Contains classes for working with compiled Yarn programs.

Classes

Property in

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

Property in

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

Method in

Immediately stops the .

Method in

Returns if the node group has any potential nodes to be run based on the current salient selector.

True if there is any salient content for the requested node group

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

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

Property in

Gets the parent of this type.

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

Property in

Method in CRC32

Summary

Gets the CRC-32 hash of s as a string containing 8 lowercase hexadecimal characters.

public static string GetChecksumString(string s)

Remarks

This method converts the string to a UTF-8 encoding, and then computes a CRC32 checksum from those bytes.

Parameters

The string containing the checksum.

Method in

Gets the collection of headers present on the node named nodeName .

A collection of key-values pairs, each one representing a header on the node.

Property in

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

Field in

The node that execution will start from.

Property in IType

Summary

Gets the name of this type.

string Name { get; }

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 .

• : 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 reaches the end of a node.

Property in FunctionType

Summary

Gets the name of this type.

public string Name { get; }

Class in Yarn

Inherits from System.Object

Summary

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

Constructors

Class in Yarn

Inherits from TypeBase

Summary

A type that represents enumerations.

public class EnumType : TypeBase

Constructors

Properties

Property in

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

Property in EnumBase

Summary

Gets the name of this type.

public override string Name { get }

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

Property in

Gets a more verbose description of this type.

Property in

Invoked when the Dialogue needs to report an error.

Property in

Gets a string describing this property.

Method in CRC32

Summary

Computes a CRC32 checksum from the given bytes.

Parameters

Returns

A CRC32 checksum derived from bytes .

Interface in

Defines properties that describe a type in the Yarn language.

Property in

Gets a string describing this type.

Method in

Interface in Yarn

Summary

Contains methods for evaluating the value of smart variables

public interface ISmartVariableEvaluator

Methods

Method in Dialogue

Summary

Gets the value of the header named headerName on the node named nodeName , or null if the header can't be found.

public string? GetHeaderValue(string nodeName, string headerName)

Remarks

If the node has more than one header named headerName , the first one is used.

Parameters

The value of the first header on the node with the specified header value.

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 FunctionType

Summary

Gets the type of the parameter at the given index.

public IType GetParameterAt(int index)

Parameters

Returns

The type of the parameter. If index is beyond the length of , and is not null , is returned.

Method in ISmartVariableEvaluator

Summary

Evaluate the value of a smart variable named name .

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

Parameters

true if the smart variable was evaluated, false otherwise.

Property in

Gets the text of the command.

Property in

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

Constructor in

Constructor in FunctionType

Summary

Initialises a new instances of the FunctionType class.

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

Parameters

Property in

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

Field in

Field number for the "value" field.

Property in

The name of the header.

Method in Dialogue

Summary

Evaluate the value of a smart variable named name .

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

Parameters

true if the smart variable was evaluated, false otherwise.

Method in

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 a string describing this type.

Property in

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

Property in

Gets the type of this enum's members.

Property in

Gets a more verbose description of this type.

Method in

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

Method in CRC32

Summary

Computes a CRC32 checksum from the given string.

Remarks

This method converts the string to a UTF-8 encoding, and then computes a CRC32 checksum from those bytes.

Parameters

Returns

A CRC32 checksum derived from s .

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.

Property in

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

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

Class in Yarn

Inherits from System.Object

Summary

A type that represents a function.

public class FunctionType : IType, IEquatable<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

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 type of this property.