add action_applied signals

Author: cluttered-code

addons/gdUnit4/GdUnitRunner.cfg

@@ -1 +1 @@
-{"included":{"res://test/":[]},"server_port":31003,"skipped":{},"version":"1.0"}
+{"included":{"res://test/":[]},"server_port":31002,"skipped":{},"version":"1.0"}

addons/health_hitbox_hurtbox/2d/hit_box_2d/hit_box_2d.gd

@@ -2,10 +2,11 @@ class_name HitBox2D extends Area2D
 ## [HitBox2D] is associated with an object that can collide with a [HurtBox2D].
 
 ## emitted when collision with [HitBox2D] detected.
-## Can be used to detect collision with projectiles.
 signal hit_box_entered(hit_box: HitBox2D)
 ## emitted when collision with [HurtBox2D] detected.
 signal hurt_box_entered(hurt_box: HurtBox2D)
+## emitted after the action is applied to a [HurtBox2D].
+signal action_applied(hurt_box: HurtBox2D)
 ## emitted when collision with [Area2D] that isn't [HitBox2D] or [HurtBox2D].
 ## Can be using to detect things like environment.
 signal unknown_area_entered(area: Area2D)
@@ -41,18 +42,15 @@ func _on_area_entered(area: Area2D) -> void:
 		return
 
 	var hurt_box: HurtBox2D = area
-	_hit_hurt_box(hurt_box)
 	hurt_box_entered.emit(hurt_box)
+	_apply_action(hurt_box)
+	action_applied.emit(hurt_box)
 
 
 ## Perfomes the [Health.Action] on the specified [HurtBox2D].
-func _hit_hurt_box(hurt_box: HurtBox2D) -> void:
+func _apply_action(hurt_box: HurtBox2D) -> void:
 	match action:
 		Health.Action.DAMAGE:
 			hurt_box.damage(amount)
 		Health.Action.HEAL:
 			hurt_box.heal(amount)
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "HitBox2D"

addons/health_hitbox_hurtbox/2d/hit_scan_2d/hit_scan_2d.gd

@@ -3,11 +3,11 @@ class_name HitScan2D extends RayCast2D
 ## HitScan2D interacts with [HurtBox2D] to affect [Health] components.
 
 ## emitted when collision with [HitBox2D] detected.
-## To cancel each other the [HitBox2D] will have to be [color=orange]queue_free()[/color]
-## from hear because collision detection is one sided.
 signal hit_box_entered(hit_box: HitBox2D)
 ## emitted when collision with [HurtBox2D] detected.
 signal hurt_box_entered(hurt_box: HurtBox2D)
+## emitted after the action is applied to a [HurtBox2D].
+signal action_applied(hurt_box: HurtBox2D)
 ## emitted when collision with [Area2D] that isn't [HitBox2D] or [HurtBox2D].
 ## Used to detect things like environment.
 signal unknown_area_entered(area: Area2D)
@@ -58,14 +58,15 @@ func fire() -> void:
 		return
 
 	var hurt_box: HurtBox2D = collider
+	hurt_box_entered.emit(hurt_box)
+	_apply_action(hurt_box)
+	action_applied.emit(hurt_box)
+
+
+## Perfomes the [Health.Action] on the specified [HurtBox2D].
+func _apply_action(hurt_box: HurtBox2D) -> void:
 	match action:
 		Health.Action.DAMAGE:
 			hurt_box.damage(amount)
 		Health.Action.HEAL:
 			hurt_box.heal(amount)
-	
-	hurt_box_entered.emit(hurt_box)
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "HitScan2D"

addons/health_hitbox_hurtbox/2d/hurt_box_2d/hurt_box_2d.gd

@@ -64,7 +64,3 @@ func _get_configuration_warnings() -> PackedStringArray:
 		warnings.append("This node requires a 'Health' component")
 
 	return warnings
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "HurtBox2D"

addons/health_hitbox_hurtbox/3d/hit_box_3d/hit_box_3d.gd

