Update Dialogic to most recent build; iron out a few cutscene timing details

Author: food-please

addons/dialogic/Core/DialogicGameHandler.gd

@@ -21,7 +21,7 @@ static func get_directory(extension:String) -> Dictionary:
 	if Engine.has_meta(extension+'_directory'):
 		return Engine.get_meta(extension+'_directory', {})
 
-	var directory := ProjectSettings.get_setting("dialogic/directories/"+extension+'_directory', {})
+	var directory: Dictionary = ProjectSettings.get_setting("dialogic/directories/"+extension+'_directory', {})
 	Engine.set_meta(extension+'_directory', directory)
 	return directory
 
@@ -59,13 +59,17 @@ static func add_resource_to_directory(file_path:String, directory:Dictionary) ->
 	return directory
 
 
+## Returns the unique identifier for the given resource path.
+## Returns an empty string if no identifier was found.
 static func get_unique_identifier(file_path:String) -> String:
-	var identifier := get_directory(file_path.get_extension()).find_key(file_path)
+	var identifier: String = get_directory(file_path.get_extension()).find_key(file_path)
 	if typeof(identifier) == TYPE_STRING:
 		return identifier
 	return ""
 
 
+## Returns the resource associated with the given unique identifier.
+## The expected extension is needed to use the right directory.
 static func get_resource_from_identifier(identifier:String, extension:String) -> Resource:
 	var path: String = get_directory(extension).get(identifier, '')
 	if ResourceLoader.exists(path):
@@ -75,7 +79,7 @@ static func get_resource_from_identifier(identifier:String, extension:String) ->
 
 static func change_unique_identifier(file_path:String, new_identifier:String) -> void:
 	var directory := get_directory(file_path.get_extension())
-	var key := directory.find_key(file_path)
+	var key: String = directory.find_key(file_path)
 	while key != null:
 		if key == new_identifier:
 			break
@@ -87,7 +91,7 @@ static func change_unique_identifier(file_path:String, new_identifier:String) ->
 
 static func change_resource_path(old_path:String, new_path:String) -> void:
 	var directory := get_directory(new_path.get_extension())
-	var key := directory.find_key(old_path)
+	var key: String = directory.find_key(old_path)
 	while key != null:
 		directory[key] = new_path
 		key = directory.find_key(old_path)
@@ -96,12 +100,13 @@ static func change_resource_path(old_path:String, new_path:String) -> void:
 
 static func remove_resource(file_path:String) -> void:
 	var directory := get_directory(file_path.get_extension())
-	var key := directory.find_key(file_path)
+	var key: String = directory.find_key(file_path)
 	while key != null:
 		directory.erase(key)
 		key = directory.find_key(file_path)
 	set_directory(file_path.get_extension(), directory)
 
+
 static func is_identifier_unused(extension:String, identifier:String) -> bool:
 	return not identifier in get_directory(extension)
 
@@ -137,6 +142,7 @@ static func update_label_cache() -> void:
 #region EVENT CACHE
 ################################################################################
 
+##  Dialogic keeps a list that has each event once. This allows retrieval of that list.
 static func get_event_cache() -> Array:
 	if not event_cache.is_empty():
 		return event_cache
@@ -150,7 +156,7 @@ static func update_event_cache() -> Array:
 	for indexer in DialogicUtil.get_indexers():
 		# build event cache
 		for event in indexer._get_events():
-			if not FileAccess.file_exists(event):
+			if not ResourceLoader.exists(event):
 				continue
 			if not 'event_end_branch.gd' in event and not 'event_text.gd' in event:
 				event_cache.append(load(event).new())
@@ -163,6 +169,9 @@ static func update_event_cache() -> Array:
 
 #endregion
 
+#region SPECIAL RESOURCES
+################################################################################
+
 static func update_special_resources() -> void:
 	special_resources = []
 	for indexer in DialogicUtil.get_indexers():
@@ -185,7 +194,7 @@ static func guess_special_resource(type:String, name:String, default:="") -> Str
 			return path
 	return default
 
