escoria setup and old branch archives

6 files changed, 483 insertions, 0 deletions

diff --git a/addons/escoria-core/game/scenes/dialogs/esc_dialog_manager.gd b/addons/escoria-core/game/scenes/dialogs/esc_dialog_manager.gd
new file mode 100644
index 0000000..0a00456
--- /dev/null
+++ b/addons/escoria-core/game/scenes/dialogs/esc_dialog_manager.gd
@@ -0,0 +1,164 @@
+## A base class for dialog plugins to work with Escoria
+## @MANAGER
+extends Control
+class_name ESCDialogManager
+
+## Emitted when the say function has completed showing the text[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+signal say_finished
+
+## Emitted when text has just become fully visible[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+signal say_visible
+
+## Emitted when the player has chosen an option[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |option|`Variant`|Dialog option chosen by the player.|yes|[br]
+## [br]
+signal option_chosen(option)
+
+## Checks whether a specific type is supported by the dialog plugin.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |type|`String`|Required type.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns whether the type is supported or not. (`bool`)
+func has_type(type: String) -> bool:
+	return false
+
+## Checks whether a specific chooser type is supported by the dialog plugin.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |type|`String`|Required chooser type.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns whether the type is supported or not. (`bool`)
+func has_chooser_type(type: String) -> bool:
+	return false
+
+## Outputs a text said by the item specified by the global id and emits `say_finished` after finishing displaying the text.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |dialog_player|`Node`|Node of the dialog player in the UI.|yes|[br]
+## |global_id|`String`|Global id of the item that is speaking.|yes|[br]
+## |text|`String`|Text to say, optional prefixed by a translation key separated by a ":".|yes|[br]
+## |type|`String`|Type of dialog box to use.|yes|[br]
+## |key|`String`|Translation key.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func say(dialog_player: Node, global_id: String, text: String, type: String, key: String):
+	pass
+
+## Instructs the dialog manager to preserve the next dialog box used by a `say` command until a call to `disable_preserve_dialog_box` is made. This method should be idempotent, i.e. if called after the first time and prior to `disable_preserve_dialog_box` being called, the result should be the same.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func enable_preserve_dialog_box() -> void:
+	pass
+
+## Instructs the dialog manager to no longer preserve the currently-preserved dialog box or to not preserve the next dialog box used by a `say` command (this is the default state). This method should be idempotent, i.e. if called after the first time and prior to `enable_preserve_dialog_box` being called, the result should be the same.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func disable_preserve_dialog_box() -> void:
+	pass
+
+## Presents an option chooser to the player and sends the signal `option_chosen` with the chosen dialog option.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |dialog_player|`Node`|Node of the dialog player in the UI.|yes|[br]
+## |dialog|`ESCDialog`|Information about the dialog to display.|yes|[br]
+## |type|`String`|The dialog chooser type to use.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func choose(dialog_player: Node, dialog: ESCDialog, type: String):
+	pass
+
+## Triggers running the dialogue faster.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func speedup():
+	pass
+
+## Triggers an instant finish of the current dialog.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func finish():
+	pass
+
+## The say command has been interrupted, cancel the dialog display.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func interrupt():
+	pass
+
+## To be called if voice audio has finished.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func voice_audio_finished():
+	pass
diff --git a/addons/escoria-core/game/scenes/dialogs/esc_dialog_manager.gd.uid b/addons/escoria-core/game/scenes/dialogs/esc_dialog_manager.gd.uid
new file mode 100644
index 0000000..25eac9e
--- /dev/null
+++ b/addons/escoria-core/game/scenes/dialogs/esc_dialog_manager.gd.uid
@@ -0,0 +1 @@
+uid://xalkeght0hmj
diff --git a/addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd b/addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd
new file mode 100644
index 0000000..44e2a3f
--- /dev/null
+++ b/addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd
@@ -0,0 +1,60 @@
+## Base class for all dialog options implementations
+extends Control
+class_name ESCDialogOptionsChooser
+
+## Emitted when an option is chosen.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |option|`Variant`|The dialog option that was chosen.|yes|[br]
+## [br]
+signal option_chosen(option)
+
+## The dialog to show
+var dialog: ESCDialog
+
+## Sets the dialog used for the chooser.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |new_dialog|`ESCDialog`|Dialog to set.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func set_dialog(new_dialog: ESCDialog) -> void:
+	self.dialog = new_dialog
+
+## Shows the dialog chooser UI.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func show_chooser() -> void:
+	escoria.logger.error(
+		self,
+		"Dialog chooser does not implement the show method."
+	)
+
+## Hides the dialog chooser UI.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func hide_chooser() -> void:
+	escoria.logger.error(
+		self,
+		"Dialog chooser does not implement the hide method."
+	)
diff --git a/addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd.uid b/addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd.uid
new file mode 100644
index 0000000..9dbe944
--- /dev/null
+++ b/addons/escoria-core/game/scenes/dialogs/esc_dialog_options_chooser.gd.uid
@@ -0,0 +1 @@
+uid://c8rd32hdq72l2
diff --git a/addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd b/addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd
new file mode 100644
index 0000000..70e61e2
--- /dev/null
+++ b/addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd
@@ -0,0 +1,256 @@
+## Escoria dialog player
+extends Control
+class_name ESCDialogPlayer
+
+## Emitted when an answer is chosen.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |option|`Variant`|The dialog option that was chosen.|yes|[br]
+## [br]
+signal option_chosen(option)
+
+## Emitted when a say command finished.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+signal say_finished
+
+
+## Used when specifying dialog types in various methods.
+const DIALOG_TYPE_SAY = "say"
+
+## Used when specifying dialog types in various methods.
+const DIALOG_TYPE_CHOOSE = "choose"
+
+## Reference to the currently playing "say" dialog manager.
+var _say_dialog_manager: ESCDialogManager = null
+
+## Reference to the currently playing "choose" dialog manager.
+var _choose_dialog_manager: ESCDialogManager = null
+
+## Whether to use the "dialog box preservation" feature.
+var _block_say_enabled: bool = false
+
+## Registers the dialog player and loads the dialog resources.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func _ready():
+	if Engine.is_editor_hint():
+		return
+
+	escoria.dialog_player = self
+
+## Instructs the dialog manager to preserve the next dialog box used by a `say` command until a call to `disable_preserve_dialog_box` is made. This method should be idempotent, i.e. if called after the first time and prior to `disable_preserve_dialog_box` being called, the result should be the same.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func enable_preserve_dialog_box() -> void:
+	_block_say_enabled = true
+
+## Instructs the dialog manager to no longer preserve the currently-preserved dialog box or to not preserve the next dialog box used by a `say` command (this is the default state). This method should be idempotent, i.e. if called after the first time and prior to `enable_preserve_dialog_box` being called, the result should be the same.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func disable_preserve_dialog_box() -> void:
+	_block_say_enabled = false
+	_say_dialog_manager.disable_preserve_dialog_box()
+
+## Makes a character say some text.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |character|`String`|Character that is talking.|yes|[br]
+## |type|`String`|UI to use for the dialog.|yes|[br]
+## |text|`String`|Text to say.|yes|[br]
+## |key|`String`|Translation key.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func say(character: String, type: String, text: String, key: String) -> void:
+	if type == "":
+		type = ESCProjectSettingsManager.get_setting(
+			ESCProjectSettingsManager.DEFAULT_DIALOG_TYPE
+		)
+
+	# We only need to remove the dialog manager from the scene tree if the dialog manager type
+	# has changed since the last use of this method.
+	_update_dialog_manager(DIALOG_TYPE_SAY, _say_dialog_manager, type)
+
+	if _block_say_enabled:
+		_say_dialog_manager.enable_preserve_dialog_box()
+
+	_say_dialog_manager.say(self, character, text, type, key)
+
+
+## Displays a list of choices.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |dialog|`ESCDialog`|The dialog to start.|yes|[br]
+## |type|`String`|The dialog chooser type to use (default: "simple").|no|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func start_dialog_choices(dialog: ESCDialog, type: String = "simple"):
+	# We only need to remove the dialog manager from the scene tree if the dialog manager type
+	# has changed since the last use of this method.
+	_update_dialog_manager(DIALOG_TYPE_CHOOSE, _choose_dialog_manager, type)
+
+	_choose_dialog_manager.choose(self, dialog, type)
+
+
+## Interrupts the currently running dialog.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## None.
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func interrupt() -> void:
+	if is_instance_valid(_say_dialog_manager):
+		_say_dialog_manager.interrupt()
+
+
+## Loads the first dialog manager that supports the specified "say" type; otherwise, the engine throws an error and stops.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |type|`String`|The type the dialog manager should support, e.g. "floating".|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func _determine_say_dialog_manager(type: String) -> void:
+	var dialog_manager: ESCDialogManager = null
+
+	for _manager_class in ESCProjectSettingsManager.get_setting(
+		ESCProjectSettingsManager.DIALOG_MANAGERS
+	):
+		if ResourceLoader.exists(_manager_class):
+			var _manager: ESCDialogManager = load(_manager_class).new()
+			if _manager.has_type(type):
+				dialog_manager = _manager
+			else:
+				dialog_manager = null
+
+	if not is_instance_valid(dialog_manager):
+		escoria.logger.error(
+			self,
+			"No dialog manager called '%s' configured." % type
+		)
+
+	_say_dialog_manager = dialog_manager
+
+
+## Loads the first dialog manager that supports the specified "choose" type; otherwise, the engine throws an error and stops.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |type|`String`|The type the dialog manager should support, e.g. "simple".|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func _determine_choose_dialog_manager(type: String) -> void:
+	var dialog_manager: ESCDialogManager = null
+
+	for _manager_class in ESCProjectSettingsManager.get_setting(
+		ESCProjectSettingsManager.DIALOG_MANAGERS
+	):
+		if ResourceLoader.exists(_manager_class):
+			var _manager: ESCDialogManager = load(_manager_class).new()
+			if _manager.has_chooser_type(type):
+				dialog_manager = _manager
+			else:
+				dialog_manager = null
+
+	if not is_instance_valid(dialog_manager):
+		escoria.logger.error(
+			self,
+			"No dialog manager called '%s' configured." % type
+		)
+
+	_choose_dialog_manager = dialog_manager
+
+
+## If necessary, updates the dialog manager for the specified dialog type.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |dialog_type|`String`|The type of dialog that will be managed, e.g. "say" or "choose".|yes|[br]
+## |current_dialog_manager|`ESCDialogManager`|The dialog manager currently being used (if any) for the specified dialog type.|yes|[br]
+## |dialog_manager_type|`String`|Type name of the dialog manager implementation to instantiate.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns nothing.
+func _update_dialog_manager(dialog_type: String, current_dialog_manager: ESCDialogManager, \
+	dialog_manager_type: String) -> void:
+
+	if is_instance_valid(current_dialog_manager):
+		if not current_dialog_manager.has_type(dialog_manager_type):
+			if is_ancestor_of(current_dialog_manager):
+				remove_child(current_dialog_manager)
+
+			add_child(_determine_dialog_manager(dialog_type, dialog_manager_type))
+	else:
+		add_child(_determine_dialog_manager(dialog_type, dialog_manager_type))
+
+
+## Sets the requested dialog manager type for the specified dialog function.[br]
+## [br]
+## #### Parameters[br]
+## [br]
+## | Name | Type | Description | Required? |[br]
+## |:-----|:-----|:------------|:----------|[br]
+## |dialog_type|`String`|The type of dialog that will be managed, e.g. "say" or "choose".|yes|[br]
+## |dialog_manager_type|`String`|The dialog manager type specific to the dialog manager being requested.|yes|[br]
+## [br]
+## #### Returns[br]
+## [br]
+## Returns the newly-resolved dialog manager. (`ESCDialogManager`)
+func _determine_dialog_manager(dialog_type: String, dialog_manager_type: String) -> ESCDialogManager:
+	if dialog_type == DIALOG_TYPE_SAY:
+		_determine_say_dialog_manager(dialog_manager_type)
+		return _say_dialog_manager
+	elif dialog_type == DIALOG_TYPE_CHOOSE:
+		_determine_choose_dialog_manager(dialog_manager_type)
+		return _choose_dialog_manager
+
+	# This line will never be hit as a failure above will result in an Escoria error
+	return null
diff --git a/addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd.uid b/addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd.uid
new file mode 100644
index 0000000..6a97923
--- /dev/null
+++ b/addons/escoria-core/game/scenes/dialogs/esc_dialog_player.gd.uid
@@ -0,0 +1 @@
+uid://dfl7khtlretr7