YarnLineProvider
class_name YarnLineProvider
extends ResourceInherits from Resource
#Constants
#INVALID_LINE_ID
const INVALID_LINE_ID = "<missing>"#INVALID_LINE_TEXT
const INVALID_LINE_TEXT = "!! ERROR: Missing line!"#Properties
#asset_locale_code
var asset_locale_code: String = ""Type String
#fallback_locale_code
var fallback_locale_code: String = ""Type String
#godot_localisation
var godot_localisation: YarnGodotLocalisation#locale
var locale: StringType String
#text_locale_code
var text_locale_code: String = ""Type String
#use_fallback
var use_fallback: bool = trueType bool
#Methods
#add_to_translation_server(String)
func add_to_translation_server(locale_code: String) -> voidParameters
locale_codeString
#clear_shadow_lines()
func clear_shadow_lines() -> void#deregister_marker_processor(String)
func deregister_marker_processor(attribute_name: String) -> voidParameters
attribute_nameString
#export_for_godot_translation(String)
func export_for_godot_translation(output_path: String) -> intParameters
output_pathString
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_localisation()
func get_localisation() -> YarnGodotLocalisationReturns YarnGodotLocalisation
#get_localised_audio(String)
func get_localised_audio(line_id: String) -> AudioStreamParameters
line_idString
Returns AudioStream
#get_localised_line(YarnLine)
func get_localised_line(line: YarnLine) -> boolParameters
lineYarnLine
Returns bool
#get_localised_option(YarnOption)
#get_markup_parser()
func get_markup_parser() -> YarnMarkupParserReturns YarnMarkupParser
#get_shadow_line_source(String)
func get_shadow_line_source(line_id: String) -> StringParameters
line_idString
Returns String
#get_translation_prefix()
func get_translation_prefix() -> StringReturns String
#has_locale(String)
func has_locale(locale_code: String) -> boolParameters
locale_codeString
Returns bool
#has_localised_audio(String)
func has_localised_audio(line_id: String) -> boolParameters
line_idString
Returns bool
#parse_markup(String, String)
func parse_markup(text: String, locale_code: String) -> YarnMarkupParseResultParameters
textStringlocale_codeString
Returns YarnMarkupParseResult
#prepare_for_lines(PackedStringArray)
func prepare_for_lines(line_ids: PackedStringArray) -> voidParameters
line_idsPackedStringArray
#register_bbcode_processor(YarnMarkupAttributeProcessor)
func register_bbcode_processor(processor: YarnMarkupAttributeProcessor) -> voidParameters
processorYarnMarkupAttributeProcessor
#register_marker_processor(String, YarnAttributeMarkerProcessor)
func register_marker_processor(attribute_name: String, processor: YarnAttributeMarkerProcessor) -> voidParameters
attribute_nameStringprocessorYarnAttributeMarkerProcessor
#register_shadow_line(String, String)
func register_shadow_line(line_id: String, shadow_id: String) -> voidParameters
line_idStringshadow_idString
#resolve_source_line_id(String)
func resolve_source_line_id(line_id: String) -> StringParameters
line_idString
Returns String
#set_audio_base_path(String)
func set_audio_base_path(path: String) -> voidParameters
pathString
#set_current_locale(String)
func set_current_locale(locale_code: String) -> voidParameters
locale_codeString
#set_program(YarnProgram)
#set_translation_prefix(String)
func set_translation_prefix(prefix: String) -> voidParameters
prefixString
#unregister_bbcode_processor(YarnMarkupAttributeProcessor)
func unregister_bbcode_processor(processor: YarnMarkupAttributeProcessor) -> voidParameters
processorYarnMarkupAttributeProcessor
#unregister_shadow_line(String)
func unregister_shadow_line(line_id: String) -> voidParameters
line_idString
Generated from Yarn Spinner for Godot GDScript 3.3.