Package dev.kitteh.factions

Interface Faction

All Superinterfaces:
Participator, Selectable
All Known Implementing Classes:
JSONFaction, MemoryFaction
@AvailableSince("4.0.0") @NonExtendable @NullMarked public interface Faction extends Participator, Selectable

  • Method Details

    • id

      int id()

    • addAnnouncement

      void addAnnouncement(FPlayer fPlayer, String msg)

    • sendUnreadAnnouncements

      void sendUnreadAnnouncements(FPlayer fPlayer)

    • warps

      Map<String,LazyLocation> warps()

    • warp

      @Nullable LazyLocation warp(String name)

    • isWarp

      default boolean isWarp(String name)

    • createWarp

      void createWarp(String name, LazyLocation loc)

    • hasWarpPassword

      boolean hasWarpPassword(String warp)

    • isWarpPassword

      boolean isWarpPassword(String warp, String password)

    • setWarpPassword

      void setWarpPassword(String warp, String password)

    • removeWarpPassword

      void removeWarpPassword(String warp)

    • removeWarp

      boolean removeWarp(String name)

    • clearWarps

      void clearWarps()

    • maxWarps

      @AvailableSince("4.2.0") default int maxWarps()

    • maxVaults

      int maxVaults()

    • maxVaults

      void maxVaults(int value)

    • invites

      Set<UUID> invites()

    • invite

      void invite(FPlayer fplayer)

    • deInvite

      void deInvite(FPlayer fplayer)

    • hasInvite

      boolean hasInvite(FPlayer fplayer)

    • ban

      void ban(FPlayer target, FPlayer banner)

    • unban

      void unban(FPlayer player)

    • isBanned

      boolean isBanned(FPlayer player)

    • bans

      Set<BanInfo> bans()

    • open

      boolean open()

    • open

      void open(boolean isOpen)

    • isPeaceful

      boolean isPeaceful()

    • peaceful

      void peaceful(boolean isPeaceful)

    • peacefulExplosionsEnabled

      void peacefulExplosionsEnabled(boolean val)

    • peacefulExplosionsEnabled

      boolean peacefulExplosionsEnabled()

    • noExplosionsInTerritory

      default boolean noExplosionsInTerritory()

    • isPermanent

      boolean isPermanent()

    • permanent

      void permanent(boolean isPermanent)

    • tag

      String tag()

    • tag

      void tag(String str)

    • tagLegacy

      @Obsolete String tagLegacy(@Nullable Participator participator)

    • description

      String description()

    • description

      void description(String value)

    • link

      String link()

    • link

      void link(String value)

    • home

      void home(org.bukkit.Location home)

    • removeHome

      void removeHome()

    • hasHome

      default boolean hasHome()

    • home

      @Nullable org.bukkit.Location home()

    • founded

      Instant founded()

    • founded

      void founded(Instant when)

    • noPvPInTerritory

      default boolean noPvPInTerritory()

    • noMonstersInTerritory

      default boolean noMonstersInTerritory()

    • isNormal

      default boolean isNormal()

    • isWilderness

      default boolean isWilderness()

    • isSafeZone

      default boolean isSafeZone()

    • isWarZone

      default boolean isWarZone()

    • lastDeath

      void lastDeath(Instant time)

    • lastDeath

      Instant lastDeath()

    • kills

      default int kills()

    • deaths

      default int deaths()

    • hasAccess

      boolean hasAccess(Selectable selectable, PermissibleAction permissibleAction, @Nullable FLocation location)
      Get the access of a selectable for a given chunk.
      Parameters:
      selectable - selectable
      permissibleAction - permissible
      location - location
      Returns:
      player's access

    • permissions

      Faction.Permissions permissions()

    • tntBank

      int tntBank()

    • tntBankMax

      int tntBankMax()

    • tntBank

      void tntBank(int amount)

    • shieldActive

      default boolean shieldActive()

    • shieldCooldownRemaining

      Duration shieldCooldownRemaining()

    • shieldRemaining

      Duration shieldRemaining()

    • shield

      void shield(Duration duration, Duration cooldown)

    • upgradeLevel

      int upgradeLevel(Upgrade upgrade)

    • upgradeLevel

      void upgradeLevel(Upgrade upgrade, int level)

    • relationWish

      Relation relationWish(Faction otherFaction)

    • relationWish

      void relationWish(Faction otherFaction, Relation relation)

    • relationCount

      default int relationCount(Relation relation)

    • isRaidable

      @AvailableSince("4.3.0") default boolean isRaidable()
      Gets if the faction is raidable.
      Returns:
      true if raidable
      See Also:

    • dtr

      double dtr()

    • dtrWithoutUpdate

      double dtrWithoutUpdate()

    • dtr

      void dtr(double dtr)

    • dtrLastUpdated

      long dtrLastUpdated()

    • dtrFrozenUntil

      long dtrFrozenUntil()

    • dtrFrozenUntil

      void dtrFrozenUntil(long time)

    • dtrFrozen

      default boolean dtrFrozen()

    • powerExact

      double powerExact()
      Gets the exact faction power, which is not used for claim/raidability calculations
      Returns:
      exact power

    • powerMaxExact

      double powerMaxExact()
      Gets the exact faction max power
      Returns:
      exactmax power

    • power

      default int power()
      Gets the faction power, as used for claims/raidability calculations
      Returns:
      power

    • powerMax

      default int powerMax()

    • permanentPower

      @Nullable Integer permanentPower()

    • permanentPower

      void permanentPower(@Nullable Integer permanentPower)

    • hasPermanentPower

      default boolean hasPermanentPower()

    • powerBoost

      double powerBoost()

    • powerBoost

      void powerBoost(double powerBoost)

    • hasLandInflation

      default boolean hasLandInflation()

    • isPowerFrozen

      boolean isPowerFrozen()

    • size

      int size()

    • memberLimit

      default int memberLimit()

    • members

      Set<FPlayer> members()

    • membersOnline

      Set<FPlayer> membersOnline(boolean online)

    • membersOnline

      Set<FPlayer> membersOnline(boolean online, @Nullable FPlayer viewer)

    • admin

      @Nullable FPlayer admin()

    • members

      List<FPlayer> members(Role role)

    • membersOnlineAsPlayers

      List<org.bukkit.entity.Player> membersOnlineAsPlayers()

    • hasMembersOnline

      boolean hasMembersOnline()

    • trackMemberLoggedOff

      void trackMemberLoggedOff()

    • promoteNewLeader

      void promoteNewLeader()

    • defaultRole

      Role defaultRole()

    • defaultRole

      void defaultRole(Role role)

    • sendMessage

      default void sendMessage(@NonNull net.kyori.adventure.text.Component component)
      Description copied from interface: Participator
      Sends a component.
      Specified by:
      sendMessage in interface Participator
      Parameters:
      component - component

    • sendMessageLegacy

      @Obsolete default void sendMessageLegacy(String message)

    • claims

      default Set<FLocation> claims()

    • claimCount

      default int claimCount()

    • claimCount

      default int claimCount(org.bukkit.World world)

    • zones

      Faction.Zones zones()
      Gets the faction's zone controller.
      Returns:
      zones