Merge pull request #13 from Turtyo/3-override

Added `@Override` comments for children classes that implement a function declared in a parent class

Buffs/Buff_Poison.gd

@@ -2,7 +2,7 @@ extends BuffBase
 class_name Buff_Poison
 ## Poison deals damage to the owning Entity at the start of their turn
 
-
+# @Override
 func on_turn_start() -> void:
  var damage_data: DealDamageData = DealDamageData.new()
  damage_data.damage = buff_power

Buffs/Buff_Strength.gd

@@ -2,7 +2,7 @@ extends BuffBase
 class_name Buff_Strength
 ## Strength buff increases an Entity's damage stat
 
-
+# @Override
 func get_modified_stats(stats: EntityStats) -> EntityStats:
  stats.damage_dealt_increase += buff_power
  return stats

Buffs/Buff_Vulnerability.gd

@@ -2,7 +2,7 @@ extends BuffBase
 class_name Buff_Vulnerability
 ## Vulnerability buff increases the amount of damage an Entity takes from attacks
 
-
+# @Override
 func get_modified_stats(stats: EntityStats) -> EntityStats:
  stats.damage_taken_increase += buff_power
  return stats

Buffs/Buff_Weakness.gd

@@ -2,7 +2,7 @@ extends BuffBase
 class_name Buff_Weakness
 ## Vulnerability buff decreases the amount of damage that an Entity deals
 
-
+# @Override
 func get_modified_stats(stats: EntityStats) -> EntityStats:
  stats.damage_dealt_increase -= buff_power
  return stats

CONTRIBUTING.md

@@ -22,4 +22,5 @@ If you are writing code that implements something new, please provide test files
 
 As of the writing of this CONTRIBUTING.md there is no code formatter for Godot, even though it might come later. Try to follow the code conventions of the [GDScript style guide](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html)
 
-Use static typing whenever possible.
+- Use static typing whenever possible.
+- Add # @Override for children classes that implement a function declared in a parent class.

Cards/Card_DamageHealth.gd

@@ -2,7 +2,7 @@ extends CardBase
 class_name Card_DamageHealth
 # Deals damage equal to the amount of health that the caster has lost.
 
-
+# @Override
 func _deal_damage(caster: Entity, target: Entity) -> void:
  var health_lost: float = caster.get_health_component().max_health - caster.get_health_component().current_health
 

Entity/Enemy/Enemy.gd

@@ -2,7 +2,7 @@ extends Entity
 class_name Enemy
 ## Base enemy entity class.
 
-
+# @Override
 func _ready() -> void:
  super()
  PhaseManager.on_phase_changed.connect(_on_phase_changed)

Entity/Player/Player.gd

@@ -2,7 +2,7 @@ extends Entity
 class_name Player
 ## Base player Entity class.
 
-
+# @Override
 func _ready() -> void:
  super()
  PlayerManager.set_player(self)