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

YarnSaliencyStrategy

Base class for saliency selection strategies.
class_name YarnSaliencyStrategy
extends RefCounted

Inherits from RefCounted

#Nested Types

#Constants

#VIEW_COUNT_KEY_PREFIX

const VIEW_COUNT_KEY_PREFIX = "$Yarn.Internal.Content.ViewCount."

#Methods

#filter_valid_candidates(Array[Dictionary])

static func filter_valid_candidates(candidates: Array[Dictionary]) -> Array[Dictionary]

Parameters

  • candidatesArray[Dictionary]

Returns Array[Dictionary]

#get_candidate_index(Array[Dictionary], Dictionary)

static func get_candidate_index(candidates: Array[Dictionary], candidate: Dictionary) -> int

Parameters

  • candidatesArray[Dictionary]
  • candidateDictionary

Returns int

#get_view_count_key(String)

static func get_view_count_key(content_id: String) -> String

Parameters

  • content_idString

Returns String

#get_view_count(Dictionary, String)

static func get_view_count(context: Dictionary, content_id: String) -> int

Parameters

  • contextDictionary
  • content_idString

Returns int

#increment_view_count(Dictionary, Dictionary)

static func increment_view_count(context: Dictionary, candidate: Dictionary) -> void

Parameters

  • contextDictionary
  • candidateDictionary

#on_candidate_selected(Dictionary, Dictionary)

func on_candidate_selected(candidate: Dictionary, context: Dictionary) -> void

Parameters

  • candidateDictionary
  • contextDictionary

#select_candidate(Array[Dictionary], Dictionary)

Returns the selected candidate index, or -1 if none selected.
func select_candidate(candidates: Array[Dictionary], context: Dictionary) -> int

Parameters

  • candidatesArray[Dictionary]
  • contextDictionary

Returns int

#valid_candidate_indices(Array[Dictionary])

static func valid_candidate_indices(candidates: Array[Dictionary]) -> PackedInt32Array

Parameters

  • candidatesArray[Dictionary]

Returns PackedInt32Array

Generated from Yarn Spinner for Godot GDScript 3.3.