Add support for waiting for input (#955)

Author: nathanhoad

addons/dialogue_manager/DialogueManager.cs

@@ -432,12 +432,6 @@ public string? Time
             get => time;
         }
 
-        private Dictionary pauses = new Dictionary();
-        public Dictionary Pauses
-        {
-            get => pauses;
-        }
-
         private Dictionary speeds = new Dictionary();
         public Dictionary Speeds
         {
@@ -476,7 +470,6 @@ public DialogueLine(RefCounted data)
             character = (string)data.Get("character");
             text = (string)data.Get("text");
             translation_key = (string)data.Get("translation_key");
-            pauses = (Dictionary)data.Get("pauses");
             speeds = (Dictionary)data.Get("speeds");
             inline_mutations = (Array<Godot.Collections.Array>)data.Get("inline_mutations");
             time = (string)data.Get("time");

addons/dialogue_manager/compiler/compiler.gd

@@ -44,6 +44,12 @@ static func extract_translatable_string(text: String) -> String:
 	return line.text
 
 
+## Extract a mutation from a string.
+static func extract_mutation(text: String) -> Dictionary:
+	var compilation: DMCompilation = DMCompilation.new()
+	return compilation.extract_mutation(text)
+
+
 ## Get the known titles in a dialogue script.
 static func get_titles_in_text(text: String, path: String) -> Dictionary:
 	var compilation: DMCompilation = DMCompilation.new()

addons/dialogue_manager/compiler/resolved_line_data.gd

@@ -3,8 +3,6 @@ class_name DMResolvedLineData extends RefCounted
 
 ## The line's text
 var text: String = ""
-## A map of pauses against where they are found in the text.
-var pauses: Dictionary = {}
 ## A map of speed changes against where they are found in the text.
 var speeds: Dictionary = {}
 ## A list of any mutations to run and where they are found in the text.
@@ -15,7 +13,6 @@ var time: String = ""
 
 func _init(line: String) -> void:
 	text = line
-	pauses = {}
 	speeds = {}
 	mutations = []
 	time = ""
@@ -64,8 +61,7 @@ func _init(line: String) -> void:
 		var raw_args = bbcode.raw_args
 		var args = {}
 		if code in ["$>", "$>>", "do", "do!", "set"]:
-			var compilation: DMCompilation = DMCompilation.new()
-			args["value"] = compilation.extract_mutation("%s %s" % [code, raw_args])
+			args["value"] = DMCompiler.extract_mutation("%s %s" % [code, raw_args])
 		else:
 			# Could be something like:
 			# 	"=1.0"
@@ -79,10 +75,8 @@ func _init(line: String) -> void:
 
 		match code:
 			"wait":
-				if pauses.has(index):
-					pauses[index] += args.get("value").to_float()
-				else:
-					pauses[index] = args.get("value").to_float()
+				var wait: Dictionary = DMCompiler.extract_mutation("do wait(%s)" % [args.get("value", "null")])
+				mutations.append([index, wait])
 			"speed":
 				speeds[index] = args.get("value").to_float()
 			"/speed":

addons/dialogue_manager/components/code_edit_syntax_highlighter.gd

@@ -130,7 +130,7 @@ func _get_line_syntax_highlighting(line: int) -> Dictionary:
 						if tag.begins_with("if"):
 							colors[index + bbcode.start + 1] = { color = theme.conditions_color }
 						else:
-							colors[index + bbcode.start + 1] = { color = theme.mutations_color }
+							colors[index + bbcode.start + 1] = { color = theme.mutations_line_color }
 						var expression: Array = expression_parser.tokenise(code, DMConstants.TYPE_MUTATION, bbcode.start + bbcode.code.length())
 						if expression.size() == 0 or expression[0].type == DMConstants.TYPE_ERROR:
 							colors[index + bbcode.start + tag.length() + 1] = { color = theme.critical_color }

addons/dialogue_manager/dialogue_label.gd

@@ -9,9 +9,6 @@ class_name DialogueLabel extends RichTextLabel
 ## Emitted for each letter typed out.
 signal spoke(letter: String, letter_index: int, speed: float)
 
-## Emitted when typing paused for a `[wait]`
-signal paused_typing(duration: float)
-
 ## Emitted when the player skips the typing of dialogue.
 signal skipped_typing()
 
@@ -21,6 +18,9 @@ signal started_typing()
 ## Emitted when typing finishes.
 signal finished_typing()
 
+## [Deprecated] No longer emitted.
+signal paused_typing(duration: float)
+
 
 ## The action to press to skip typing.
 @export var skip_action: StringName = &"ui_cancel"
@@ -57,12 +57,13 @@ var dialogue_line:
 ## Whether the label is currently typing itself out.
 var is_typing: bool = false:
 	set(value):
-		var is_finished: bool = is_typing != value and value == false
-		is_typing = value
+		var is_finished: bool = _is_typing != value and value == false and visible_characters == get_total_character_count()
+		_is_typing = value
 		if is_finished:
 			finished_typing.emit()
 	get:
-		return is_typing
+		return _is_typing and not _is_awaiting_mutation
+var _is_typing: bool = false
 
 var _last_wait_index: int = -1
 var _last_mutation_index: int = -1
@@ -71,7 +72,7 @@ var _is_awaiting_mutation: bool = false
 
 
 func _process(delta: float) -> void:
-	if self.is_typing:
+	if _is_typing:
 		# Type out text
 		if visible_ratio < 1:
 			# See if we are waiting
@@ -83,7 +84,7 @@ func _process(delta: float) -> void:
 		else:
 			# Make sure any mutations at the end of the line get run
 			_mutate_inline_mutations(get_total_character_count())
-			self.is_typing = false
+			is_typing = false
 
 
 ## Sets the label's text from the current dialogue line. Override if you want
@@ -102,25 +103,25 @@ func type_out() -> void:
 	_last_mutation_index = -1
 	_already_mutated_indices.clear()
 
-	self.is_typing = true
+	is_typing = true
 	started_typing.emit()
 
 	# Allow typing listeners a chance to connect
 	await get_tree().process_frame
 
 	if get_total_character_count() == 0:
-		self.is_typing = false
+		is_typing = false
 	elif seconds_per_step == 0:
 		_mutate_remaining_mutations()
 		visible_characters = get_total_character_count()
-		self.is_typing = false
+		is_typing = false
 
 
 ## Stop typing out the text and jump right to the end
 func skip_typing() -> void:
 	_mutate_remaining_mutations()
 	visible_characters = get_total_character_count()
-	self.is_typing = false
+	is_typing = false
 	skipped_typing.emit()
 
 
@@ -136,17 +137,11 @@ func _type_next(delta: float, seconds_needed: float) -> void:
 		_mutate_inline_mutations(visible_characters)
 		if _is_awaiting_mutation: return
 
-	var additional_waiting_seconds: float = _get_pause(visible_characters)
-
 	# Pause on characters like "."
-	if _should_auto_pause():
-		additional_waiting_seconds += seconds_per_pause_step
-
-	# Pause at literal [wait] directives
-	if _last_wait_index != visible_characters and additional_waiting_seconds > 0:
+	var waiting_seconds: float = seconds_per_pause_step if _should_auto_pause() else 0
+	if _last_wait_index != visible_characters and waiting_seconds > 0:
 		_last_wait_index = visible_characters
-		_waiting_seconds += additional_waiting_seconds
-		paused_typing.emit(_get_pause(visible_characters))
+		_waiting_seconds += waiting_seconds
 	else:
 		visible_characters += 1
 		if visible_characters <= get_total_character_count():
@@ -159,11 +154,6 @@ func _type_next(delta: float, seconds_needed: float) -> void:
 			_type_next(delta, seconds_needed)
 
 
-# Get the pause for the current typing position if there is one
-func _get_pause(at_index: int) -> float:
-	return dialogue_line.pauses.get(at_index, 0)
-
-
 # Get the speed for the current typing position
 func _get_speed(at_index: int) -> float:
 	var speed: float = 1

addons/dialogue_manager/dialogue_line.gd

@@ -26,9 +26,6 @@ var text_replacements: Array[Dictionary] = []
 ## The key to use for translating this line.
 var translation_key: String = ""
 
-## A map for when and for how long to pause while typing out the dialogue text.
-var pauses: Dictionary = {}
-
 ## A map for speed changes when typing out the dialogue text.
 var speeds: Dictionary = {}
 
@@ -71,7 +68,6 @@ func _init(data: Dictionary = {}) -> void:
 				text = data.text
 				text_replacements = data.get("text_replacements", [] as Array[Dictionary])
 				translation_key = data.get("translation_key", data.text)
-				pauses = data.get("pauses", {})
 				speeds = data.get("speeds", {})
 				inline_mutations = data.get("inline_mutations", [] as Array[Array])
 				time = data.get("time", "")

addons/dialogue_manager/dialogue_manager.gd

@@ -37,7 +37,7 @@ signal bridge_get_line_completed(line: DialogueLine)
 ## Used internally
 signal bridge_dialogue_started(resource: DialogueResource)
 
-## Used inernally
+## Used internally
 signal bridge_mutated()
 
 
@@ -363,7 +363,7 @@ func get_resolved_line_data(data: Dictionary, extra_game_states: Array = []) ->
 			resolved_text = resolved_text.substr(0, r.start) + r.body + resolved_text.substr(r.end, 9999)
 			# Move any other markers now that the text has changed
 			var offset: int = r.end - r.start - r.body.length()
-			for key in [&"pauses", &"speeds", &"time"]:
+			for key in [&"speeds", &"time"]:
 				if markers.get(key) == null: continue
 				var marker = markers.get(key)
 				var next_marker: Dictionary = {}
@@ -610,7 +610,6 @@ func create_dialogue_line(data: Dictionary, extra_game_states: Array) -> Dialogu
 				text = resolved_data.text,
 				text_replacements = data.get(&"text_replacements", [] as Array[Dictionary]),
 				translation_key = data.get(&"translation_key", data.text),
-				pauses = resolved_data.pauses,
 				speeds = resolved_data.speeds,
 				inline_mutations = resolved_data.mutations,
 				time = resolved_data.time,
@@ -746,7 +745,11 @@ func _mutate(mutation: Dictionary, extra_game_states: Array, is_inline_mutation:
 		match expression[0].function:
 			&"wait", &"Wait":
 				mutated.emit(mutation.merged({ is_inline = is_inline_mutation }))
-				await Engine.get_main_loop().create_timer(float(args[0])).timeout
+				if [TYPE_FLOAT, TYPE_INT].has(typeof(args[0])):
+					await Engine.get_main_loop().create_timer(float(args[0])).timeout
+				else:
+					var actions: PackedStringArray = PackedStringArray(args[0] if typeof(args[0]) == TYPE_ARRAY else [args[0]])
+					await _wait_for(actions)
 				return
 
 			&"debug", &"Debug":
@@ -768,6 +771,14 @@ func _mutate(mutation: Dictionary, extra_game_states: Array, is_inline_mutation:
 	await Engine.get_main_loop().process_frame
 
 
+# Wait for a given action
+func _wait_for(actions: PackedStringArray) -> void:
+	var waiter = DMWaiter.new(actions)
+	add_child(waiter)
+	await waiter.waited
+	waiter.queue_free()
+
+
 # Check if a mutation contains an assignment token.
 func _mutation_contains_assignment(mutation: Array) -> bool:
 	for token in mutation:

addons/dialogue_manager/example_balloon/example_balloon.gd

@@ -51,6 +51,9 @@ var mutation_cooldown: Timer = Timer.new()
 ## The menu of responses
 @onready var responses_menu: DialogueResponsesMenu = %ResponsesMenu
 
+## Indicator to show that player can progress dialogue.
+@onready var progress: Polygon2D = %Progress
+
 
 func _ready() -> void:
 	balloon.hide()
@@ -64,6 +67,10 @@ func _ready() -> void:
 	add_child(mutation_cooldown)
 
 
+func _process(delta: float) -> void:
+	progress.visible = not dialogue_label.is_typing and dialogue_line.responses.size() == 0
+
+
 func _unhandled_input(_event: InputEvent) -> void:
 	# Only the balloon is allowed to handle input while it's showing
 	get_viewport().set_input_as_handled()
@@ -91,6 +98,7 @@ func start(dialogue_resource: DialogueResource, title: String, extra_game_states
 func apply_dialogue_line() -> void:
 	mutation_cooldown.stop()
 
+	progress.hide()
 	is_waiting_for_input = false
 	balloon.focus_mode = Control.FOCUS_ALL
 	balloon.grab_focus()
@@ -142,9 +150,10 @@ func _on_mutation_cooldown_timeout() -> void:
 
 
 func _on_mutated(_mutation: Dictionary) -> void:
-	is_waiting_for_input = false
-	will_hide_balloon = true
-	mutation_cooldown.start(0.1)
+	if not _mutation.is_inline:
+		is_waiting_for_input = false
+		will_hide_balloon = true
+		mutation_cooldown.start(0.1)
 
 
 func _on_balloon_gui_input(event: InputEvent) -> void: