Package gg.xp.xivsupport.events.state

Interface XivState

All Superinterfaces:
SubState
All Known Implementing Classes:
XivStateDummy, XivStateImpl
public interface XivState extends SubState

  • Method Details

    • getPlayer

      XivPlayerCharacter getPlayer()

    • getZone

      @Nullable @Nullable XivZone getZone()

    • getMap

      @Nullable @Nullable XivMap getMap()

    • getPartyList

      List<XivPlayerCharacter> getPartyList()

    • zoneIs

      boolean zoneIs(long zoneId)

    • dutyIs

      default boolean dutyIs(Duty duty)

    • removeSpecificCombatant

      void removeSpecificCombatant(long idToRemove)

    • getCombatants

      Map<Long,XivCombatant> getCombatants()

    • getCombatant

      @Nullable default @Nullable XivCombatant getCombatant(long id)

    • getLatestCombatantData

      @NotNull default @NotNull XivCombatant getLatestCombatantData(@NotNull @NotNull XivCombatant cbt)

    • getCombatantsListCopy

      List<XivCombatant> getCombatantsListCopy()

    • getPartySlotOf

      int getPartySlotOf(XivEntity entity)
      Returns the party slot of the given entity
      Parameters:
      entity - The entity
      Returns:
      0-7 based on their party slot, or -1 if they are not in the party

    • provideCombatantHP

      void provideCombatantHP(XivCombatant target, @NotNull @NotNull HitPoints hitPoints)

    • provideCombatantMP

      void provideCombatantMP(XivCombatant target, @NotNull @NotNull ManaPoints manaPoints)

    • provideCombatantPos

      void provideCombatantPos(XivCombatant target, Position newPos)

    • provideActFallbackCombatant

      void provideActFallbackCombatant(XivCombatant cbt)

    • flushProvidedValues

      void flushProvidedValues()

    • getPlayerJob

      @Nullable default @Nullable Job getPlayerJob()

    • playerJobMatches

      default boolean playerJobMatches(Predicate<Job> condition)

    • inCombat

      boolean inCombat()

    • provideCombatantShieldPct

      void provideCombatantShieldPct(XivCombatant cbt, long shieldPct)

    • provideCombatantRadius

      void provideCombatantRadius(XivCombatant cbt, float radius)

    • npcById

      @Nullable default @Nullable XivCombatant npcById(long id)

    • npcsById

      default List<XivCombatant> npcsById(long id)

    • provideTransformation

      void provideTransformation(long entityId, short transformationId)

    • provideWeaponId

      void provideWeaponId(XivCombatant existing, short weaponId)