Add infinite repeat as a QOL option to update animations

Fix for #2651

Author: zaknafean

addons/dialogic/Modules/Character/class_dialogic_animation.gd

@@ -22,6 +22,7 @@ var base_scale: Vector2
 
 ## Used to repeate the animation for a number of times.
 var repeats: int
+var repeat_forever : bool = false
 
 ## If `true`, the animation will be reversed.
 ## This must be implemented by each animation or it will have no effect.
@@ -43,7 +44,7 @@ func animate() -> void:
 func finished_one_loop() -> void:
 	repeats -= 1
 
-	if repeats > 0:
+	if repeats > 0 or repeat_forever:
 		animate()
 
 	else:

addons/dialogic/Modules/Character/event_character.gd

@@ -26,6 +26,7 @@ var animation_name := ""
 var animation_length: float = 0.5
 ## How often the animation is repeated. Only for Update events.
 var animation_repeats: int = 1
+var repeat_forever: bool = false
 ## If true, the events waits for the animation to finish before the next event starts.
 var animation_wait := false
 
@@ -175,15 +176,17 @@ func _execute() -> void:
 				var time_per_event: float = dialogic.Inputs.auto_skip.time_per_event
 				var time_for_repetitions: float = time_per_event / animation_repeats
 				final_animation_length = time_for_repetitions
-
+			
 			var animation := dialogic.Portraits.animate_character(
 				character,
 				animation_name,
 				final_animation_length,
 				final_animation_repetitions,
+				false,
+				repeat_forever
 			)
 
-			if animation_wait:
+			if animation_wait and !repeat_forever:
 				dialogic.current_state = DialogicGameHandler.States.ANIMATING
 				await animation.finished
 				dialogic.current_state = DialogicGameHandler.States.IDLE
@@ -315,6 +318,7 @@ func get_shortcode_parameters() -> Dictionary:
 		"length"		: {"property": "animation_length", 			"default": 0.5},
 		"wait" 			: {"property": "animation_wait", 			"default": false},
 		"repeat"		: {"property": "animation_repeats", 		"default": 1},
+		"repeat_forever"		: {"property": "repeat_forever", 		"default": false},
 
 		"z_index" 		: {"property": "z_index", 						"default": 0},
 		"mirrored"		: {"property": "mirrored", 						"default": false},
@@ -415,6 +419,8 @@ func build_event_editor() -> void:
 			'should_show_animation_options() and !animation_name.is_empty()')
 	add_body_edit('animation_repeats', ValueType.NUMBER, {'left_text':'Repeat:', 'mode':1, "min":1},
 			'should_show_animation_options() and !animation_name.is_empty() and action == %s)' %Actions.UPDATE)
+	add_body_edit('repeat_forever', ValueType.BOOL, {'left_text':'Repeat Forever:'},
+			'should_show_animation_options() and !animation_name.is_empty() and action == %s)' %Actions.UPDATE)
 	add_body_line_break()
 	add_body_edit('transform_time', ValueType.NUMBER, {'left_text':'Movement duration:', "min":0, "tooltip": "When changing the characters position, this is how fast it will happen."},
 			"should_show_transform_options()")

addons/dialogic/Modules/Character/subsystem_portraits.gd

@@ -248,7 +248,7 @@ func _update_portrait_transform(portrait_node: Node, time:float = 0.0) -> void:
 
 ## Animates the node with the given animation.
 ## Is used both on the character node (most animations) and the portrait nodes (cross-fade animations)
-func _animate_node(node: Node, animation_path: String, length: float, repeats := 1, is_reversed := false) -> DialogicAnimation:
+func _animate_node(node: Node, animation_path: String, length: float, repeats := 1, is_reversed := false, repeat_forever := false) -> DialogicAnimation:
 	if node.has_meta('animation_node') and is_instance_valid(node.get_meta('animation_node')):
 		node.get_meta('animation_node').queue_free()
 
@@ -261,6 +261,7 @@ func _animate_node(node: Node, animation_path: String, length: float, repeats :=
 	anim_node.base_scale = node.scale
 	anim_node.time = length
 	anim_node.repeats = repeats
+	anim_node.repeat_forever = repeat_forever
 	anim_node.is_reversed = is_reversed
 
 	add_child(anim_node)
@@ -516,15 +517,14 @@ func change_character_extradata(character:DialogicCharacter, extra_data:="") ->
 
 
 ## Starts the given animation on the given character. Only works with joined characters
-func animate_character(character: DialogicCharacter, animation_path: String, length: float, repeats := 1, is_reversed := false) -> DialogicAnimation:
+func animate_character(character: DialogicCharacter, animation_path: String, length: float, repeats := 1, is_reversed := false, repeat_forever := false) -> DialogicAnimation:
 	if not is_character_joined(character):
 		return null
-
+	
 	animation_path = DialogicPortraitAnimationUtil.guess_animation(animation_path)
 
 	var character_node: Node = dialogic.current_state_info.portraits[character.get_identifier()].node
-
-	return _animate_node(character_node, animation_path, length, repeats, is_reversed)
+	return _animate_node(character_node, animation_path, length, repeats, is_reversed, repeat_forever)
 
 
 ## Moves the given character to the given position. Only works with joined characters