@@ -5,6 +5,8 @@ class_name HitBox3D extends Area3D
 signal hit_box_entered(hit_box: HitBox3D)
 ## emitted when collision with [HurtBox3D] detected.
 signal hurt_box_entered(hurt_box: HurtBox3D)
+## emitted after the action is applied to a [HurtBox3D].
+signal action_applied(hurt_box: HurtBox3D)
 ## emitted when collision with [Area3D] that isn't [HitBox3D] or [HurtBox3D].
 ## Can be using to detect things like environment.
 signal unknown_area_entered(area: Area3D)
@@ -40,18 +42,15 @@ func _on_area_entered(area: Area3D) -> void:
 		return
 
 	var hurt_box: HurtBox3D = area
-	_hit_hurt_box(hurt_box)
 	hurt_box_entered.emit(hurt_box)
+	_apply_action(hurt_box)
+	action_applied.emit(hurt_box)
 
 
 ## Perfomes the [Health.Action] on the specified [HurtBox3D].
-func _hit_hurt_box(hurt_box: HurtBox3D) -> void:
+func _apply_action(hurt_box: HurtBox3D) -> void:
 	match action:
 		Health.Action.DAMAGE:
 			hurt_box.damage(amount)
 		Health.Action.HEAL:
 			hurt_box.heal(amount)
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "HitBox3D"

addons/health_hitbox_hurtbox/3d/hit_scan_3d/hit_scan_3d.gd

@@ -3,11 +3,11 @@ class_name HitScan3D extends RayCast3D
 ## HitScan3D interacts with [HurtBox3D] to affect [Health] components.
 
 ## emitted when collision with [HitBox3D] detected.
-## To cancel each other the [HitBox3D] will have to be [color=orange]queue_free()[/color]
-## from hear because collision detection is one sided.
 signal hit_box_entered(hit_box: HitBox3D)
 ## emitted when collision with [HurtBox3D] detected.
 signal hurt_box_entered(hurt_box: HurtBox3D)
+## emitted after the action is applied to a [HurtBox3D].
+signal action_applied(hurt_box: HurtBox3D)
 ## emitted when collision with [Area3D] that isn't [HitBox3D] or [HurtBox3D].
 ## Used to detect things like environment.
 signal unknown_area_entered(area: Area3D)
@@ -58,14 +58,15 @@ func fire() -> void:
 		return
 
 	var hurt_box: HurtBox3D = collider
+	hurt_box_entered.emit(hurt_box)
+	_apply_action(hurt_box)
+	action_applied.emit(hurt_box)
+
+
+## Perfomes the [Health.Action] on the specified [HurtBox3D].
+func _apply_action(hurt_box: HurtBox3D) -> void:
 	match action:
 		Health.Action.DAMAGE:
 			hurt_box.damage(amount)
 		Health.Action.HEAL:
 			hurt_box.heal(amount)
-	
-	hurt_box_entered.emit(hurt_box)
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "HitScan3D"

addons/health_hitbox_hurtbox/3d/hurt_box_3d/hurt_box_3d.gd

@@ -63,7 +63,3 @@ func _get_configuration_warnings() -> PackedStringArray:
 		warnings.append("This node requires a 'Health' component")
 
 	return warnings
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "HurtBox3D"

addons/health_hitbox_hurtbox/health/health.gd

@@ -59,7 +59,6 @@ const DEFAULT_MAX = 100
 			# reduce current in game so it is not greater than max
 			current = mini(current, max)
 
-
 @export_group("Conditions")
 ## Enable if entity is capable of taking damage.
 @export var damageable: bool = true
@@ -173,7 +172,3 @@ func heal(amount: int, multiplier: float = 1.0) -> void:
 	if notify_revived:
 		print_debug("%s revived" % entity)
 		revived.emit(entity)
-
-
-## Returns the object's class name as a [String].
-func get_class() -> String: return "Health"

addons/health_hitbox_hurtbox/plugin.cfg

@@ -3,5 +3,5 @@
 name="Health, HitBoxes, HurtBoxes, and HitScans"
 description="2D and 3D Components to manage health, damage, and healing"
 author="ClutteredCode"
-version="4.1.0"
+version="4.2.0"
 script="plugin.gd"