Package gg.xp.xivsupport.events.actlines.events

Interface DescribesCastLocation<X extends Event & HasSourceEntity & HasAbility>

All Known Implementing Classes:
CastLocationDataEvent, SnapshotLocationDataEvent
public interface DescribesCastLocation<X extends Event & HasSourceEntity & HasAbility>

  • Method Summary

    Modifier and Type
    Method
    Description
    Double
    getHeadingOnly()
    If the cast is not targeted on a location, but is targeted in a direction from the caster, return that direction.
    Position
    getPos()
    If the cast is targeted on a location (including an optional rotation), then it will be returned in this method.
    X
    originalEvent()
     

  • Method Details

    • originalEvent

      X originalEvent()
      Returns:
      The event being described by this additional data. If the event contains its own data, rather than being provided after-the-fact, then this should point to itself.

    • getPos

      @Nullable Position getPos()
      If the cast is targeted on a location (including an optional rotation), then it will be returned in this method. If it is only a rotation, or a non-location target, then this will be null.
      Returns:
      The position, else null.

    • getHeadingOnly

      @Nullable Double getHeadingOnly()
      If the cast is not targeted on a location, but is targeted in a direction from the caster, return that direction.
      Returns:
      The direction, else null.