# Faction
Date: 2018-12-06

com.massivecraft.factions

## Interface Faction

All Superinterfaces:
  EconomyParticipator, RelationParticipator

All Known Implementing Classes:
  JSONFaction, MemoryFaction

    public interface Faction
    extends EconomyParticipator

### Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
`void` `addAnnouncement(FPlayer fPlayer, java.lang.String msg)`
`boolean` `addFPlayer(FPlayer fplayer)`
`void` `addRule(java.lang.String rule)`
`void` `addTnt(int amt)`
`void` `ban(FPlayer target, FPlayer banner)`
`void` `clearAllClaimOwnership()`
`void` `clearClaimOwnership(FLocation loc)`
`void` `clearClaimOwnership(FPlayer player)`
`void` `clearRules()`
`void` `clearWarps()`
`void` `confirmValidHome()`
`void` `deinvite(FPlayer fplayer)`
`java.lang.String` `describeTo(RelationParticipator that)`
`java.lang.String` `describeTo(RelationParticipator that, boolean ucfirst)`
`void` `disband(org.bukkit.entity.Player disbander)`
`boolean` `doesLocationHaveOwnersSet(FLocation loc)`
`Access` `getAccess(FPlayer player, PermissableAction permissableAction)`
`Access` `getAccess(Permissable permissable, PermissableAction permissableAction)`
`java.lang.String` `getAccountId()`
`java.util.Set<FLocation>` `getAllClaims()`
`java.util.HashMap<java.lang.String,java.util.List<java.lang.String>>` `getAnnouncements()`
`java.util.Set<BanInfo>` `getBannedPlayers()`
`org.bukkit.inventory.ItemStack` `getBanner()`
`org.bukkit.Location` `getCheckpoint()`
`org.bukkit.inventory.Inventory` `getChestInventory()`
`java.util.Map<FLocation,java.util.Set<java.lang.String>>` `getClaimOwnership()`
`org.bukkit.ChatColor` `getColorTo(RelationParticipator rp)`
`java.lang.String` `getComparisonTag()`
`int` `getCountOfClaimsWithOwners()`
`int` `getDeaths()`
`Role` `getDefaultRole()`
`java.lang.String` `getDescription()`
`java.lang.String` `getFocused()`
`long` `getFoundedDate()`
`FPlayer` `getFPlayerAdmin()`
`java.util.Set<FPlayer>` `getFPlayers()`
`java.util.Set<FPlayer>` `getFPlayersWhereOnline(boolean online)`
`java.util.Set<FPlayer>` `getFPlayersWhereOnline(boolean online, FPlayer viewer)`
`java.util.ArrayList<FPlayer>` `getFPlayersWhereRole(Role role)`
`org.bukkit.Location` `getHome()`
`java.lang.String` `getId()`
`java.util.Set<java.lang.String>` `getInvites()`
`int` `getKills()`
`int` `getLandRounded()`
`int` `getLandRoundedInWorld(java.lang.String worldName)`
`int` `getMaxVaults()`
`java.util.ArrayList<org.bukkit.entity.Player>` `getOnlinePlayers()`
`boolean` `getOpen()`
`java.util.Set<java.lang.String>` `getOwnerList(FLocation loc)`
`java.lang.String` `getOwnerListString(FLocation loc)`
`java.lang.String` `getPaypal()`
`boolean` `getPeacefulExplosionsEnabled()`
`java.lang.Integer` `getPermanentPower()`
`java.util.Map<Permissable,java.util.Map<PermissableAction,Access>>` `getPermissions()`
`double` `getPower()`
`double` `getPowerBoost()`
`double` `getPowerMax()`
`int` `getPowerMaxRounded()`
`int` `getPowerRounded()`
`int` `getRelationCount(Relation relation)`
`Relation` `getRelationTo(RelationParticipator rp)`
`Relation` `getRelationTo(RelationParticipator rp, boolean ignorePeaceful)`
`Relation` `getRelationWish(Faction otherFaction)`
`java.lang.String` `getRule(int index)`
`java.util.HashMap<java.lang.Integer,java.lang.String>` `getRulesMap()`
`int` `getSize()`
`java.lang.String` `getTag()`
`java.lang.String` `getTag(Faction otherFaction)`
`java.lang.String` `getTag(FPlayer otherFplayer)`
`java.lang.String` `getTag(java.lang.String prefix)`
`int` `getTnt()`
`int` `getUpgrade(java.lang.String key)`
`org.bukkit.Location` `getVault()`
`LazyLocation` `getWarp(java.lang.String name)`
`java.util.concurrent.ConcurrentHashMap<java.lang.String,LazyLocation>` `getWarps()`
`boolean` `hasHome()`
`boolean` `hasLandInflation()`
`boolean` `hasPermanentPower()`
`boolean` `hasPlayersOnline()`
`boolean` `hasWarpPassword(java.lang.String warp)`
`void` `invite(FPlayer fplayer)`
`boolean` `isBanned(FPlayer player)`
`boolean` `isInvited(FPlayer fplayer)`
`boolean` `isNone()` Deprecated.
`boolean` `isNormal()`
`boolean` `isPeaceful()`
`boolean` `isPermanent()`
`boolean` `isPlayerFreeType()`
`boolean` `isPlayerInOwnerList(FPlayer player, FLocation loc)`
`boolean` `isPowerFrozen()`
`boolean` `isSafeZone()`
`boolean` `isWarp(java.lang.String name)`
`boolean` `isWarpPassword(java.lang.String warp, java.lang.String password)`
`boolean` `isWarZone()`
`boolean` `isWilderness()`
`void` `memberLoggedOff()`
`void` `msg(java.lang.String message, java.lang.Object... args)`
`boolean` `noExplosionsInTerritory()`
`boolean` `noMonstersInTerritory()`
`boolean` `noPvPInTerritory()`
`void` `paypalSet(java.lang.String paypal)`
`boolean` `playerHasOwnershipRights(FPlayer fplayer, FLocation loc)`
`void` `promoteNewLeader()`
`void` `refreshFPlayers()`
`void` `remove()`
`void` `removeAnnouncements(FPlayer fPlayer)`
`boolean` `removeFPlayer(FPlayer fplayer)`
`void` `removePlayerAsOwner(FPlayer player, FLocation loc)`
`void` `removeRule(int index)`
`boolean` `removeWarp(java.lang.String name)`
`void` `resetPerms()`
`void` `sendMessage(java.util.List<java.lang.String> messages)`
`void` `sendMessage(java.lang.String message)`
`void` `sendUnreadAnnouncements(FPlayer fPlayer)`
`void` `setBannerPattern(org.bukkit.inventory.ItemStack banner)`
`void` `setCheckpoint(org.bukkit.Location location)`
`void` `setChestSize(int chestSize)`
`void` `setDefaultRole(Role role)`
`void` `setDescription(java.lang.String value)`
`void` `setFocused(java.lang.String setFocused)`
`void` `setFoundedDate(long newDate)`
`void` `setHome(org.bukkit.Location home)`
`void` `setId(java.lang.String id)`
`void` `setLastDeath(long time)`
`void` `setMaxVaults(int value)`
`void` `setOpen(boolean isOpen)`
`void` `setPeaceful(boolean isPeaceful)`
`void` `setPeacefulExplosionsEnabled(boolean val)`
`void` `setPermanent(boolean isPermanent)`
`void` `setPermanentPower(java.lang.Integer permanentPower)`
`void` `setPermission(Permissable permissable, PermissableAction permissableAction, Access access)`
`void` `setPlayerAsOwner(FPlayer player, FLocation loc)`
`void` `setPowerBoost(double powerBoost)`
`void` `setRelationWish(Faction otherFaction, Relation relation)`
`void` `setRule(int index, java.lang.String rule)`
`void` `setTag(java.lang.String str)`
`void` `setUpgrades(java.lang.String key, int level)`
`void` `setVault(org.bukkit.Location vaultLocation)`
`void` `setWarp(java.lang.String name, LazyLocation loc)`
`void` `setWarpPassword(java.lang.String warp, java.lang.String password)`
`void` `takeTnt(int amt)`
`void` `unban(FPlayer player)`

