Skip to content

Commit fe0ef12

Browse files
chore(Health): Added documentation comments
1 parent 5c4a0f7 commit fe0ef12

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

Runtime/Health.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,11 @@ public bool Heal(int amount)
8484
return true;
8585
}
8686

87+
/// <summary>
88+
/// Sets the current health to the given amount. If increaseMaxHealth is true, the max health will be increased to the given amount if it is greater than the current max health.
89+
/// </summary>
90+
/// <param name="amount">The int value that is used to set the current health of the object</param>
91+
/// <param name="increaseMaxHealth">If true, the max health will be increased to the given amount if it is greater than the current max health</param>
8792
public void SetHealth(int amount, bool increaseMaxHealth)
8893
{
8994
if (amount < 0)

0 commit comments

Comments
 (0)