Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

DialogicResourceUtil

This contains the source code documentation of the class DialogicResourceUtil.

DialogicResourceUtil

Inherits: RefCounted

Properties


Methods

ReturnsMethod
voidupdate ( )
Dictionaryget_directory ( extension: String )
voidset_directory ( extension: String, directory: Dictionary )
voidupdate_directory ( extension: String )
Dictionaryadd_resource_to_directory ( file_path: String, directory: Dictionary )
Stringget_unique_identifier_by_path ( file_path: String )
Stringget_resource_path_from_identifier ( identifier: String, extension: String )
Resourceget_resource_from_identifier ( identifier: String, extension: String )
boolresource_exists_from_identifier ( identifier: String, extension: String )
voidchange_unique_identifier ( file_path: String, new_identifier: String )
voidchange_resource_path ( old_path: String, new_path: String )
voidremove_resource ( file_path: String )
boolis_identifier_unused ( extension: String, identifier: String )
voidregister_runtime_resource ( resource: Resource, identifier: String, extension: String )
Stringget_runtime_unique_identifier ( resource: Resource, extension: String )
Dictionaryget_label_cache ( )
voidset_label_cache ( cache: Dictionary )
voidupdate_label_cache ( )
Dictionaryget_audio_channel_cache ( )
Arrayget_channel_list ( )
voidset_audio_channel_cache ( cache: Dictionary )
voidupdate_audio_channel_cache ( )
Arrayget_event_cache ( )
Arrayupdate_event_cache ( )
voidupdate_special_resources ( )
Dictionarylist_special_resources ( type: String, filter: Dictionary = {} )
boolmatch_resource_filter ( dict: Dictionary, filter: Dictionary )
Dictionaryguess_special_resource ( type: String, string: String, default: Dictionary = {}, filter: Dictionary = {}, ignores: PackedStringArray = [] )
Dictionaryget_character_directory ( )
Dictionaryget_timeline_directory ( )
booltimeline_resource_exists ( timeline_identifier: String )
DialogicTimelineget_timeline_resource ( timeline_identifier: String )
DialogicCharacterget_character_resource ( character_identifier: String )
Arraylist_resources_of_type ( extension: String )
Arrayscan_folder ( path: String, extension: String )

Property Descriptions

var label_cache = {}

No description available.


var event_cache = []

No description available.


var channel_cache = {}

No description available.


var special_resources = {}

No description available.


Method Descriptions

func update ( ) ⇒ void

No description available.


func get_directory ( extension: String ) ⇒ Dictionary

No description available.


func set_directory ( extension: String, directory: Dictionary ) ⇒ void

No description available.


func update_directory ( extension: String ) ⇒ void

No description available.


func add_resource_to_directory ( file_path: String, directory: Dictionary ) ⇒ Dictionary

No description available.


func get_unique_identifier_by_path ( file_path: String ) ⇒ String

Returns the unique identifier for the given resource path. Returns an empty string if no identifier was found.


func get_resource_path_from_identifier ( identifier: String, extension: String ) ⇒ String

No description available.


func get_resource_from_identifier ( identifier: String, extension: String ) ⇒ Resource

Returns the resource associated with the given unique identifier. The expected extension is needed to use the right directory.


func resource_exists_from_identifier ( identifier: String, extension: String ) ⇒ bool

Returns a boolean that expresses whether the resource exists. The expected extension is needed to use the right directory.


func change_unique_identifier ( file_path: String, new_identifier: String ) ⇒ void

Editor Only


func change_resource_path ( old_path: String, new_path: String ) ⇒ void

No description available.


func remove_resource ( file_path: String ) ⇒ void

No description available.


func is_identifier_unused ( extension: String, identifier: String ) ⇒ bool

No description available.


func register_runtime_resource ( resource: Resource, identifier: String, extension: String ) ⇒ void

While usually the directory maps identifiers to paths, this method (only supposed to be used at runtime) allows mapping resources that are not saved to an identifier.


func get_runtime_unique_identifier ( resource: Resource, extension: String ) ⇒ String

No description available.


func get_label_cache ( ) ⇒ Dictionary

No description available.


func set_label_cache ( cache: Dictionary ) ⇒ void

No description available.


func update_label_cache ( ) ⇒ void

No description available.


func get_audio_channel_cache ( ) ⇒ Dictionary

No description available.


func get_channel_list ( ) ⇒ Array

No description available.


func set_audio_channel_cache ( cache: Dictionary ) ⇒ void

No description available.


func update_audio_channel_cache ( ) ⇒ void

No description available.


func get_event_cache ( ) ⇒ Array

Dialogic keeps a list that has each event once. This allows retrieval of that list.


func update_event_cache ( ) ⇒ Array

No description available.


func update_special_resources ( ) ⇒ void

No description available.


func list_special_resources ( type: String, filter: Dictionary = {} ) ⇒ Dictionary

No description available.


func match_resource_filter ( dict: Dictionary, filter: Dictionary ) ⇒ bool

No description available.


func guess_special_resource ( type: String, string: String, default: Dictionary = {}, filter: Dictionary = {}, ignores: PackedStringArray = [] ) ⇒ Dictionary

No description available.


func get_character_directory ( ) ⇒ Dictionary

No description available.


func get_timeline_directory ( ) ⇒ Dictionary

No description available.


func timeline_resource_exists ( timeline_identifier: String ) ⇒ bool

No description available.


func get_timeline_resource ( timeline_identifier: String ) ⇒ DialogicTimeline

No description available.


func get_character_resource ( character_identifier: String ) ⇒ DialogicCharacter

No description available.


func list_resources_of_type ( extension: String ) ⇒ Array

No description available.


func scan_folder ( path: String, extension: String ) ⇒ Array

No description available.