Package dev.kitteh.factions

Interface FPlayer

All Superinterfaces:
Participator, Selectable
All Known Implementing Classes:
JSONFPlayer, MemoryFPlayer
@AvailableSince("4.0.0") @NonExtendable @NullMarked public interface FPlayer extends Participator, Selectable
Logged in players always have exactly one FPlayer instance. Logged out players may or may not have a stored FPlayer instance. They will always have one if they are part of a faction.

The FPlayer is linked to a minecraft player using the player name.

The same instance is always returned for the same player. This means you can use the == operator.

  • Method Details

    • uniqueId

      UUID uniqueId()

    • name

      String name()

    • faction

      Faction faction()

    • hasFaction

      boolean hasFaction()

    • faction

      void faction(Faction faction)

    • autoLeaveExempt

      boolean autoLeaveExempt()

    • autoLeaveExempt

      void autoLeaveExempt(boolean autoLeave)

    • lastFrostwalkerMessageTime

      long lastFrostwalkerMessageTime()

    • updateLastFrostwalkerMessageTime

      void updateLastFrostwalkerMessageTime()

    • monitorJoins

      void monitorJoins(boolean monitor)

    • monitorJoins

      boolean monitorJoins()

    • role

      Role role()

    • role

      void role(Role role)

    • takeFallDamage

      boolean takeFallDamage()

    • takeFallDamage

      void takeFallDamage(boolean fallDamage)

    • autoClaim

      @Nullable Faction autoClaim()

    • autoClaim

      void autoClaim(@Nullable Faction faction)

    • autoSetZone

      @Nullable String autoSetZone()

    • autoSetZone

      void autoSetZone(@Nullable String zone)

    • autoUnclaim

      @Nullable Faction autoUnclaim()

    • autoUnclaim

      void autoUnclaim(@Nullable Faction faction)

    • adminBypass

      boolean adminBypass()

    • adminBypass

      void adminBypass(boolean val)

    • isVanished

      boolean isVanished()

    • chatTarget

      ChatTarget chatTarget()

    • chatTarget

      void chatTarget(ChatTarget chatTarget)

    • ignoreAllianceChat

      void ignoreAllianceChat(boolean ignore)

    • ignoreAllianceChat

      boolean ignoreAllianceChat()

    • ignoreTruceChat

      void ignoreTruceChat(boolean ignore)

    • ignoreTruceChat

      boolean ignoreTruceChat()

    • spyingChat

      void spyingChat(boolean chatSpying)

    • spyingChat

      boolean spyingChat()

    • showScoreboard

      boolean showScoreboard()

    • showScoreboard

      void showScoreboard(boolean show)

    • resetFactionData

      void resetFactionData()

    • resetFactionData

      void resetFactionData(boolean updateCommands)

    • lastLogin

      long lastLogin()

    • mapAutoUpdating

      boolean mapAutoUpdating()

    • mapAutoUpdating

      void mapAutoUpdating(boolean mapAutoUpdating)

    • loginPVPDisabled

      boolean loginPVPDisabled()

    • lastStoodAt

      FLocation lastStoodAt()

    • lastStoodAt

      void lastStoodAt(FLocation flocation)

    • titleLegacy

      @Obsolete default String titleLegacy()

    • title

      net.kyori.adventure.text.Component title()

    • title

      void title(net.kyori.adventure.text.Component title)

    • nameWithTitle

      net.kyori.adventure.text.Component nameWithTitle()

    • nameWithTitleLegacy

      @Obsolete default String nameWithTitleLegacy()

    • nameWithTag

      net.kyori.adventure.text.Component nameWithTag()

    • nameWithTagLegacy

      @Obsolete default String nameWithTagLegacy()

    • kills

      int kills()

    • deaths

      int deaths()

    • power

      double power()

    • power

      void power(double power)

    • alterPower

      void alterPower(double delta)

    • powerMax

      double powerMax()

    • powerMin

      double powerMin()

    • powerRounded

      int powerRounded()

    • powerMaxRounded

      int powerMaxRounded()

    • powerMinRounded

      int powerMinRounded()

    • powerBoost

      double powerBoost()

    • powerBoost

      void powerBoost(double powerBoost)

    • updatePower

      void updatePower()

    • losePowerFromBeingOffline

      void losePowerFromBeingOffline()

    • onDeath

      void onDeath()

    • isInOwnTerritory

      boolean isInOwnTerritory()

    • isInOthersTerritory

      boolean isInOthersTerritory()

    • isInAllyTerritory

      boolean isInAllyTerritory()

    • isInNeutralTerritory

      boolean isInNeutralTerritory()

    • isInEnemyTerritory

      boolean isInEnemyTerritory()

    • sendFactionHereMessage

      void sendFactionHereMessage(Faction from)

    • leave

      void leave(boolean makePay)

    • canClaimForFaction

      boolean canClaimForFaction(Faction forFaction)

    • canClaimForFactionAtLocation

      boolean canClaimForFactionAtLocation(Faction forFaction, FLocation location, boolean notifyFailure)

    • attemptClaim

      boolean attemptClaim(Faction forFaction, org.bukkit.Location location, boolean notifyFailure)

    • attemptClaim

      boolean attemptClaim(Faction forFaction, FLocation location, boolean notifyFailure)

    • attemptUnclaim

      boolean attemptUnclaim(Faction forFaction, FLocation flocation, boolean notifyFailure)

    • attemptAutoSetZone

      void attemptAutoSetZone(FLocation flocation)

    • asPlayer

      @Nullable org.bukkit.entity.Player asPlayer()

    • isOnline

      boolean isOnline()

    • sendMessageLegacy

      @Obsolete void sendMessageLegacy(String message)

    • sendMessageLegacy

      @Obsolete void sendMessageLegacy(List<String> messages)

    • mapHeight

      int mapHeight()

    • mapHeight

      void mapHeight(int height)

    • eraseData

      void eraseData()

    • flightCheck

      void flightCheck()

    • flying

      boolean flying()

    • flying

      void flying(boolean fly)

    • flying

      void flying(boolean fly, boolean damage)

    • autoFlying

      boolean autoFlying()

    • autoFlying

      void autoFlying(boolean autoFly)

    • canFlyAtLocation

      default boolean canFlyAtLocation()

    • canFlyAtLocation

      boolean canFlyAtLocation(FLocation location)

    • seeChunk

      boolean seeChunk()

    • seeChunk

      void seeChunk(boolean seeingChunk)

    • flyTrail

      boolean flyTrail()

    • flyTrail

      void flyTrail(boolean state)

    • flyTrailEffect

      @Nullable String flyTrailEffect()

    • flyTrailEffect

      void flyTrailEffect(String effect)

    • warmingUp

      default boolean warmingUp()

    • warmup

      @Nullable WarmUpUtil.Warmup warmup()

    • addWarmup

      void addWarmup(WarmUpUtil.Warmup warmup, int taskId)

    • cancelWarmup

      void cancelWarmup()