cat.nyaa.nyaacore.component.IDamageStatistic Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rpgitems Show documentation

The legacy RPGItems continues. (fork)

There is a newer version: 3.12.2

package cat.nyaa.nyaacore.component;

import java.util.Map;
import java.util.UUID;

/**
 * Damage statistic is introduced by NyaaUtils
 * which tracks how much damage does every player make.
 * The implementation should track projectiles back to the shooter (arrow, potion, etc.)
 * 
 * See https://github.com/NyaaCat/NyaaUtils/blob/master/src/main/java/cat/nyaa/nyaautils/DamageStatListener.java
 */
public interface IDamageStatistic {
    /**
     * Find all attackers who attacked the victim.
     *
     * @param victim the victim
     * @return Map[playerUUID, totalDamageMade]
     */
    Map getDamageSources(UUID victim);

    /**
     * Find all victims of a player.
     *
     * @param playerId the player
     * @return Map[entityId, totalDamageMade]
     */
    Map getDamageVictims(UUID playerId);

    /**
     * Find out who healed this entity
     *
     * @param healee entityId
     * @return Map[playerUUID, totalHealingMade]
     */
    Map getHealers(UUID healee);

    /**
     * Find all entities the player healed
     *
     * @param healer playerUUID
     * @return Map[entityId, totalHealingMade]
     */
    Map getHealees(UUID healer);
}