Merge pull request #13 from bisterix-studio/jump-node

Add Jump Nodes and future proof some interfaces

Author: jonnydgreen

.vscode/settings.json

@@ -27,6 +27,7 @@
     "paletteuse",
     "printerr",
     "printwarn",
+    "Rect",
     "stylebox",
     "titlebar",
     "Treeware"

README.md

@@ -11,7 +11,8 @@ Write your Dialogue Sequences by defining the graph for your Dialogue Sequence
 which are backed by a well-defined Dialogue AST for easy management and
 integration within your game.
 
-You can install it via the Asset Library or
+You can install it via the
+[Asset Library](https://godotengine.org/asset-library/asset/4132) or
 [downloading a copy](https://github.com/bisterix-studio/parley/archive/refs/heads/main.zip)
 from GitHub.
 
@@ -22,13 +23,12 @@ from GitHub.
 
 ## Table of contents
 
-- [Table of contents](#table-of-contents)
 - [Features](#features)
+- [Upcoming Features](#upcoming-features)
 - [Installation](#installation)
 - [Documentation](#documentation)
 - [Support](#support)
 - [Known Issues and Troubleshooting](#known-issues-and-troubleshooting)
-  - [Parts of Godot are unresponsive in MacOS after close a test dialogue scene via the close button](#parts-of-godot-are-unresponsive-in-macos-after-close-a-test-dialogue-scene-via-the-close-button)
 - [Licence](#licence)
 - [Contributions](#contributions)
 
@@ -37,24 +37,25 @@ Installation Features Examples Support Useful links Licence Contributions
 ## Features
 
 - An easy-to-use and well-defined Graph Editor
-- A wide variety of nodes for maximum flexibility and creativity:
+- A wide variety of Nodes for maximum flexibility and creativity:
   - [Dialogue](https://parley.bisterixstudio.com/docs/nodes/dialogue-node)
   - [Dialogue Option](https://parley.bisterixstudio.com/docs/nodes/dialogue-option-node)
   - [Condition](https://parley.bisterixstudio.com/docs/nodes/condition-node)
   - [Match](https://parley.bisterixstudio.com/docs/nodes/match-node)
   - [Action](https://parley.bisterixstudio.com/docs/nodes/action-node)
+  - [Jump](https://parley.bisterixstudio.com/docs/nodes/jump-node)
   - [Group](https://parley.bisterixstudio.com/docs/nodes/group-node)
   - [Start](https://parley.bisterixstudio.com/docs/nodes/start-node)
   - [End](https://parley.bisterixstudio.com/docs/nodes/end-node)
-- Creation of connections between nodes to easily see the flow of your dialogue
+- Creation of connections between Nodes to easily see the flow of your dialogue
   sequence
 - Easy testing of your dialogue at any stage in the sequence
 - Well-defined Dialogue AST for easy review and management of Dialogue Sequences
 - Character store for management of characters in Dialogue and Dialogue Options
 - Action store for management of actions for use with Action nodes
 - Fact store for management of facts for use with Condition and Match nodes
 - An out of the box dialogue balloon to get started straight away
-- Easy management of your Dialogue Sequences, including node filtering
+- Easy management of your Dialogue Sequences, including Node filtering
 - Export your Dialogue passages to CSV
 
 ## Upcoming Features
@@ -64,7 +65,6 @@ ideas, please don't hesitate to
 [get-in-touch](https://github.com/bisterix-studio/parley/issues).
 
 - Translation support
-- Jump Nodes
 - Dialogue text expressions
 
 ## Installation

actions/advance_time_action.gd

@@ -2,6 +2,6 @@
 
 extends ParleyActionInterface
 
-func execute(_ctx: Dictionary, values: Array) -> int:
+func run(_ctx: ParleyContext, values: Array) -> int:
 	print("Advancing time by %s" % [values[0]])
 	return OK

actions/found_clue.gd

@@ -2,6 +2,6 @@
 
 extends ParleyActionInterface
 
-func execute(_ctx: Dictionary, values: Array) -> int:
+func run(_ctx: ParleyContext, values: Array) -> int:
 	print("Found clue: %s" % [values[0]])
 	return OK

addons/parley/README.md

@@ -11,7 +11,8 @@ Write your Dialogue Sequences by defining the graph for your Dialogue Sequence
 which are backed by a well-defined Dialogue AST for easy management and
 integration within your game.
 
-You can install it via the Asset Library or
+You can install it via the
+[Asset Library](https://godotengine.org/asset-library/asset/4132) or
 [downloading a copy](https://github.com/bisterix-studio/parley/archive/refs/heads/main.zip)
 from GitHub.
 
@@ -22,13 +23,12 @@ from GitHub.
 
 ## Table of contents
 
-- [Table of contents](#table-of-contents)
 - [Features](#features)
+- [Upcoming Features](#upcoming-features)
 - [Installation](#installation)
 - [Documentation](#documentation)
 - [Support](#support)
 - [Known Issues and Troubleshooting](#known-issues-and-troubleshooting)
-  - [Parts of Godot are unresponsive in MacOS after close a test dialogue scene via the close button](#parts-of-godot-are-unresponsive-in-macos-after-close-a-test-dialogue-scene-via-the-close-button)
 - [Licence](#licence)
 - [Contributions](#contributions)
 
@@ -37,24 +37,25 @@ Installation Features Examples Support Useful links Licence Contributions
 ## Features
 
 - An easy-to-use and well-defined Graph Editor
-- A wide variety of nodes for maximum flexibility and creativity:
+- A wide variety of Nodes for maximum flexibility and creativity:
   - [Dialogue](https://parley.bisterixstudio.com/docs/nodes/dialogue-node)
   - [Dialogue Option](https://parley.bisterixstudio.com/docs/nodes/dialogue-option-node)
   - [Condition](https://parley.bisterixstudio.com/docs/nodes/condition-node)
   - [Match](https://parley.bisterixstudio.com/docs/nodes/match-node)
   - [Action](https://parley.bisterixstudio.com/docs/nodes/action-node)
+  - [Jump](https://parley.bisterixstudio.com/docs/nodes/jump-node)
   - [Group](https://parley.bisterixstudio.com/docs/nodes/group-node)
   - [Start](https://parley.bisterixstudio.com/docs/nodes/start-node)
   - [End](https://parley.bisterixstudio.com/docs/nodes/end-node)
-- Creation of connections between nodes to easily see the flow of your dialogue
+- Creation of connections between Nodes to easily see the flow of your dialogue
   sequence
 - Easy testing of your dialogue at any stage in the sequence
 - Well-defined Dialogue AST for easy review and management of Dialogue Sequences
 - Character store for management of characters in Dialogue and Dialogue Options
 - Action store for management of actions for use with Action nodes
 - Fact store for management of facts for use with Condition and Match nodes
 - An out of the box dialogue balloon to get started straight away
-- Easy management of your Dialogue Sequences, including node filtering
+- Easy management of your Dialogue Sequences, including Node filtering
 - Export your Dialogue passages to CSV
 
 ## Upcoming Features
@@ -64,7 +65,6 @@ ideas, please don't hesitate to
 [get-in-touch](https://github.com/bisterix-studio/parley/issues).
 
 - Translation support
-- Jump Nodes
 - Dialogue text expressions
 
 ## Installation

addons/parley/assets/Jump.svg

@@ -0,0 +1,38 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://cc4snig105irh"
+path="res://.godot/imported/Jump.svg-4c8ca648055ae62dca35610bd35b9941.ctex"
+metadata={
+"has_editor_variant": true,
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://addons/parley/assets/Jump.svg"
+dest_files=["res://.godot/imported/Jump.svg-4c8ca648055ae62dca35610bd35b9941.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1
+svg/scale=1.0
+editor/scale_with_editor_scale=true
+editor/convert_colors_with_editor_theme=true

addons/parley/assets/Jump.svg.import

@@ -41,7 +41,7 @@ func select_from_slot(from_slot: int, _colour: Color = Color.CHARTREUSE) -> void
 		1:
 			slot = 2
 		_:
-			ParleyUtils.log.info("Unknown from slot: %s" % [from_slot])
+			print_rich(ParleyUtils.log.info_msg("Unknown from slot: %s" % [from_slot]))
 			return
 	set_slot_color_right(slot, Color.CORNFLOWER_BLUE)
 
@@ -58,7 +58,7 @@ func deselect_from_slot(from_slot: int, colour: Color = null_colour) -> void:
 			slot = 2
 			slot_colour = colour if colour != null_colour else Color.FIREBRICK
 		_:
-			ParleyUtils.log.info("Unknown from slot: %s" % [from_slot])
+			print_rich(ParleyUtils.log.info_msg("Unknown from slot: %s" % [from_slot]))
 			return
 	set_slot_color_right(slot, slot_colour)
 
@@ -72,6 +72,6 @@ func get_from_slot_colour(from_slot: int) -> Color:
 		1:
 			slot = 2
 		_:
-			ParleyUtils.log.info("Unknown from slot: %s" % [from_slot])
+			print_rich(ParleyUtils.log.info_msg("Unknown from slot: %s" % [from_slot]))
 			return Color.CHARTREUSE
 	return get_slot_color_right(slot)

addons/parley/components/condition/condition_node.gd

@@ -146,7 +146,7 @@ func _on_condition_removed(condition_id: String) -> void:
 	var index: int = int(condition_id)
 	var new_conditions: Array = conditions.duplicate(true)
 	if index < 0 or index >= new_conditions.size():
-		ParleyUtils.log.error("Unable to remove Condition from Condition Node (id:%s, index:%i)" % [id, index])
+		push_error(ParleyUtils.log.error_msg("Unable to remove Condition from Condition Node (id:%s, index:%i)" % [id, index]))
 		return
 	new_conditions.remove_at(int(condition_id))
 	conditions = new_conditions

addons/parley/components/condition/condition_node_editor.gd

@@ -16,17 +16,57 @@ const next_dialogue_button: PackedScene = preload('./next_dialogue_button.tscn')
 @onready var balloon_container: VBoxContainer = %BalloonContainer
 
 
-var ctx: Dictionary = {}
-var dialogue_ast: ParleyDialogueSequenceAst
+var ctx: ParleyContext = ParleyContext.new()
+var dialogue_sequence_ast: ParleyDialogueSequenceAst
 var dialogue_history: Array = []
-## Temporary game states
-var temporary_game_states: Array = []
 ## See if we are waiting for the player
 var is_waiting_for_input: bool = false
 var previous_node_ast: ParleyNodeAst = null
 var current_node_asts: Array[ParleyNodeAst]: set = _set_current_node_asts
 
 
+#region LIFECYCLE
+func _exit_tree() -> void:
+	# Ensure the ctx is fully cleaned up
+	if ctx and not ctx.is_queued_for_deletion():
+		ctx.free()
+#endregion
+
+
+#region PROCESSING
+## Start some dialogue
+func start(p_ctx: ParleyContext, p_dialogue_sequence_ast: ParleyDialogueSequenceAst, p_start_node: ParleyNodeAst = null) -> void:
+	balloon.show()
+	is_waiting_for_input = false
+	ctx = p_ctx
+	dialogue_sequence_ast = p_dialogue_sequence_ast
+	if p_start_node is ParleyDialogueNodeAst or p_start_node is ParleyDialogueOptionNodeAst:
+		current_node_asts = [p_start_node]
+	elif p_start_node:
+		var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast, p_start_node)
+		current_node_asts = run_result.node_asts
+		dialogue_sequence_ast = run_result.dialogue_sequence
+		run_result.free() # Needed to ensure that everything is correctly freed up at exit
+	else:
+		var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast)
+		current_node_asts = run_result.node_asts
+		dialogue_sequence_ast = run_result.dialogue_sequence
+		run_result.free() # Needed to ensure that everything is correctly freed up at exit
+
+
+## Process the next Nodes
+func next(current_node_ast: ParleyNodeAst) -> void:
+	# Probably want to emit at this point? Or maybe earlier
+	dialogue_history.append(current_node_ast)
+	previous_node_ast = current_node_ast
+	var run_result: ParleyRunResult = await ParleyDialogueSequenceAst.run(ctx, dialogue_sequence_ast, current_node_ast)
+	current_node_asts = run_result.node_asts
+	dialogue_sequence_ast = run_result.dialogue_sequence
+	run_result.free() # Needed to ensure that everything is correctly freed up at exit
+#endregion
+
+
+#region SETTERS
 func _set_current_node_asts(p_current_node_asts: Array[ParleyNodeAst]) -> void:
 	is_waiting_for_input = false
 	balloon.focus_mode = Control.FOCUS_ALL
@@ -46,7 +86,7 @@ func _set_current_node_asts(p_current_node_asts: Array[ParleyNodeAst]) -> void:
 	current_node_asts = p_current_node_asts
 	var current_children: Array[Node] = balloon_container.get_children()
 	var first_node: ParleyNodeAst = p_current_node_asts.front()
-	var next_children: Array[Node] = _build_next_children(current_children, first_node)
+	var next_children: Array[Node] = await _build_next_children(current_children, first_node)
 	if next_children.size() == 0:
 		return
 
@@ -59,16 +99,18 @@ func _set_current_node_asts(p_current_node_asts: Array[ParleyNodeAst]) -> void:
 		if not next_button.is_node_ready():
 			await next_button.ready
 		next_button.grab_focus()
+#endregion
 
 
+#region RENDERERS
 func _build_next_children(current_children: Array[Node], current_node_ast: ParleyNodeAst) -> Array[Node]:
 	var next_children: Array[Node] = []
 	if is_instance_of(current_node_ast, ParleyDialogueNodeAst) and not (current_node_ast as ParleyDialogueNodeAst).text.is_empty():
-		next_children.append_array(_build_next_dialogue_children(current_node_ast))
+		next_children.append_array(await _build_next_dialogue_children(current_node_ast))
 	elif current_node_asts.filter(func(_n: ParleyNodeAst) -> bool: return is_instance_of(current_node_ast, ParleyDialogueOptionNodeAst)).size() == current_node_asts.size():
 		next_children.append_array(_build_next_dialogue_option_children(current_children))
 	else:
-		ParleyUtils.log.error("Invalid dialogue balloon nodes. Stopping processing. Check whether the Dialogue and Dialogue Option Nodes are fully populated with data.")
+		push_error(ParleyUtils.log.error_msg("Invalid dialogue balloon nodes. Stopping processing. Check whether the Dialogue and Dialogue Option Nodes are fully populated with data."))
 		return []
 	return next_children
 
@@ -90,7 +132,7 @@ func _build_next_dialogue_children(current_node_ast: ParleyNodeAst) -> Array[Nod
 	next_dialogue_container.set_meta('ast', current_node_ast)
 	next_children.append(next_dialogue_container)
 	var next_dialogue_button_control: ParleyNextDialogueButton = next_dialogue_button.instantiate()
-	if dialogue_ast.is_at_end(ctx, current_node_ast):
+	if await dialogue_sequence_ast.is_at_end(ctx, current_node_ast):
 		next_dialogue_button_control.text = 'Leave'
 	next_children.append(next_dialogue_button_control)
 	return next_children
@@ -155,6 +197,7 @@ func _create_horizontal_separator(sibling_above: Control) -> Node:
 	horizontal_separator.add_theme_constant_override('margin_bottom', 0)
 	horizontal_separator.add_child(HSeparator.new())
 	return horizontal_separator
+#endregion
 
 
 #region ACTIONS
@@ -216,30 +259,7 @@ func _ready() -> void:
 func _unhandled_input(_event: InputEvent) -> void:
 	# Only the balloon is allowed to handle input while it's showing
 	get_viewport().set_input_as_handled()
-
-
-# TODO: add a context param
-## Start some dialogue
-func start(_ctx: Dictionary, _dialogue_ast: ParleyDialogueSequenceAst, start_node: ParleyNodeAst = null) -> void:
-	balloon.show()
-	temporary_game_states = [self]
-	is_waiting_for_input = false
-	ctx = _ctx
-	dialogue_ast = _dialogue_ast
-	if start_node is ParleyDialogueNodeAst or start_node is ParleyDialogueOptionNodeAst:
-		current_node_asts = [start_node]
-	elif start_node:
-		current_node_asts = dialogue_ast.process_next(ctx, start_node)
-	else:
-		current_node_asts = dialogue_ast.process_next(ctx)
-
-
-## Process the next Nodes
-func next(current_node_ast: ParleyNodeAst) -> void:
-	# Probably want to emit at this point? Or maybe earlier
-	dialogue_history.append(current_node_ast)
-	previous_node_ast = current_node_ast
-	current_node_asts = dialogue_ast.process_next(ctx, current_node_ast)
+#endregion
 
 
 #region Signals