Package com.plotsquared.core.plot

Class PlotWorld

java.lang.Object

com.plotsquared.core.plot.PlotWorld

Direct Known Subclasses:

ScatteredPlotWorld, StandardPlotWorld

public abstract class PlotWorld
extends Object

A world that contains plots

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PlotWorld(@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
protected boolean	canEqual(Object other)	Deprecated, for removal: This API element is subject to removal in a future version. This method is not meant to be invoked or overridden, with no replacement.
boolean	equals(Object o)
abstract @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.
abstract @NonNull Collection<PlotArea>	getAreas()	Get all plot areas in the world
abstract @NonNull Collection<PlotArea>	getAreasInRegion(@NonNull CuboidRegion region)	Get all plot areas in a specified region
String	getWorld()	Get the world name
int	hashCode()
void	removeArea(@NonNull PlotArea area)	Remove an area from the world

Methods inherited from class java.lang.Object

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

Constructor Details

PlotWorld

protected PlotWorld(@NonNull String world)

Create a new plot world with a given world name

Parameters:

world - World name

Method Details

getArea

public abstract @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.

Parameters:

location - Location

Returns:

Containing plot area, or null

getAreas

public abstract @NonNull Collection<PlotArea> getAreas()

Get all plot areas in the world

Returns:

All plot areas in the world

getAreasInRegion

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

Get all plot areas in a specified region

Parameters:

region - Region

Returns:

All areas in the region

addArea

public void addArea(@NonNull PlotArea area)

Register a new area in the world

Parameters:

area - Plot area

removeArea

public void removeArea(@NonNull PlotArea area)

Remove an area from the world

Parameters:

area - Plot area

getWorld

public String getWorld()

Get the world name

Returns:

World name

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

canEqual

@Deprecated(forRemoval=true,
            since="6.6.0")
protected boolean canEqual(Object other)

Deprecated, for removal: This API element is subject to removal in a future version.

This method is not meant to be invoked or overridden, with no replacement.