Skip to content

Commit

Permalink
comment update
Browse files Browse the repository at this point in the history
  • Loading branch information
SJuliez committed Aug 2, 2024
1 parent 90f8c41 commit 6a651eb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions megamek/src/megamek/common/ICarryable.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ public interface ICarryable extends InGameObject {
double getTonnage();

/**
* Damages this carryable object, detracting the given amount of damage from the weight of the carryable object.
* Returns true if the cargo is considered destroyed by applying the damage.
* Note: This method does *not* check if the object is invulnerable; this must be tested by the caller.
* Damages this carryable object by the given amount of damage. Returns true if the cargo is considered
* destroyed by applying the damage.
* Note: This method does *not* check if the object is invulnerable; it is up to the caller to do that.
* Calling this method on an invulnerable carryable object behaves exactly like calling it on a vulnerable
* one.
*
* @param amount The damage (a weight to remove in tons)
* @param amount The damage
* @return True if the cargo is destroyed by the damage, false otherwise
* @see #getTonnage()
*/
Expand Down

0 comments on commit 6a651eb

Please sign in to comment.