Events: Simplify logic for branching / end branches (#2559)

* Fix an issue with End Branch events

- fixes #2558

* Attempt at a big logic overhaul for branches

Trying to get rid of all the code that loops over the timeline with a bunch of "ignore"-levels, because it was always a mess. This seems slightly better. Needs a bunch of testing first though.

Author: Jowan-Spooner

addons/dialogic/Editor/TimelineEditor/VisualEditor/timeline_editor_visual.gd

@@ -418,7 +418,7 @@ func create_end_branch_event(at_index:int, parent_node:Node) -> Node:
 	end_branch_event.gui_input.connect(_on_event_block_gui_input.bind(end_branch_event))
 	parent_node.end_node = end_branch_event
 	end_branch_event.parent_node = parent_node
-	end_branch_event.add_end_control(parent_node.resource.get_end_branch_control())
+	end_branch_event.add_end_control(parent_node.resource._get_end_branch_control())
 	%Timeline.add_child(end_branch_event)
 	%Timeline.move_child(end_branch_event, at_index)
 	return end_branch_event

addons/dialogic/Modules/Choice/event_choice.gd

@@ -37,6 +37,10 @@ func _execute() -> void:
 		dialogic.Choices.show_current_question(false)
 		dialogic.current_state = dialogic.States.AWAITING_CHOICE
 
+
+func _is_branch_starter() -> bool:
+	return dialogic.Choices.is_question(dialogic.current_timeline_events.find(self))
+
 #endregion
 
 
@@ -53,7 +57,7 @@ func _init() -> void:
 
 
 # return a control node that should show on the END BRANCH node
-func get_end_branch_control() -> Control:
+func _get_end_branch_control() -> Control:
 	return load(get_script().resource_path.get_base_dir().path_join('ui_choice_end.tscn')).instantiate()
 #endregion
 

addons/dialogic/Modules/Choice/subsystem_choices.gd

@@ -244,28 +244,22 @@ func _on_choice_selected(choice_info := {}) -> void:
 	dialogic.handle_event(choice_info.event_index + 1)
 
 
-
 ## Returns the indexes of the choice events related to the current question.
 func get_current_choice_indexes() -> Array:
 	var choices := []
-	var evt_idx := dialogic.current_event_idx
-	var ignore := 0
+	var index := dialogic.current_event_idx-1
 	while true:
-		if evt_idx >= len(dialogic.current_timeline_events):
+		index += 1
+		if index >= len(dialogic.current_timeline_events):
 			break
-		if dialogic.current_timeline_events[evt_idx] is DialogicChoiceEvent:
-			if ignore == 0:
-				choices.append(evt_idx)
-			ignore += 1
-		elif dialogic.current_timeline_events[evt_idx].can_contain_events:
-			ignore += 1
+
+		var event: DialogicEvent = dialogic.current_timeline_events[index]
+		if event is DialogicChoiceEvent:
+			choices.append(index)
+			index = event.get_end_branch_index()
 		else:
-			if ignore == 0:
-				break
+			break
 
-		if dialogic.current_timeline_events[evt_idx] is DialogicEndBranchEvent:
-			ignore -= 1
-		evt_idx += 1
 	return choices
 
 
@@ -281,20 +275,27 @@ func _on_dialogic_action() -> void:
 #region HELPERS
 ####################################################################################################
 
+## Returns `true` if the given index is a text event before a question or the first choice event of a question.
 func is_question(index:int) -> bool:
-	if dialogic.current_timeline_events[index] is DialogicTextEvent:
+	var event: DialogicEvent = dialogic.current_timeline_events[index]
+	if event is DialogicTextEvent:
 		if len(dialogic.current_timeline_events)-1 != index:
-			if dialogic.current_timeline_events[index+1] is DialogicChoiceEvent:
+			var next_event: DialogicEvent = dialogic.current_timeline_events[index+1]
+			if next_event is DialogicChoiceEvent:
 				return true
 
-	if dialogic.current_timeline_events[index] is DialogicChoiceEvent:
-		if index != 0 and dialogic.current_timeline_events[index-1] is DialogicEndBranchEvent:
-			if dialogic.current_timeline_events[dialogic.current_timeline_events[index-1].find_opening_index(index-1)] is DialogicChoiceEvent:
-				return false
-			else:
-				return true
+	if event is DialogicChoiceEvent:
+		if index == 0:
+			return true
+		var prev_event: DialogicEvent = dialogic.current_timeline_events[index-1]
+		if not prev_event is DialogicEndBranchEvent:
+			return true
+		var prev_event_opener: DialogicEvent = dialogic.current_timeline_events[prev_event.get_opening_index()]
+		if prev_event_opener is DialogicChoiceEvent:
+			return false
 		else:
 			return true
+
 	return false
 
 #endregion

addons/dialogic/Modules/Condition/event_condition.gd

@@ -7,7 +7,8 @@ extends DialogicEvent
 enum ConditionTypes {IF, ELIF, ELSE}
 
 ### Settings
-## condition type (see [ConditionTypes]). Defaults to if.
+
+## Condition type (see [ConditionTypes]). Defaults to if.
 var condition_type := ConditionTypes.IF
 ## The condition as a string. Will be executed as an Expression.
 var condition := ""
@@ -26,24 +27,12 @@ func _execute() -> void:
 
 	var result: bool = dialogic.Expressions.execute_condition(condition)
 	if not result:
-		var idx: int = dialogic.current_event_idx
-		var ignore := 1
-		while true:
-			idx += 1
-			if not dialogic.current_timeline.get_event(idx) or ignore == 0:
-				break
-			elif dialogic.current_timeline.get_event(idx).can_contain_events:
-				ignore += 1
-			elif dialogic.current_timeline.get_event(idx) is DialogicEndBranchEvent:
-				ignore -= 1
-
-		dialogic.current_event_idx = idx-1
+		dialogic.current_event_idx = get_end_branch_index()
+
 	finish()
 
 
-## only called if the previous event was an end-branch event
-## return true if this event should be executed if the previous event was an end-branch event
-func should_execute_this_branch() -> bool:
+func _is_branch_starter() -> bool:
 	return condition_type == ConditionTypes.IF
 
 
@@ -60,7 +49,7 @@ func _init() -> void:
 
 
 # return a control node that should show on the END BRANCH node
-func get_end_branch_control() -> Control:
+func _get_end_branch_control() -> Control:
 	return load(get_script().resource_path.get_base_dir().path_join('ui_condition_end.tscn')).instantiate()
 
 ################################################################################

addons/dialogic/Modules/Core/event_end_branch.gd

@@ -14,43 +14,42 @@ func _execute() -> void:
 	finish()
 
 
+## Returns the index of the first event that
+## - is on the same "indentation"
+## - is not a branching event (unless it is a branch starter)
 func find_next_index() -> int:
 	var idx: int = dialogic.current_event_idx
-
-	var ignore: int = 1
 	while true:
 		idx += 1
 		var event: DialogicEvent = dialogic.current_timeline.get_event(idx)
 		if not event:
 			return idx
-		if event is DialogicEndBranchEvent:
-			if ignore > 1:
-				ignore -= 1
-		elif event.can_contain_events and not event.should_execute_this_branch():
-			ignore += 1
-		elif ignore <= 1:
-			return idx
 
-	return idx
+		if event.can_contain_events:
+			if event._is_branch_starter():
+				break
+			else:
+				idx = event.get_end_branch_index()
+				break
+		else:
+			break
 
+	return idx
 
-func find_opening_index(at_index:int) -> int:
-	var idx: int = at_index
 
-	var ignore: int = 1
+func get_opening_index() -> int:
+	var index: int = dialogic.current_timeline_events.find(self)
 	while true:
-		idx -= 1
-		var event: DialogicEvent = dialogic.current_timeline.get_event(idx)
-		if not event:
-			return idx
+		index -= 1
+		if index < 0:
+			break
+		var event: DialogicEvent = dialogic.current_timeline_events[index]
 		if event is DialogicEndBranchEvent:
-			ignore += 1
+			index = event.get_opening_index()
 		elif event.can_contain_events:
-			ignore -= 1
-			if ignore == 0:
-				return idx
+			return index
+	return 0
 
-	return idx
 #endregion
 
 #region INITIALIZE

addons/dialogic/Resources/event.gd

@@ -146,23 +146,38 @@ func _execute() -> void:
 #endregion
 
 
-#region OVERRIDABLES
+#region BRANCHING EVENTS
 ################################################################################
+## All of this section should only be in use if [member can_contain_events] is `true`.
 
-## to be overridden by sub-classes
-## only called if can_contain_events is true.
-## return a control node that should show on the END BRANCH node
-func get_end_branch_control() -> Control:
+
+## To be overridden. Only called if [member can_contain_events] is `true`.
+## Return a control node that should show on the END BRANCH node.
+func _get_end_branch_control() -> Control:
 	return null
 
 
-## to be overridden by sub-classes
-## only called if can_contain_events is true and the previous event was an end-branch event
-## return true if this event should be executed if the previous event was an end-branch event
-## basically only important for the Condition event but who knows. Some day someone might need this.
-func should_execute_this_branch() -> bool:
+## To be overridden. Return `true` if this event should be executed even if a previous branch has been executed.
+## E.g. IF events returns true, but ELIF and ELSE do not. The first choice of a question does this, while the others don't.
+func _is_branch_starter() -> bool:
 	return false
 
+
+## Returns the index of the end branch event of this event (Only use if can_contain_events is true).
+func get_end_branch_index() -> int:
+	var idx: int = dialogic.current_timeline_events.find(self)
+	while true:
+		idx += 1
+		var event: DialogicEvent = dialogic.current_timeline.get_event(idx)
+		if not event:
+			break
+		if event.can_contain_events:
+			idx = event.get_end_branch_index()
+		if event is DialogicEndBranchEvent:
+			break
+	return idx
+
+
 #endregion