### Methods inherited from interface com.massivecraft.factions.iface.EconomyParticipator

`msg`

### Method Detail

#### getAnnouncements

    java.util.HashMap<java.lang.String,java.util.List<java.lang.String>> getAnnouncements()

#### getWarps

    java.util.concurrent.ConcurrentHashMap<java.lang.String,LazyLocation> getWarps()

#### getWarp

    LazyLocation getWarp(java.lang.String name)

#### setWarp

    void setWarp(java.lang.String name,
                 LazyLocation loc)

#### isWarp

    boolean isWarp(java.lang.String name)

#### hasWarpPassword

    boolean hasWarpPassword(java.lang.String warp)

#### isWarpPassword

    boolean isWarpPassword(java.lang.String warp,
                           java.lang.String password)

#### setWarpPassword

    void setWarpPassword(java.lang.String warp,
                         java.lang.String password)

#### removeWarp

    boolean removeWarp(java.lang.String name)

#### clearWarps

    void clearWarps()

#### getMaxVaults

    int getMaxVaults()

#### setMaxVaults

    void setMaxVaults(int value)

#### addAnnouncement

    void addAnnouncement(FPlayer fPlayer,
                         java.lang.String msg)

#### sendUnreadAnnouncements

    void sendUnreadAnnouncements(FPlayer fPlayer)

