From 50abb28155abf283ae20cfa0a65de761875d5004 Mon Sep 17 00:00:00 2001
From: Rafael Almeida Barbosa <rafaelbarbosatec@gmail.com>
Date: Mon, 29 Jul 2024 10:07:50 -0300
Subject: [PATCH] adds comments

---
 lib/mixins/attackable.dart | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/lib/mixins/attackable.dart b/lib/mixins/attackable.dart
index 57156edfe..1fd4d2ea5 100644
--- a/lib/mixins/attackable.dart
+++ b/lib/mixins/attackable.dart
@@ -25,12 +25,13 @@ mixin Attackable on GameComponent {
 
   double get life => _life;
 
+  /// Set initial life
   void initialLife(double life) {
     _life = life;
     _maxLife = life;
   }
 
-  /// increase life
+  /// Increase life
   void addLife(double life) {
     double newLife = _life + life;
 
@@ -43,6 +44,7 @@ mixin Attackable on GameComponent {
     _verifyLimitsLife();
   }
 
+  // Update life
   void updateLife(double life, {bool verifyDieOrRevive = true}) {
     _life = life;
     if (verifyDieOrRevive) {
@@ -62,7 +64,10 @@ mixin Attackable on GameComponent {
     _verifyLimitsLife();
   }
 
+  // Called when life is removed
   void onRemoveLife(double life) {}
+
+  // Called when life is restored
   void onRestoreLife(double life) {}
 
   void _verifyLimitsLife() {
@@ -87,6 +92,7 @@ mixin Attackable on GameComponent {
     return canReceive;
   }
 
+  // Called when the component receives damage
   void onReceiveDamage(
     AttackOriginEnum attacker,
     double damage,
@@ -120,15 +126,18 @@ mixin Attackable on GameComponent {
     return false;
   }
 
+  // Called when the component dies
   void onDie() {
     _isDead = true;
   }
 
+  // Called when the component revives
   void onRevive() {
     _isDead = false;
   }
 
   bool get isDead => _isDead;
 
+  // Get rect collision of the component used to receive damage
   Rect rectAttackable() => rectCollision;
 }