-
+#endregion
 
 #region HELPERS
 ################################################################################

…s/dialogic/Other/DialogicResourceUtil.gd …ns/dialogic/Core/DialogicResourceUtil.gdaddons/dialogic/Other/DialogicResourceUtil.gd renamed to addons/dialogic/Core/DialogicResourceUtil.gd addons/dialogic/Other/DialogicResourceUtil.gd renamed to addons/dialogic/Core/DialogicResourceUtil.gd

@@ -20,6 +20,7 @@ static func get_dialogic_plugin() -> Node:
 
 #endregion
 
+
 ## Returns the autoload when in-game.
 static func autoload() -> DialogicGameHandler:
 	if Engine.is_editor_hint():
@@ -28,9 +29,10 @@ static func autoload() -> DialogicGameHandler:
 		return null
 	return Engine.get_main_loop().root.get_node("Dialogic")
 
+
 #region FILE SYSTEM
 ################################################################################
-static func listdir(path: String, files_only: bool = true, throw_error:bool = true, full_file_path:bool = false, include_imports := false) -> Array:
+static func listdir(path: String, files_only:= true, throw_error:= true, full_file_path:= false, include_imports := false) -> Array:
 	var files: Array = []
 	if path.is_empty(): path = "res://"
 	if DirAccess.dir_exists_absolute(path):
