Summary

Classes

Enums

Interfaces

Class in

Inherits from System.Object

Summary

A content saliency strategy that returns the best of the provided options.

Remarks

This strategy always selects the single best of the available items, regardless of how many times it has been seen before. For a saliency strategy that takes into account how recently content has been seen, see .

Methods

Method in BestLeastRecentlyViewedSalienceStrategy

Summary

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

public ContentSaliencyOption? QueryBestContent(IEnumerable<ContentSaliencyOption> content)

Remarks

Implementations of this method should not modify any state

• that is, they should be 'read-only' operations. If a strategy needs to record information about when a piece of content has been selected, it should do it in the ContentWasSelected(ContentSaliencyOption) method.

Parameters

Returns

An item from content that is the most appropriate for display, or null if no content should be displayed.

Method in BestLeastRecentlyViewedSalienceStrategy

Summary

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

public void ContentWasSelected(ContentSaliencyOption content)

Remarks

If a content saliency strategy does not need to keep track of any state, then this method can be empty.

Parameters

Class in Yarn.Saliency

Inherits from System.Object

Summary

A content saliency strategy that returns the first of the best, least-recently seen choices from the provided options.

public class BestLeastRecentlyViewedSalienceStrategy : IContentSaliencyStrategy

Remarks

This strategy stores information about the number of times each piece of content has been seen in the provided Yarn.Saliency.BestLeastRecentlyViewedSalienceStrategy.VariableStorage .

Constructors

Methods

Method in BestSaliencyStrategy

Summary

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

public ContentSaliencyOption? QueryBestContent(IEnumerable<ContentSaliencyOption> content)

Remarks

Implementations of this method should not modify any state

• that is, they should be 'read-only' operations. If a strategy needs to record information about when a piece of content has been selected, it should do it in the ContentWasSelected(ContentSaliencyOption) method.

Parameters

Returns

An item from content that is the most appropriate for display, or null if no content should be displayed.

Method in BestSaliencyStrategy

Summary

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

public void ContentWasSelected(ContentSaliencyOption content)

Remarks

If a content saliency strategy does not need to keep track of any state, then this method can be empty.

Parameters

Enum in Yarn.Saliency

Inherits from System.Enum

Summary

Indicates what type of content a ContentSaliencyOption represents.

public enum ContentSaliencyContentType
{
    Node,
    Line
}

Members

See Also

• ContentSaliencyOption.ContentType: Gets the type of content that this option represents.

Constructor in

Summary

Initalises a new instance of the class.

Parameters

Property in

Summary

Gets the complexity score of this option.

Enumeration Member in ContentSaliencyContentType

Summary

The content represents a line in a line group.

Line

Class in Yarn.Saliency

Inherits from System.Object

Summary

Contains extension methods for System.Collections.Generic.IEnumerable`1 .

public static class EnumerableRandomExtension

Methods

Property in

Summary

Gets a string that uniquely identifies this content.

Property in

Summary

Gets the number of conditions that passed for this piece of content.

Property in

Summary

Get the number of conditions that failed for this piece of content.

Property in ContentSaliencyOption

Summary

Gets the type of content that this option represents.

public ContentSaliencyContentType ContentType { get; set; }

Remarks

This information may be used by custom IContentSaliencyStrategy classes to allow them to have different behaviour depending on the type of the content.

Property in ContentSaliencyOption

Summary

Gets a unique variable name that can be used for tracking the view count of a specific piece of content. This value is null if ContentID is null or empty.

public string ViewCountKey { get };

Class in Yarn.Saliency

Inherits from System.Object

Summary

Represents a piece of content that may be selected by an IContentSaliencyStrategy .

public sealed class ContentSaliencyOption

Constructors

Properties

Method in

Summary

Returns a random element from enumerable .

Remarks

This method uses System.Random to make a selection, which is cryptographically insecure. This means that this method should not be used for security-critical decisions.

Parameters

Type Parameters

Returns

A random element in enumerable .

Constructor in

Summary

Initializes a new instance of the ContentSaliencyOption class with the specified content ID.

Parameters

Interface in Yarn.Saliency

Summary

Contains methods for choosing a piece of content from a collection of options.

public interface IContentSaliencyStrategy

Methods

Method in

Summary

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

Remarks

If a content saliency strategy does not need to keep track of any state, then this method can be empty.

Parameters

Enumeration Member in ContentSaliencyContentType

Summary

The content represents a node in a node group.

Node

Method in IContentSaliencyStrategy

Summary

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

ContentSaliencyOption? QueryBestContent(IEnumerable<ContentSaliencyOption> content);

Remarks

Implementations of this method should not modify any state

• that is, they should be 'read-only' operations. If a strategy needs to record information about when a piece of content has been selected, it should do it in the ContentWasSelected(ContentSaliencyOption) method.

Parameters

Returns

An item from content that is the most appropriate for display, or null if no content should be displayed.

Method in IContentSaliencyStrategy

Summary

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

void ContentWasSelected(ContentSaliencyOption content);

Remarks

If a content saliency strategy does not need to keep track of any state, then this method can be empty.

Parameters

Method in RandomBestLeastRecentlyViewedSalienceStrategy

Summary

Called by Yarn Spinner to indicate that a piece of salient content has been selected, and this system should update any state related to how it selects content.

public void ContentWasSelected(ContentSaliencyOption content)

Remarks

If a content saliency strategy does not need to keep track of any state, then this method can be empty.

Parameters

Class in Yarn.Saliency

Inherits from System.Object

Summary

A content saliency strategy that always returns the first non-failing item in the list of available options.

public class FirstSaliencyStrategy : IContentSaliencyStrategy

Remarks

This saliency strategy is used when a Dialogue has no provided saliency strategy, but is required to make a decision.

Methods

Class in Yarn.Saliency

Inherits from System.Object

Summary

A content saliency strategy that returns a random choice of the best, least-recently seen choices from the provided options.

public class RandomBestLeastRecentlyViewedSalienceStrategy : IContentSaliencyStrategy

Remarks

This strategy stores information about the number of times each piece of content has been seen in the provided Yarn.Saliency.RandomBestLeastRecentlyViewedSalienceStrategy.VariableStorage .

Constructors

Methods

Method in

Summary

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

Remarks

Implementations of this method should not modify any state

• that is, they should be 'read-only' operations. If a strategy needs to record information about when a piece of content has been selected, it should do it in the method.

Parameters

Returns

An item from content that is the most appropriate for display, or null if no content should be displayed.

Method in FirstSaliencyStrategy

Summary

Chooses an item from content that is the most appropriate (or salient ) for the user's current context.

public ContentSaliencyOption? QueryBestContent(IEnumerable<ContentSaliencyOption> content)

Remarks

Implementations of this method should not modify any state

• that is, they should be 'read-only' operations. If a strategy needs to record information about when a piece of content has been selected, it should do it in the ContentWasSelected(ContentSaliencyOption) method.

Parameters

Returns

An item from content that is the most appropriate for display, or null if no content should be displayed.

Constructor in RandomBestLeastRecentlyViewedSalienceStrategy

Summary

Initializes a new instance of the RandomBestLeastRecentlyViewedSalienceStrategy class.

public RandomBestLeastRecentlyViewedSalienceStrategy(IVariableStorage storage)

Parameters