Pardon our dust! Docs for Yarn Spinner for Unity 3.2 and Yarn Spinner for Godot C# are on docs.yarnspinner.dev (the old docs site). Docs for Yarn Spinner for Unity 3.3 (pre-release, out ASAP), Yarn Spinner for Godot GDScript and Yarn Spinner for Unreal Engine (work in progress) are on /docs/ (the new docs site).

IContentSaliencyStrategy

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

#Methods

#ContentWasSelected(ContentSaliencyOption)

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

Parameters

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

#QueryBestContent(IEnumerable<ContentSaliencyOption>)

Chooses an item from content that is the most appropriate (or salient) for the user's current context.
ContentSaliencyOption? QueryBestContent(IEnumerable<ContentSaliencyOption> content);

Parameters

  • contentSystem.Collections.Generic.IEnumerable<Yarn.Saliency.ContentSaliencyOption>
    A collection of content items. This collection may be empty.

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

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.

Generated from Yarn Spinner for Unity 3.3.