#### removeAnnouncements

    void removeAnnouncements(FPlayer fPlayer)

#### getInvites

    java.util.Set<java.lang.String> getInvites()

#### getFocused

    java.lang.String getFocused()

#### setFocused

    void setFocused(java.lang.String setFocused)

#### getId

    java.lang.String getId()

#### setId

    void setId(java.lang.String id)

#### invite

    void invite(FPlayer fplayer)

#### deinvite

    void deinvite(FPlayer fplayer)

#### setUpgrades

    void setUpgrades(java.lang.String key,
                     int level)

#### getUpgrade

    int getUpgrade(java.lang.String key)

#### isInvited

    boolean isInvited(FPlayer fplayer)

#### ban

    void ban(FPlayer target,
             FPlayer banner)

#### unban

    void unban(FPlayer player)

#### isBanned

    boolean isBanned(FPlayer player)

#### getBannedPlayers

    java.util.Set<BanInfo> getBannedPlayers()

#### getRulesMap

    java.util.HashMap<java.lang.Integer,java.lang.String> getRulesMap()

#### setRule

    void setRule(int index,
                 java.lang.String rule)

#### addRule

    void addRule(java.lang.String rule)

#### removeRule

    void removeRule(int index)

#### clearRules

    void clearRules()

#### getCheckpoint

    org.bukkit.Location getCheckpoint()

#### setCheckpoint

    void setCheckpoint(org.bukkit.Location location)

#### addTnt

    void addTnt(int amt)

#### takeTnt

    void takeTnt(int amt)

#### getVault

    org.bukkit.Location getVault()

#### setVault

    void setVault(org.bukkit.Location vaultLocation)

#### getChestInventory

    org.bukkit.inventory.Inventory getChestInventory()

#### setChestSize

    void setChestSize(int chestSize)

#### setBannerPattern

    void setBannerPattern(org.bukkit.inventory.ItemStack banner)

#### getBanner

    org.bukkit.inventory.ItemStack getBanner()

#### getTnt

    int getTnt()

#### getRule

    java.lang.String getRule(int index)

#### getOpen

    boolean getOpen()

#### setOpen

    void setOpen(boolean isOpen)

#### isPeaceful

    boolean isPeaceful()

#### setPeaceful

    void setPeaceful(boolean isPeaceful)

#### getPeacefulExplosionsEnabled

    boolean getPeacefulExplosionsEnabled()

#### setPeacefulExplosionsEnabled

    void setPeacefulExplosionsEnabled(boolean val)

#### noExplosionsInTerritory

    boolean noExplosionsInTerritory()

#### isPermanent

    boolean isPermanent()

#### setPermanent

    void setPermanent(boolean isPermanent)

#### getTag

    java.lang.String getTag()

#### setTag

    void setTag(java.lang.String str)

#### getTag

    java.lang.String getTag(java.lang.String prefix)

#### getTag

    java.lang.String getTag(Faction otherFaction)

#### getTag

    java.lang.String getTag(FPlayer otherFplayer)

#### getComparisonTag

    java.lang.String getComparisonTag()

#### getDescription

    java.lang.String getDescription()

#### setDescription

    void setDescription(java.lang.String value)

#### hasHome

    boolean hasHome()

#### getHome

    org.bukkit.Location getHome()

#### setHome

    void setHome(org.bukkit.Location home)

#### getFoundedDate

    long getFoundedDate()

#### setFoundedDate

    void setFoundedDate(long newDate)

#### confirmValidHome

    void confirmValidHome()

#### getAccountId

    java.lang.String getAccountId()

Specified by:
  `getAccountId` in interface `EconomyParticipator`

#### getPermanentPower

    java.lang.Integer getPermanentPower()

#### setPermanentPower

    void setPermanentPower(java.lang.Integer permanentPower)

#### hasPermanentPower

    boolean hasPermanentPower()

#### getPowerBoost

    double getPowerBoost()

#### setPowerBoost

    void setPowerBoost(double powerBoost)

#### noPvPInTerritory

    boolean noPvPInTerritory()

#### noMonstersInTerritory

    boolean noMonstersInTerritory()

#### isNormal

    boolean isNormal()

#### isNone

    @Deprecated
    boolean isNone()

Deprecated.

#### isWilderness

    boolean isWilderness()

#### isSafeZone

    boolean isSafeZone()

#### isWarZone

    boolean isWarZone()

#### isPlayerFreeType

    boolean isPlayerFreeType()

#### isPowerFrozen

    boolean isPowerFrozen()

#### setLastDeath

    void setLastDeath(long time)

#### getKills

    int getKills()

#### getDeaths

    int getDeaths()

#### getAccess

    Access getAccess(Permissable permissable,
                     PermissableAction permissableAction)

