Package studio.magemonkey.fabled.dynamic.trigger

Class ConsumeTrigger

java.lang.Object
studio.magemonkey.fabled.dynamic.trigger.ConsumeTrigger
All Implemented Interfaces:
Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
public class ConsumeTrigger extends Object implements Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConsumeTrigger()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bukkit.entity.LivingEntity
    getCaster(org.bukkit.event.player.PlayerItemConsumeEvent event)
    Fetches the caster as determined by the triggering event.
    Class<org.bukkit.event.player.PlayerItemConsumeEvent>
    getEvent()
    String
    getKey()
    org.bukkit.entity.LivingEntity
    getTarget(org.bukkit.event.player.PlayerItemConsumeEvent event, Settings settings)
    Fetches the target as determined by the triggering event.
    void
    setValues(org.bukkit.event.player.PlayerItemConsumeEvent event, CastData data)
    Reads data from the event and provides values to the caster's value data.
    boolean
    shouldTrigger(org.bukkit.event.player.PlayerItemConsumeEvent event, int level, Settings settings)

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface studio.magemonkey.fabled.dynamic.trigger.Trigger

    postProcess

  • Constructor Details

    • ConsumeTrigger

      public ConsumeTrigger()

  • Method Details

    • getKey

      public String getKey()
      Specified by:
      getKey in interface Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
      Returns:
      unique key for the trigger

    • getEvent

      public Class<org.bukkit.event.player.PlayerItemConsumeEvent> getEvent()
      Specified by:
      getEvent in interface Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
      Returns:
      class of the event related to the trigger

    • shouldTrigger

      public boolean shouldTrigger(org.bukkit.event.player.PlayerItemConsumeEvent event, int level, Settings settings)
      Specified by:
      shouldTrigger in interface Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
      Parameters:
      event - event details
      level - the level of the owning skill
      settings - skill settings
      Returns:
      true if the skill should activate, false otherwise

    • setValues

      public void setValues(org.bukkit.event.player.PlayerItemConsumeEvent event, CastData data)
      Reads data from the event and provides values to the caster's value data. This can be used within skills for more flexible effects. An example of this in base triggers is the Launch trigger providing the speed a projectile was launched so mechanics can replace it with equally-fast projectiles.
      Specified by:
      setValues in interface Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
      Parameters:
      event - event details
      data - caster's value data to populate

    • getCaster

      public org.bukkit.entity.LivingEntity getCaster(org.bukkit.event.player.PlayerItemConsumeEvent event)
      Fetches the caster as determined by the triggering event.
      Specified by:
      getCaster in interface Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
      Parameters:
      event - event details
      Returns:
      the one to apply the trigger for

    • getTarget

      public org.bukkit.entity.LivingEntity getTarget(org.bukkit.event.player.PlayerItemConsumeEvent event, Settings settings)
      Fetches the target as determined by the triggering event. This can be the same as the caster.
      Specified by:
      getTarget in interface Trigger<org.bukkit.event.player.PlayerItemConsumeEvent>
      Parameters:
      event - event details
      settings - skill settings
      Returns:
      the one being affected by the trigger (initial target)