@@ -55,30 +57,52 @@ static func listdir(path: String, files_only: bool = true, throw_error:bool = tr
 	return files
 
 
-
 static func get_module_path(name:String, builtin:=true) -> String:
 	if builtin:
 		return "res://addons/dialogic/Modules".path_join(name)
 	else:
 		return ProjectSettings.get_setting('dialogic/extensions_folder', 'res://addons/dialogic_additions').path_join(name)
 
 
+## This is a private and editor-only function.
+##
+## Populates the [class DialogicGameHandler] with new custom subsystems by
+## directly manipulating the file's content and then importing the file.
+static func _update_autoload_subsystem_access() -> void:
+	if not Engine.is_editor_hint():
+		printerr("[Dialogic] This function is only available in the editor.")
+		return
+
+	var script: Script = load("res://addons/dialogic/Core/DialogicGameHandler.gd")
+	var new_subsystem_access_list := "#region SUBSYSTEMS\n"
+
+	for indexer: DialogicIndexer in get_indexers(true, true):
+
+		for subsystem: Dictionary in indexer._get_subsystems().duplicate(true):
+			new_subsystem_access_list += '\nvar {name} := preload("{script}").new():\n\tget: return get_subsystem("{name}")\n'.format(subsystem)
+
+	new_subsystem_access_list += "\n#endregion"
+	script.source_code = RegEx.create_from_string("#region SUBSYSTEMS\\n#*\\n((?!#endregion)(.*\\n))*#endregion").sub(script.source_code, new_subsystem_access_list)
+	ResourceSaver.save(script)
+	Engine.get_singleton("EditorInterface").get_resource_filesystem().reimport_files(["res://addons/dialogic/Core/DialogicGameHandler.gd"])
+
+
 static func get_indexers(include_custom := true, force_reload := false) -> Array[DialogicIndexer]:
 	if Engine.get_main_loop().has_meta('dialogic_indexers') and !force_reload:
 		return Engine.get_main_loop().get_meta('dialogic_indexers')
 
-	var indexers : Array[DialogicIndexer] = []
+	var indexers: Array[DialogicIndexer] = []
 
 	for file in listdir(DialogicUtil.get_module_path(''), false):
-		var possible_script:String = DialogicUtil.get_module_path(file).path_join("index.gd")
-		if FileAccess.file_exists(possible_script):
+		var possible_script: String = DialogicUtil.get_module_path(file).path_join("index.gd")
+		if ResourceLoader.exists(possible_script):
 			indexers.append(load(possible_script).new())
 
 	if include_custom:
 		var extensions_folder: String = ProjectSettings.get_setting('dialogic/extensions_folder', "res://addons/dialogic_additions/")
 		for file in listdir(extensions_folder, false, false):
 			var possible_script: String = extensions_folder.path_join(file + "/index.gd")
-			if FileAccess.file_exists(possible_script):
+			if ResourceLoader.exists(possible_script):
 				indexers.append(load(possible_script).new())
 
 	Engine.get_main_loop().set_meta('dialogic_indexers', indexers)
@@ -182,19 +206,73 @@ static func get_next_translation_id() -> String:
 #region VARIABLES
 ################################################################################
 
+enum VarTypes {ANY, STRING, FLOAT, INT, BOOL}
+
+
+static func get_default_variables() -> Dictionary:
+	return ProjectSettings.get_setting('dialogic/variables', {})
+
+
 # helper that converts a nested variable dictionary into an array with paths
-static func list_variables(dict:Dictionary, path := "") -> Array:
+static func list_variables(dict:Dictionary, path := "", type:=VarTypes.ANY) -> Array:
 	var array := []
 	for key in dict.keys():
 		if typeof(dict[key]) == TYPE_DICTIONARY:
-			array.append_array(list_variables(dict[key], path+key+"."))
+			array.append_array(list_variables(dict[key], path+key+".", type))
 		else:
-			array.append(path+key)
+			if type == VarTypes.ANY or get_variable_value_type(dict[key]) == type:
+				array.append(path+key)
 	return array
 
+
+static func get_variable_value_type(value:Variant) -> int:
+	match typeof(value):
+		TYPE_STRING:
+			return VarTypes.STRING
+		TYPE_FLOAT:
+			return VarTypes.FLOAT
+		TYPE_INT:
+			return VarTypes.INT
+		TYPE_BOOL:
+			return VarTypes.BOOL
+	return VarTypes.ANY
+
+
+static func get_variable_type(path:String, dict:Dictionary={}) -> VarTypes:
+	if dict.is_empty():
+		dict = get_default_variables()
+	return get_variable_value_type(_get_value_in_dictionary(path, dict))
+
+
+## This will set a value in a dictionary (or a sub-dictionary based on the path)
+## e.g. it could set "Something.Something.Something" in {'Something':{'Something':{'Someting':"value"}}}
+static func _set_value_in_dictionary(path:String, dictionary:Dictionary, value):
+	if '.' in path:
+		var from := path.split('.')[0]
+		if from in dictionary.keys():
+			dictionary[from] = _set_value_in_dictionary(path.trim_prefix(from+"."), dictionary[from], value)
+	else:
+		if path in dictionary.keys():
+			dictionary[path] = value
+	return dictionary
+
+
+## This will get a value in a dictionary (or a sub-dictionary based on the path)
+## e.g. it could get "Something.Something.Something" in {'Something':{'Something':{'Someting':"value"}}}
+static func _get_value_in_dictionary(path:String, dictionary:Dictionary, default= null) -> Variant:
+	if '.' in path:
+		var from := path.split('.')[0]
+		if from in dictionary.keys():
+			return _get_value_in_dictionary(path.trim_prefix(from+"."), dictionary[from], default)
+	else:
+		if path in dictionary.keys():
+			return dictionary[path]
+	return default
+
 #endregion
 
 
+
 #region STYLES
 ################################################################################
 
@@ -207,7 +285,7 @@ static func get_fallback_style() -> DialogicStyle:
 
 
 static func get_default_style() -> DialogicStyle:
-	var default := ProjectSettings.get_setting('dialogic/layout/default_style', '')
+	var default: String = ProjectSettings.get_setting('dialogic/layout/default_style', '')
 	if !ResourceLoader.exists(default):
 		return get_fallback_style()
 	return load(default)
@@ -217,7 +295,7 @@ static func get_style_by_name(name:String) -> DialogicStyle:
 	if name.is_empty():
 		return get_default_style()
 
-	var styles := ProjectSettings.get_setting('dialogic/layout/style_list', [])
+	var styles: Array = ProjectSettings.get_setting('dialogic/layout/style_list', [])
 	for style in styles:
 		if not ResourceLoader.exists(style):
 			continue
@@ -275,7 +353,7 @@ static func get_scene_export_defaults(node:Node) -> Dictionary:
 ################################################################################
 
 static func setup_script_property_edit_node(property_info: Dictionary, value:Variant, property_changed:Callable) -> Control:
-	var input :Control = null
+	var input: Control = null
 	match property_info['type']:
 		TYPE_BOOL:
 			input = CheckBox.new()
@@ -287,7 +365,7 @@ static func setup_script_property_edit_node(property_info: Dictionary, value:Var
 			if value != null:
 				input.color = value
 			input.color_changed.connect(DialogicUtil._on_export_color_submitted.bind(property_info.name, property_changed))
-			input.custom_minimum_size.x = DialogicUtil.get_editor_scale()*50
+			input.custom_minimum_size.x = get_editor_scale()*50
 		TYPE_INT:
 			if property_info['hint'] & PROPERTY_HINT_ENUM:
 				input = OptionButton.new()
@@ -321,14 +399,15 @@ static func setup_script_property_edit_node(property_info: Dictionary, value:Var
 			input.value_changed.connect(DialogicUtil._on_export_number_submitted.bind(property_info.name, property_changed))
 			if value != null:
 				input.value = value
-		TYPE_VECTOR2:
-			input = load("res://addons/dialogic/Editor/Events/Fields/Vector2.tscn").instantiate()
-			input.set_value(value)
+		TYPE_VECTOR2, TYPE_VECTOR3, TYPE_VECTOR4:
+			var vectorSize: String = type_string(typeof(value))[-1]
+			input = load("res://addons/dialogic/Editor/Events/Fields/field_vector" + vectorSize + ".tscn").instantiate()
 			input.property_name = property_info['name']
+			input.set_value(value)
 			input.value_changed.connect(DialogicUtil._on_export_vector_submitted.bind(property_changed))
 		TYPE_STRING:
 			if property_info['hint'] & PROPERTY_HINT_FILE or property_info['hint'] & PROPERTY_HINT_DIR:
-				input = load("res://addons/dialogic/Editor/Events/Fields/FilePicker.tscn").instantiate()
+				input = load("res://addons/dialogic/Editor/Events/Fields/field_file.tscn").instantiate()
 				input.file_filter = property_info['hint_string']
 				input.file_mode = FileDialog.FILE_MODE_OPEN_FILE
 				if property_info['hint'] == PROPERTY_HINT_DIR:
@@ -341,7 +420,7 @@ static func setup_script_property_edit_node(property_info: Dictionary, value:Var
 				input.value_changed.connect(DialogicUtil._on_export_file_submitted.bind(property_changed))
 			elif property_info['hint'] & PROPERTY_HINT_ENUM:
 				input = OptionButton.new()
-				var options :PackedStringArray = []
+				var options: PackedStringArray = []
 				for x in property_info['hint_string'].split(','):
 					options.append(x.split(':')[0].strip_edges())
 					input.add_item(options[-1])
@@ -360,9 +439,10 @@ static func setup_script_property_edit_node(property_info: Dictionary, value:Var
 			input = LineEdit.new()
 			if value != null:
 				input.text = value
-			input.text_submitted.connect(DialogicUtil._on_export_input_text_submitted.bind(property_info.name, property_changed))
+			input.text_submitted.connect(_on_export_input_text_submitted.bind(property_info.name, property_changed))
 	return input
 
+
 static func _on_export_input_text_submitted(text:String, property_name:String, callable: Callable) -> void:
 	callable.call(property_name, var_to_str(text))
 
@@ -384,7 +464,7 @@ static func _on_export_file_submitted(property_name:String, value:String, callab
 static func _on_export_string_enum_submitted(value:int, property_name:String, list:PackedStringArray, callable: Callable):
 	callable.call(property_name, var_to_str(list[value]))
 
-static func _on_export_vector_submitted(property_name:String, value:Vector2, callable: Callable) -> void:
+static func _on_export_vector_submitted(property_name:String, value:Variant, callable: Callable) -> void:
 	callable.call(property_name, var_to_str(value))
 
 #endregion

addons/dialogic/Other/DialogicUtil.gd addons/dialogic/Core/DialogicUtil.gdaddons/dialogic/Other/DialogicUtil.gd renamed to addons/dialogic/Core/DialogicUtil.gd

@@ -1,5 +1,5 @@
-extends Node
 class_name DialogicSubsystem
+extends Node
 
 var dialogic: DialogicGameHandler = null
 
@@ -10,21 +10,25 @@ enum LoadFlags {FULL_LOAD, ONLY_DNODES}
 func post_install() -> void:
 	pass
 
+
 # To be overriden by sub-classes
 # Fill in everything that should be cleared (for example before loading a different state)
 func clear_game_state(clear_flag:=DialogicGameHandler.ClearFlags.FULL_CLEAR) -> void:
 	pass
 
+
 # To be overriden by sub-classes
 # Fill in everything that should be loaded using the dialogic_game_handler.current_state_info
 # This is called when a save is loaded
 func load_game_state(load_flag:=LoadFlags.FULL_LOAD) -> void:
 	pass
 
+
 # To be overriden by sub-classes
 func pause() -> void:
 	pass
 
+
 # To be overriden by sub-classes
 func resume() -> void:
 	pass

…ons/dialogic/Other/Dialogic_Subsystem.gd …dons/dialogic/Core/Dialogic_Subsystem.gdaddons/dialogic/Other/Dialogic_Subsystem.gd renamed to addons/dialogic/Core/Dialogic_Subsystem.gd addons/dialogic/Other/Dialogic_Subsystem.gd renamed to addons/dialogic/Core/Dialogic_Subsystem.gd

@@ -13,7 +13,7 @@ var this_folder : String = get_script().resource_path.get_base_dir()
 ## Return an array with all the paths to the event scripts.[br]
 ## You can use the [property this_folder].path_join('my_event.gd')
 func _get_events() -> Array:
-	if FileAccess.file_exists(this_folder.path_join('event.gd')):
+	if ResourceLoader.exists(this_folder.path_join('event.gd')):
 		return [this_folder.path_join('event.gd')]
 	return []
 

addons/dialogic/Other/index_class.gd addons/dialogic/Core/index_class.gdaddons/dialogic/Other/index_class.gd renamed to addons/dialogic/Core/index_class.gd

@@ -12,6 +12,7 @@ func _load_portrait_data(data:Dictionary) -> void:
 	%IgnoreScale.set_pressed_no_signal(data.get('ignore_char_scale', false))
 	%PortraitScale.value = data.get('scale', 1.0)*100
 	%PortraitOffset.set_value(data.get('offset', Vector2()))
+	%PortraitOffset._load_display_info({'step':1})
 	%PortraitMirror.set_pressed_no_signal(data.get('mirror', false))
 
 

addons/dialogic/Editor/CharacterEditor/char_edit_p_section_layout.gd

@@ -1,7 +1,7 @@
 [gd_scene load_steps=3 format=3 uid="uid://crke8suvv52c6"]
 
 [ext_resource type="Script" path="res://addons/dialogic/Editor/CharacterEditor/char_edit_p_section_layout.gd" id="1_76vf2"]
-[ext_resource type="PackedScene" uid="uid://dtimnsj014cu" path="res://addons/dialogic/Editor/Events/Fields/Vector2.tscn" id="2_c8kyi"]
+[ext_resource type="PackedScene" uid="uid://dtimnsj014cu" path="res://addons/dialogic/Editor/Events/Fields/field_vector2.tscn" id="2_c8kyi"]
 
 [node name="Layout" type="HFlowContainer"]
 offset_right = 428.0