Package studio.magemonkey.fabled.api.event

Class SkillHealEvent

java.lang.Object
org.bukkit.event.Event
org.bukkit.event.entity.EntityEvent
org.bukkit.event.entity.EntityRegainHealthEvent
studio.magemonkey.fabled.api.event.SkillHealEvent
All Implemented Interfaces:
org.bukkit.event.Cancellable
public class SkillHealEvent extends org.bukkit.event.entity.EntityRegainHealthEvent
An event for when an entity is healed by another entity with the use of a skill.

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.bukkit.event.entity.EntityRegainHealthEvent

    org.bukkit.event.entity.EntityRegainHealthEvent.RegainReason

    Nested classes/interfaces inherited from class org.bukkit.event.Event

    org.bukkit.event.Event.Result

  • Field Summary

    Fields inherited from class org.bukkit.event.entity.EntityEvent

    entity

  • Constructor Summary

    Constructors
    Constructor
    Description
    SkillHealEvent(org.bukkit.entity.LivingEntity healer, org.bukkit.entity.LivingEntity target, double amount)
    Initializes a new event

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    getAmount()
    Retrieves the amount of health healed
    org.bukkit.entity.LivingEntity
    getHealer()
    Retrieves the entity that dealt the heal
    org.bukkit.entity.LivingEntity
    getTarget()
    Retrieves the entity that received the heal
    boolean
    isCancelled()
    Checks whether the event is cancelled
    void
    setAmount(double amount)
    Sets the amount of health healed
    void
    setCancelled(boolean cancelled)
    Sets the cancelled state of the event

    Methods inherited from class org.bukkit.event.entity.EntityRegainHealthEvent

    getHandlerList, getHandlers, getRegainReason

    Methods inherited from class org.bukkit.event.entity.EntityEvent

    getEntity, getEntityType

    Methods inherited from class org.bukkit.event.Event

    getEventName, isAsynchronous

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • SkillHealEvent

      public SkillHealEvent(org.bukkit.entity.LivingEntity healer, org.bukkit.entity.LivingEntity target, double amount)
      Initializes a new event
      Parameters:
      healer - entity dealing the heal
      target - entity receiving the heal
      amount - the amount of health healed

  • Method Details

    • isCancelled

      public boolean isCancelled()
      Checks whether the event is cancelled
      Specified by:
      isCancelled in interface org.bukkit.event.Cancellable
      Overrides:
      isCancelled in class org.bukkit.event.entity.EntityRegainHealthEvent
      Returns:
      true if cancelled, false otherwise

    • setCancelled

      public void setCancelled(boolean cancelled)
      Sets the cancelled state of the event
      Specified by:
      setCancelled in interface org.bukkit.event.Cancellable
      Overrides:
      setCancelled in class org.bukkit.event.entity.EntityRegainHealthEvent
      Parameters:
      cancelled - the cancelled state of the event

    • getHealer

      public org.bukkit.entity.LivingEntity getHealer()
      Retrieves the entity that dealt the heal
      Returns:
      entity that dealt the heal

    • getTarget

      public org.bukkit.entity.LivingEntity getTarget()
      Retrieves the entity that received the heal
      Returns:
      entity that received the heal

    • getAmount

      public double getAmount()
      Retrieves the amount of health healed
      Overrides:
      getAmount in class org.bukkit.event.entity.EntityRegainHealthEvent
      Returns:
      amount of health healed

    • setAmount

      public void setAmount(double amount)
      Sets the amount of health healed
      Overrides:
      setAmount in class org.bukkit.event.entity.EntityRegainHealthEvent
      Parameters:
      amount - amount of health healed