Package dev.kitteh.factions

Interface Board

All Known Implementing Classes:

JSONBoard, MemoryBoard

@AvailableSince("4.0.0")
@NonExtendable
@NullMarked
public interface Board

Method Summary

Modifier and Type	Method	Description
Set<FLocation>	allClaims(Faction faction)
static Board	board()
void	claim(FLocation flocation, Faction faction)
int	claimCount(Faction faction)
int	claimCount(Faction faction, org.bukkit.World world)
Faction	factionAt(FLocation flocation)
default boolean	hasFactionWithin(FLocation flocation, Faction faction, int radius)	Checks if there is another faction within a given radius other than Wilderness.
default boolean	isBorderLocation(FLocation flocation)
default boolean	isConnectedLocation(FLocation flocation, Faction faction)
default boolean	isDisconnectedLocation(FLocation flocation, Faction faction)
void	unclaim(FLocation flocation)
void	unclaimAll(Faction faction)
void	unclaimAllInWorld(Faction faction, org.bukkit.World world)

Method Details

board

static Board board()

factionAt

Faction factionAt(FLocation flocation)

claim

void claim(FLocation flocation,
 Faction faction)

allClaims

Set<FLocation> allClaims(Faction faction)

unclaim

void unclaim(FLocation flocation)

unclaimAll

void unclaimAll(Faction faction)

unclaimAllInWorld

void unclaimAllInWorld(Faction faction,
 org.bukkit.World world)

isBorderLocation

default boolean isBorderLocation(FLocation flocation)

isConnectedLocation

default boolean isConnectedLocation(FLocation flocation,
 Faction faction)

isDisconnectedLocation

default boolean isDisconnectedLocation(FLocation flocation,
 Faction faction)

hasFactionWithin

default boolean hasFactionWithin(FLocation flocation,
 Faction faction,
 int radius)

Checks if there is another faction within a given radius other than Wilderness. Used for HCF feature that requires a 'buffer' between factions.

Parameters:

flocation - - center location.

faction - - faction checking for.

radius - - chunk radius to check.

Returns:

true if another Faction is within the radius, otherwise false.

claimCount

int claimCount(Faction faction)

claimCount

int claimCount(Faction faction,
 org.bukkit.World world)