#### getAccess

    Access getAccess(FPlayer player,
                     PermissableAction permissableAction)

#### setPermission

    void setPermission(Permissable permissable,
                       PermissableAction permissableAction,
                       Access access)

#### resetPerms

    void resetPerms()

#### disband

    void disband(org.bukkit.entity.Player disbander)

#### getPermissions

    java.util.Map<Permissable,java.util.Map<PermissableAction,Access>> getPermissions()

#### describeTo

    java.lang.String describeTo(RelationParticipator that,
                                boolean ucfirst)

Specified by:
  `describeTo` in interface `RelationParticipator`

#### describeTo

    java.lang.String describeTo(RelationParticipator that)

Specified by:
  `describeTo` in interface `RelationParticipator`

#### getRelationTo

    Relation getRelationTo(RelationParticipator rp)

Specified by:
  `getRelationTo` in interface `RelationParticipator`

#### getRelationTo

    Relation getRelationTo(RelationParticipator rp,
                           boolean ignorePeaceful)

Specified by:
  `getRelationTo` in interface `RelationParticipator`

#### getColorTo

    org.bukkit.ChatColor getColorTo(RelationParticipator rp)

Specified by:
  `getColorTo` in interface `RelationParticipator`

#### getRelationWish

    Relation getRelationWish(Faction otherFaction)

#### setRelationWish

    void setRelationWish(Faction otherFaction,
                         Relation relation)

#### getRelationCount

    int getRelationCount(Relation relation)

#### getPower

    double getPower()

#### getPowerMax

    double getPowerMax()

#### getPowerRounded

    int getPowerRounded()

#### getPowerMaxRounded

    int getPowerMaxRounded()

#### getLandRounded

    int getLandRounded()

#### getLandRoundedInWorld

    int getLandRoundedInWorld(java.lang.String worldName)

#### hasLandInflation

    boolean hasLandInflation()

#### refreshFPlayers

    void refreshFPlayers()

#### addFPlayer

    boolean addFPlayer(FPlayer fplayer)

#### removeFPlayer

    boolean removeFPlayer(FPlayer fplayer)

#### getSize

    int getSize()

#### getFPlayers

    java.util.Set<FPlayer> getFPlayers()

#### getFPlayersWhereOnline

    java.util.Set<FPlayer> getFPlayersWhereOnline(boolean online)

#### getFPlayersWhereOnline

    java.util.Set<FPlayer> getFPlayersWhereOnline(boolean online,
                                                  FPlayer viewer)

#### getFPlayerAdmin

    FPlayer getFPlayerAdmin()

#### getFPlayersWhereRole

    java.util.ArrayList<FPlayer> getFPlayersWhereRole(Role role)

#### getOnlinePlayers

    java.util.ArrayList<org.bukkit.entity.Player> getOnlinePlayers()

#### hasPlayersOnline

    boolean hasPlayersOnline()

#### memberLoggedOff

    void memberLoggedOff()

#### promoteNewLeader

    void promoteNewLeader()

#### getDefaultRole

    Role getDefaultRole()

#### setDefaultRole

    void setDefaultRole(Role role)

#### msg

    void msg(java.lang.String message,
             java.lang.Object... args)

Specified by:
  `msg` in interface `EconomyParticipator`

#### sendMessage

    void sendMessage(java.lang.String message)

#### sendMessage

    void sendMessage(java.util.List<java.lang.String> messages)

#### getClaimOwnership

    java.util.Map<FLocation,java.util.Set<java.lang.String>> getClaimOwnership()

#### clearAllClaimOwnership

    void clearAllClaimOwnership()

#### clearClaimOwnership

    void clearClaimOwnership(FLocation loc)

#### clearClaimOwnership

    void clearClaimOwnership(FPlayer player)

#### getCountOfClaimsWithOwners

    int getCountOfClaimsWithOwners()

#### doesLocationHaveOwnersSet

    boolean doesLocationHaveOwnersSet(FLocation loc)

#### isPlayerInOwnerList

    boolean isPlayerInOwnerList(FPlayer player,
                                FLocation loc)

#### setPlayerAsOwner

    void setPlayerAsOwner(FPlayer player,
                          FLocation loc)

#### removePlayerAsOwner

    void removePlayerAsOwner(FPlayer player,
                             FLocation loc)

#### getOwnerList

    java.util.Set<java.lang.String> getOwnerList(FLocation loc)

#### getOwnerListString

    java.lang.String getOwnerListString(FLocation loc)

#### playerHasOwnershipRights

    boolean playerHasOwnershipRights(FPlayer fplayer,
                                     FLocation loc)

#### remove

    void remove()

#### getAllClaims

    java.util.Set<FLocation> getAllClaims()

#### getPaypal

    java.lang.String getPaypal()

#### paypalSet

    void paypalSet(java.lang.String paypal)