Big signal update (#1502)

Added many signals to all the subsystems. 
Most of these just give one info dictionary argument. While this is initally not as nice as giving named arguments, it means we can way more easily provide mode information in the future without breaking any code.

Added signals:
- Voice: voiceline_started, voiceline_finished, voiceline_stopped
- Variable: variable_changed, variable_was_set
- TextInput: input_confirmed, input_shown
- Text: text_finished, speaker_updated, textbox_visibility_changed
- Style: style_changed
- Jump: switched_timeline, jumped_to_label, returned_from_jump
- Choices: choice_selected, choices_shown
- Portraits: character_joined, character_left, character_portrait_changed, character_moved, position_changed
- Background: background_changed
- Audio: music_started, sound_started

Also:
- removed the voice timer from the voice subsystem
- fixed typo in Jump.resume_from_last_jump()

Author: Jowan-Spooner

addons/dialogic/Events/Audio/subsystem_audio.gd

@@ -2,6 +2,9 @@ extends DialogicSubsystem
 
 ## Subsystem that manages music and sounds.
 
+signal music_started(info:Dictionary)
+signal sound_started(info:Dictionary)
+
 var base_music_player := AudioStreamPlayer.new()
 var base_sound_player := AudioStreamPlayer.new()
 
@@ -43,7 +46,7 @@ func _ready() -> void:
 ## Updates the background music. Will fade out previous music.
 func update_music(path:String = '', volume:float = 0.0, audio_bus:String = "Master", fade_time:float = 0.0, loop:bool = true) -> void:
 	dialogic.current_state_info['music'] = {'path':path, 'volume':volume, 'audio_bus':audio_bus, 'loop':loop}
-	
+	music_started.emit(dialogic.current_state_info['music'])
 	var fader: Tween = null
 	if base_music_player.playing or !path.is_empty():
 		fader = create_tween()
@@ -77,6 +80,7 @@ func update_music(path:String = '', volume:float = 0.0, audio_bus:String = "Mast
 ## Plays a given sound file.
 func play_sound(path:String, volume:float = 0.0, audio_bus:String = "Master", loop :bool= false) -> void:
 	if base_sound_player != null and !path.is_empty():
+		sound_started.emit({'path':path, 'volume':volume, 'audio_bus':audio_bus, 'loop':loop})
 		var new_sound_node := base_sound_player.duplicate()
 		new_sound_node.name = "Sound"
 		new_sound_node.stream = load(path)

addons/dialogic/Events/Background/subsystem_backgrounds.gd

@@ -2,7 +2,10 @@ extends DialogicSubsystem
 
 ## Subsystem for managing backgrounds. 
 
-var default_background_scene = load(get_script().resource_path.get_base_dir().path_join('default_background.tscn'))
+signal background_changed(info:Dictionary)
+
+
+var default_background_scene :PackedScene = load(get_script().resource_path.get_base_dir().path_join('default_background.tscn'))
 ####################################################################################################
 ##					STATE
 ####################################################################################################
@@ -29,6 +32,7 @@ func load_game_state():
 ## To do so implement [_should_do_background_update()] on the custom background scene.
 ## Then  [_update_background()] will be called directly on that previous scene.
 func update_background(scene:String = '', argument:String = '', fade_time:float = 0.0) -> void:
+	var info := {'scene':scene, 'argument':argument, 'fade_time':fade_time, 'same_scene':false}
 	for node in get_tree().get_nodes_in_group('dialogic_background_holders'):
 		if node.visible:
 			var bg_set: bool = false
@@ -38,6 +42,7 @@ func update_background(scene:String = '', argument:String = '', fade_time:float
 						if old_bg.has_method('_update_background'):
 							old_bg._update_background(argument, fade_time)
 							bg_set = true
+							info['same_scene'] = true
 			if !bg_set:
 				# remove previous backgrounds
 				for old_bg in node.get_children():
@@ -70,8 +75,9 @@ func update_background(scene:String = '', argument:String = '', fade_time:float
 
 					elif "modulate" in new_node:
 						new_node.modulate = Color.TRANSPARENT
-						var tween = new_node.create_tween()
+						var tween := new_node.create_tween()
 						tween.tween_property(new_node, "modulate", Color.WHITE, fade_time)
 
 	dialogic.current_state_info['background_scene'] = scene
 	dialogic.current_state_info['background_argument'] = argument
+	background_changed.emit(info)

addons/dialogic/Events/Character/subsystem_portraits.gd

@@ -2,8 +2,15 @@ extends DialogicSubsystem
 
 ## Subsystem that manages portraits and portrait positions.
 
+signal character_joined(info:Dictionary)
+signal character_left(info:Dictionary)
+signal character_portrait_changed(info:Dictionary)
+signal character_moved(info:Dictionary)
+signal position_changed(info:Dictionary)
+
+
 ## The default portrait scene.
-var default_portrait_scene = load(get_script().resource_path.get_base_dir().path_join('default_portrait.tscn'))
+var default_portrait_scene :PackedScene = load(get_script().resource_path.get_base_dir().path_join('default_portrait.tscn'))
 
 ## A reference to the current [DialogicNode_PortraitHolder].
 var _portrait_holder_reference: Node = null
@@ -44,7 +51,6 @@ func resume() -> void:
 
 ## Joins a character and then calls change_portrait().
 func add_portrait(character:DialogicCharacter, portrait:String,  position_idx:int, mirrored: bool = false, z_index: int = 0, extra_data:String = "") -> Node:
-	var character_node = null
 
 	if portrait.is_empty():
 		portrait = character.default_portrait
@@ -59,7 +65,7 @@ func add_portrait(character:DialogicCharacter, portrait:String,  position_idx:in
 			printerr("[DialogicError] Character ",character.display_name, " has no default portrait to use.")
 			return null
 
-	character_node = Node2D.new()
+	var character_node := Node2D.new()
 	character_node.name = character.get_character_name()
 	character_node.set_meta('character', character)
 	character_node.z_index = z_index
@@ -81,6 +87,10 @@ func add_portrait(character:DialogicCharacter, portrait:String,  position_idx:in
 	change_portrait_extradata(character, extra_data)
 	change_portrait_z_index(character, z_index)
 
+	var info := {'character':character}
+	info.merge(dialogic.current_state_info['portraits'][character.resource_path])
+	character_joined.emit(info)
+	
 	return character_node
 
 
@@ -97,19 +107,23 @@ func change_portrait(character:DialogicCharacter, portrait:String, update_transf
 		print_debug('[Dialogic] Change to not-existing portrait will be ignored!')
 		return
 
+	var info := {'character':character, 'portrait':portrait, 'same_scene':false}
+	
 	var char_node :Node = dialogic.current_state_info.portraits[character.resource_path].node
 
 	# path to the scene to use
 	var scene_path :String = character.portraits[portrait].get('scene', '')
 
-	var portrait_node = null
+	var portrait_node : Node = null
 
 	# check if the scene is the same as the currently loaded scene
 	if (char_node.get_child_count() and 
 		character.portraits[dialogic.current_state_info['portraits'][character.resource_path]['portrait']].get('scene', '') == scene_path and 
 		# also check if the scene supports changing to the given portrait
 		(!char_node.get_child(0).has_method('_should_do_portrait_update') or char_node.get_child(0)._should_do_portrait_update(character, portrait))):
 			portrait_node = char_node.get_child(0)
+			info['same_scene'] = true
+			
 	else:
 		# remove previous portrait
 		if char_node.get_child_count():
@@ -118,13 +132,14 @@ func change_portrait(character:DialogicCharacter, portrait:String, update_transf
 		if scene_path.is_empty():
 			portrait_node = default_portrait_scene.instantiate()
 		else:
-			var p = load(scene_path)
+			var p :PackedScene = load(scene_path)
 			if p:
 				portrait_node = p.instantiate()
 			else:
 				push_error('Dialogic: Portrait node "' + str(scene_path) + '" for character [' + character.display_name + '] could not be loaded. Your portrait might not show up on the screen.')
 
 	dialogic.current_state_info['portraits'][character.resource_path]['portrait'] = portrait
+	character_portrait_changed.emit(info)
 
 	if portrait_node:
 		for property in character.portraits[portrait].get('export_overrides', {}).keys():
@@ -194,13 +209,13 @@ func animate_portrait(character:DialogicCharacter, animation_path:String, length
 		print_debug('[DialogicError] Cannot animate portrait of null/not joined character.')
 		return null
 
-	var char_node = dialogic.current_state_info['portraits'][character.resource_path].node
+	var char_node :Node = dialogic.current_state_info['portraits'][character.resource_path].node
 
 	if dialogic.current_state_info['portraits'][character.resource_path].get('animation_node', null):
 		if is_instance_valid(dialogic.current_state_info['portraits'][character.resource_path].animation_node):
 			dialogic.current_state_info['portraits'][character.resource_path].animation_node.queue_free()
-	var anim_script = load(animation_path)
-	var anim_node = Node.new()
+	var anim_script :Script = load(animation_path)
+	var anim_node := Node.new()
 	anim_node.set_script(anim_script)
 	anim_node = (anim_node as DialogicAnimation)
 	anim_node.node = char_node
@@ -235,11 +250,11 @@ func move_portrait(character:DialogicCharacter, position_idx:int, time:float = 0
 		remove_portrait(character)
 		return
 
-	
 	char_node.position = global_pos-char_node.get_parent().global_position
 	update_portrait_transform(character, time)
 
 	dialogic.current_state_info.portraits[character.resource_path].position_index = position_idx
+	character_moved.emit({'character':character, 'position_index':position_idx, 'time':time})
 
 
 func change_portrait_z_index(character:DialogicCharacter, z_index:int, update_zindex:= true) -> void:
@@ -249,6 +264,7 @@ func change_portrait_z_index(character:DialogicCharacter, z_index:int, update_zi
 
 
 func remove_portrait(character:DialogicCharacter) -> void:
+	character_left.emit({'character':character})
 	dialogic.current_state_info['portraits'][character.resource_path].node.queue_free()
 	dialogic.current_state_info['portraits'].erase(character.resource_path)
 
@@ -266,18 +282,20 @@ func add_portrait_position(position_index: int, position:Vector2) -> void:
 		new_position.origin_anchor = example_position.origin_anchor
 		new_position.position_index = position_index
 		new_position.position = position-new_position._get_origin_position()
+		position_changed.emit({'change':'added', 'container_node':new_position, 'position_index':position_index})
 
 
 func move_portrait_position(position_index: int, vector:Vector2, relative:bool = false, time:float = 0.0) -> void:
-	for portrait_position in get_tree().get_nodes_in_group('dialogic_portrait_container'):
-		if portrait_position.is_visible_in_tree() and portrait_position.position_index == position_index:
-			if !portrait_position.has_meta('default_position'):
-				portrait_position.set_meta('default_position', portrait_position.position)
-			var tween := portrait_position.create_tween()
+	for portrait_container in get_tree().get_nodes_in_group('dialogic_portrait_container'):
+		if portrait_container.is_visible_in_tree() and portrait_container.position_index == position_index:
+			if !portrait_container.has_meta('default_position'):
+				portrait_container.set_meta('default_position', portrait_container.position)
+			var tween := portrait_container.create_tween()
 			if !relative:
-				tween.tween_property(portrait_position, 'position', vector, time)
+				tween.tween_property(portrait_container, 'position', vector, time)
 			else:
-				tween.tween_property(portrait_position, 'position', vector, time).as_relative()
+				tween.tween_property(portrait_container, 'position', vector, time).as_relative()
+			position_changed.emit({'change':'moved', 'container_node':portrait_container, 'position_index':position_index})
 			return
 
 	# If this is reached, no position could be found. If the position is absolute, we will add it.

addons/dialogic/Events/Choice/subsystem_choices.gd

@@ -2,8 +2,12 @@ extends DialogicSubsystem
 
 ## Subsystem that manages showing and activating of choices.
 
+signal choice_selected(info:Dictionary)
+signal choices_shown(info:Dictionary)
+
+
 ## Used to block choices from being clicked for a couple of seconds (if delay is set in settings).
-var choice_blocker = Timer.new()
+var choice_blocker := Timer.new()
 
 var last_question_info := {}
 
@@ -29,8 +33,8 @@ func clear_game_state():
 func hide_all_choices() -> void:
 	for node in get_tree().get_nodes_in_group('dialogic_choice_button'):
 		node.hide()
-		if node.is_connected('button_up', self.choice_selected):
-			node.disconnect('button_up', self.choice_selected)
+		if node.is_connected('button_up', _on_ChoiceButton_choice_selected):
+			node.disconnect('button_up', _on_ChoiceButton_choice_selected)
 
 
 ## Lists all current choices and shows buttons.
@@ -59,7 +63,7 @@ func show_current_choices() -> void:
 			show_choice(button_idx, choice_event.get_property_translated('text'), true, choice_index)
 			last_question_info['choices'].append(choice_event.get_property_translated('text'))
 			button_idx += 1
-	
+	choices_shown.emit(last_question_info)
 	choice_blocker.start(float(DialogicUtil.get_project_setting('dialogic/choices/delay', 0.2)))
 
 
@@ -87,29 +91,22 @@ func show_choice(button_index:int, text:String, enabled:bool, event_index:int) -
 				node.shortcut = shortcut
 
 			node.disabled = not enabled
-			node.button_up.connect(choice_selected.bind(event_index))
+			node.button_up.connect(_on_ChoiceButton_choice_selected.bind(event_index, 
+				{'button_index':button_index, 'text':text, 'enabled':enabled, 'event_index':event_index}))
 
 		if node.choice_index > 0:
 			idx = node.choice_index
 		idx += 1
 
-####################################################################################################
-##					HELPERS
-####################################################################################################
-func choice_selected(event_index:int) -> void:
+
+func _on_ChoiceButton_choice_selected(event_index:int, choice_info:={}) -> void:
 	if Dialogic.paused or not choice_blocker.is_stopped():
 		return
+	choice_selected.emit(choice_info)
 	hide_all_choices()
 	dialogic.current_state = dialogic.states.IDLE
 	dialogic.handle_event(event_index)
-
-## QUESTION/CHOICES
-func is_question(index:int) -> bool:
-	if dialogic.current_timeline_events[index] is DialogicTextEvent:
-		if len(dialogic.current_timeline_events)-1 != index:
-			if dialogic.current_timeline_events[index+1] is DialogicChoiceEvent:
-				return true
-	return false
+	
 
 func get_current_choice_indexes() -> Array:
 	var choices := []
@@ -133,3 +130,15 @@ func get_current_choice_indexes() -> Array:
 		if dialogic.current_timeline_events[evt_idx] is DialogicEndBranchEvent:
 			ignore -= 1
 	return choices
+
+####################################################################################################
+##					HELPERS
+####################################################################################################
+
+func is_question(index:int) -> bool:
+	if dialogic.current_timeline_events[index] is DialogicTextEvent:
+		if len(dialogic.current_timeline_events)-1 != index:
+			if dialogic.current_timeline_events[index+1] is DialogicChoiceEvent:
+				return true
+	return false
+

addons/dialogic/Events/Jump/event_jump.gd

@@ -39,6 +39,7 @@ func _execute() -> void:
 	if return_after:
 		dialogic.Jump.push_to_jump_stack()
 	if timeline and timeline != dialogic.current_timeline:
+		dialogic.Jump.switched_timeline.emit({'previous_timeline':dialogic.current_timeline, 'timeline':timeline, 'label':label_name})
 		dialogic.start_timeline(timeline, label_name)
 	else:
 		if label_name:

addons/dialogic/Events/Jump/subsystem_jump.gd

@@ -2,6 +2,9 @@ extends DialogicSubsystem
 
 ## Subsystem that holds methods for jumping to specific labels, or return to the previous jump.
 
+signal switched_timeline(info:Dictionary)
+signal jumped_to_label(info:Dictionary)
+signal returned_from_jump(info:Dictionary)
 
 ####################################################################################################
 ##					STATE
@@ -34,17 +37,20 @@ func jump_to_label(label:String) -> void:
 		if event is DialogicLabelEvent and event.name == label:
 			break
 	dialogic.current_event_idx = idx
+	jumped_to_label.emit({'timeline':dialogic.current_timeline, 'label':label})
 
 
 func push_to_jump_stack() -> void:
 	dialogic.current_state_info['jump_stack'].push_back({'timeline':dialogic.current_timeline, 'index':dialogic.current_event_idx})
 
 
-func resume_from_latst_jump() -> void:
+func resume_from_last_jump() -> void:
+	var sub_timeline : DialogicTimeline = dialogic.current_timeline
 	dialogic.start_timeline(
 		dialogic.current_state_info['jump_stack'][-1].timeline, 
 		dialogic.current_state_info['jump_stack'][-1].index+1)
 	dialogic.current_state_info['jump_stack'].pop_back()
+	returned_from_jump.emit({'sub_timeline':sub_timeline, 'label':dialogic.current_timeline.get_event(dialogic.current_event_idx-1).name})
 
 
 func is_jump_stack_empty():

addons/dialogic/Events/Style/subsystem_styles.gd

@@ -2,6 +2,7 @@ extends DialogicSubsystem
 
 ## Subsystem that manages showing and hiding style nodes.
 
+signal style_changed(info:Dictionary)
 
 ####################################################################################################
 ##					STATE
@@ -36,3 +37,4 @@ func change_style(style_name:String) -> void:
 		for style_node in get_tree().get_nodes_in_group('dialogic_styles'):
 			if style_node.style_name == last_style:
 				style_node.show()
+		style_changed.emit({'style_name':style_name})

addons/dialogic/Events/Text/default_input_handler.gd

@@ -29,7 +29,7 @@ func _ready() -> void:
 	autoadvance_timer.timeout.connect(_on_autoadvance_timer_timeout)
 
 
-func _on_text_finished() -> void:
+func _on_text_finished(info:Dictionary) -> void:
 	if Dialogic.Text.should_autoadvance():
 		autoadvance_timer.start(Dialogic.Text.get_autoadvance_time())