YarnGodotLocalisation
TranslationServer (keys are the line ID with translation_prefix prepended), and audio through translation remaps (Project Settings > Localization > Remaps), applied by ResourceLoader. There is no separate Yarn localisation backend.class_name YarnGodotLocalisation
extends RefCountedInherits from RefCounted
#Properties
#asset_locale_code
var asset_locale_code: String = ""Type String
#audio_base_path
var audio_base_path: String = ""Type String
#audio_extensions
var audio_extensions: PackedStringArray = [...]Type PackedStringArray
#fallback_locale_code
var fallback_locale_code: String = ""Type String
#fallback_to_program
var fallback_to_program: boolType bool
#max_audio_cache_size
var max_audio_cache_size: int = 50Type int
#text_locale_code
var text_locale_code: String = ""Type String
#translation_prefix
var translation_prefix: String = "YARN_"Type String
#use_fallback
var use_fallback: bool = trueType bool
#Signals
#locale_changed
signal locale_changed(locale: String)Parameters
localeString
#Methods
#add_translation_to_server(YarnProgram, String, String)
static func add_translation_to_server(program: YarnProgram, locale: String, prefix: String = "YARN_") -> voidParameters
programYarnProgramlocaleStringprefixString
#clear_audio_cache()
func clear_audio_cache() -> void#export_as_translation(YarnProgram, String, String)
static func export_as_translation(program: YarnProgram, locale: String, prefix: String = "YARN_") -> TranslationParameters
programYarnProgramlocaleStringprefixString
Returns Translation
#export_strings_for_translation(YarnProgram, String, String)
static func export_strings_for_translation(program: YarnProgram, output_path: String, prefix: String = "YARN_") -> intParameters
programYarnProgramoutput_pathStringprefixString
Returns int
#get_asset_locale()
func get_asset_locale() -> StringReturns String
#get_available_locales()
func get_available_locales() -> PackedStringArrayReturns PackedStringArray
#get_current_locale()
func get_current_locale() -> StringReturns String
#get_debug_info()
func get_debug_info() -> StringReturns String
#get_localised_audio(String)
func get_localised_audio(line_id: String) -> AudioStreamParameters
line_idString
Returns AudioStream
#get_localised_text(String)
func get_localised_text(line_id: String) -> StringParameters
line_idString
Returns String
#has_locale(String)
func has_locale(locale: String) -> boolParameters
localeString
Returns bool
#has_localised_audio(String)
func has_localised_audio(line_id: String) -> boolParameters
line_idString
Returns bool
#has_localised_text(String)
func has_localised_text(line_id: String) -> boolParameters
line_idString
Returns bool
#prepare_for_lines(PackedStringArray)
func prepare_for_lines(line_ids: PackedStringArray) -> voidParameters
line_idsPackedStringArray
#set_current_locale(String)
func set_current_locale(locale: String) -> voidParameters
localeString
#set_program(YarnProgram)
Generated from Yarn Spinner for Godot GDScript 3.3.