Package com.plotsquared.core.plot.world

Class ScatteredPlotWorld

java.lang.Object

com.plotsquared.core.plot.PlotWorld

com.plotsquared.core.plot.world.ScatteredPlotWorld

public class ScatteredPlotWorld
extends PlotWorld

Plot world that contains several plot areas (clusters)

Constructor Summary

Constructors

Constructor	Description
ScatteredPlotWorld(@NonNull String world)	Create a new plot world with a given world name

Method Summary

Modifier and Type	Method	Description
void	addArea(@NonNull PlotArea area)	Register a new area in the world
@Nullable PlotArea	getArea(@NonNull Location location)	Get the plot area that contains the given location, or null if the location is not a part of a plot area.
@NonNull Collection<PlotArea>	getAreas()	Get all plot areas in the world
@NonNull Collection<PlotArea>	getAreasInRegion(@NonNull CuboidRegion region)	Get all plot areas in a specified region
void	removeArea(@NonNull PlotArea area)	Remove an area from the world

Methods inherited from class com.plotsquared.core.plot.PlotWorld

canEqual, equals, getWorld, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScatteredPlotWorld

public ScatteredPlotWorld(@NonNull String world)

Create a new plot world with a given world name

Parameters:

world - World name

Method Details

getArea

public @Nullable PlotArea getArea(@NonNull Location location)

Description copied from class: PlotWorld

Get the plot area that contains the given location, or null if the location is not a part of a plot area.

Specified by:

getArea in class PlotWorld

Parameters:

location - Location

Returns:

Containing plot area, or null

getAreas

public @NonNull Collection<PlotArea> getAreas()

Description copied from class: PlotWorld

Get all plot areas in the world

Specified by:

getAreas in class PlotWorld

Returns:

All plot areas in the world

addArea

public void addArea(@NonNull PlotArea area)

Description copied from class: PlotWorld

Register a new area in the world

Overrides:

addArea in class PlotWorld

Parameters:

area - Plot area

removeArea

public void removeArea(@NonNull PlotArea area)

Description copied from class: PlotWorld

Remove an area from the world

Overrides:

removeArea in class PlotWorld

Parameters:

area - Plot area

getAreasInRegion

public @NonNull Collection<PlotArea> getAreasInRegion(@NonNull CuboidRegion region)

Description copied from class: PlotWorld

Get all plot areas in a specified region

Specified by:

getAreasInRegion in class PlotWorld

Parameters:

region - Region

Returns:

All areas in the region