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

YarnAssetProvider

Provides assets associated with yarn dialogue lines.
class_name YarnAssetProvider
extends RefCounted

Inherits from RefCounted

#Properties

#audio_base_path

var audio_base_path: String = "res://audio/dialogue/"

Type String

#audio_extensions

var audio_extensions: PackedStringArray = [...]

Type PackedStringArray

#auto_discover

var auto_discover: bool = true

Type bool

#base_path

var base_path: String = "res://dialogue/assets/"

Type String

#image_base_path

var image_base_path: String = "res://images/dialogue/"

Type String

#image_extensions

var image_extensions: PackedStringArray = [...]

Type PackedStringArray

#max_cache_size

var max_cache_size: int = 100

Type int

#use_threaded_loading

var use_threaded_loading: bool = true

Type bool

#Methods

#clear_cache()

func clear_cache() -> void

#clear()

func clear() -> void

#get_asset(String)

func get_asset(line_id: String) -> Resource

Parameters

  • line_idString

Returns Resource

#get_audio(String)

func get_audio(line_id: String) -> AudioStream

Parameters

  • line_idString

Returns AudioStream

#get_cache_stats()

func get_cache_stats() -> Dictionary

Returns Dictionary

#get_texture(String)

func get_texture(line_id: String) -> Texture2D

Parameters

  • line_idString

Returns Texture2D

#has_asset(String)

func has_asset(line_id: String) -> bool

Parameters

  • line_idString

Returns bool

#load_mappings_from_csv(String)

func load_mappings_from_csv(path: String) -> int

Parameters

  • pathString

Returns int

#poll_threaded_loads()

func poll_threaded_loads() -> void

#preload_assets(PackedStringArray)

func preload_assets(line_ids: PackedStringArray) -> void

Parameters

  • line_idsPackedStringArray

#register_asset(String, String)

func register_asset(line_id: String, resource_path: String) -> void

Parameters

  • line_idString
  • resource_pathString

#register_assets(Dictionary)

func register_assets(mappings: Dictionary) -> void

Parameters

  • mappingsDictionary

#set_base_path(String)

func set_base_path(path: String) -> void

Parameters

  • pathString

Generated from Yarn Spinner for Godot GDScript 3.3.