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

ContentSaliencyOption

Represents a piece of content that may be selected by an IContentSaliencyStrategy.
public sealed class ContentSaliencyOption

Inherits from System.Object

#Constructors

#ContentSaliencyOption(string)

Initializes a new instance of the ContentSaliencyOption class with the specified content ID.
public ContentSaliencyOption(string id)

Parameters

  • idstring
    A string representing the unique identifier for the content.

Exceptions

  • System.ArgumentNullException
    Thrown when the provided ID is null.

#Properties

#ComplexityScore

Gets the complexity score of this option.
public int ComplexityScore { get; set; }

Type Int32

#ContentID

Gets a string that uniquely identifies this content.
public string ContentID { get; }

Type String

#ContentType

Gets the type of content that this option represents.
public ContentSaliencyContentType ContentType { get; set; }

Type ContentSaliencyContentType

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

#FailingConditionValueCount

Get the number of conditions that failed for this piece of content.
public int FailingConditionValueCount { get; set; }

Type Int32

#PassingConditionValueCount

Gets the number of conditions that passed for this piece of content.
public int PassingConditionValueCount { get; set; }

Type Int32

#ViewCountKey

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 }

Type String

Generated from Yarn Spinner for Unity 3.3.