Package studio.magemonkey.fabled.dynamic.trigger

Interface Trigger<E extends org.bukkit.event.Event>

All Known Subinterfaces:
CustomTrigger<E>
All Known Implementing Classes:
AirTrigger, ArmorEquipTrigger, AttributeChangeTrigger, BlockBreakTrigger, BlockPlaceTrigger, ChatTrigger, ClickLeftTrigger, ClickRightTrigger, ClickTrigger, ConsumeTrigger, CrouchTrigger, DeathTrigger, DropItemTrigger, EntityTargetTrigger, EnvironmentalTrigger, ExperienceTrigger, FishingBiteTrigger, FishingFailTrigger, FishingFishTrigger, FishingGrabTrigger, FishingGroundTrigger, FishingReelTrigger, FishingTrigger, GlideTrigger, HarvestTrigger, HealTrigger, ItemSwapTrigger, JumpTrigger, KillTrigger, LandTrigger, LaunchTrigger, MoveTrigger, PhysicalDealtTrigger, PhysicalTakenTrigger, PhysicalTrigger, ProjectileHitTrigger, ProjectileTickTrigger, RiptideTrigger, ShearTrigger, ShieldTrigger, SignalTrigger, SkillCastTrigger, SkillDealtTrigger, SkillTakenTrigger, SkillTrigger, SprintTrigger, WorldChangeTrigger
public interface Trigger<E extends org.bukkit.event.Event>
Possible triggers for dynamic skill effects

  • Method Summary

    Modifier and Type
    Method
    Description
    org.bukkit.entity.LivingEntity
    getCaster(E event)
    Fetches the caster as determined by the triggering event.
    Class<E>
    getEvent()
     
    String
    getKey()
     
    org.bukkit.entity.LivingEntity
    getTarget(E event, Settings settings)
    Fetches the target as determined by the triggering event.
    default void
    postProcess(E event, DynamicSkill skill)
    Handles applying other effects after the skill resolves
    void
    setValues(E event, CastData data)
    Reads data from the event and provides values to the caster's value data.
    boolean
    shouldTrigger(E event, int level, Settings settings)
     

  • Method Details

    • getKey

      String getKey()
      Returns:
      unique key for the trigger

    • getEvent

      Class<E> getEvent()
      Returns:
      class of the event related to the trigger

    • shouldTrigger

      boolean shouldTrigger(E event, int level, Settings settings)
      Parameters:
      event - event details
      level - the level of the owning skill
      settings - skill settings
      Returns:
      true if the skill should activate, false otherwise

    • setValues

      void setValues(E 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.
      Parameters:
      event - event details
      data - caster's value data to populate

    • getCaster

      org.bukkit.entity.LivingEntity getCaster(E event)
      Fetches the caster as determined by the triggering event.
      Parameters:
      event - event details
      Returns:
      the one to apply the trigger for

    • getTarget

      org.bukkit.entity.LivingEntity getTarget(E event, Settings settings)
      Fetches the target as determined by the triggering event. This can be the same as the caster.
      Parameters:
      event - event details
      settings - skill settings
      Returns:
      the one being affected by the trigger (initial target)

    • postProcess

      default void postProcess(E event, DynamicSkill skill)
      Handles applying other effects after the skill resolves
      Parameters:
      event - event details
      skill - skill to resolve