Package com.plotsquared.core.events

Class PlayerAutoPlotEvent

java.lang.Object

com.plotsquared.core.events.PlotEvent

com.plotsquared.core.events.PlayerAutoPlotEvent

All Implemented Interfaces:

CancellablePlotEvent

public class PlayerAutoPlotEvent
extends PlotEvent
implements CancellablePlotEvent

PlayerAutoPlotEvent returns null for PlotEvent.getPlot() as the event is fired before the plot is chosen.

Constructor Summary

Constructors

Constructor	Description
PlayerAutoPlotEvent(PlotPlayer<?> player, PlotArea plotArea, @Nullable String schematic, int sizeX, int sizeZ)	PlayerAutoPlotEvent: called when a player attempts to auto claim a plot.

Method Summary

Modifier and Type	Method	Description
Result	getEventResult()
PlotPlayer<?>	getPlayer()
@Nullable Plot	getPlot()	Returns null as the plots to be claimed haven't been chosen yet.
PlotArea	getPlotArea()
@Nullable String	getSchematic()	Obtain the schematic string as used by the Claim command or null.
int	getSize_x()	Deprecated, for removal: This API element is subject to removal in a future version. for removal.
int	getSize_z()	Deprecated, for removal: This API element is subject to removal in a future version. for removal.
int	getSizeX()	Get the x size of the auto-area
int	getSizeZ()	Get the z size of the auto-area
void	setEventResult(Result e)
void	setSchematic(String schematic)	Set the schematic string used in the claim.
void	setSize_x(int sizeX)	Deprecated, for removal: This API element is subject to removal in a future version. for removal.
void	setSize_z(int sizeZ)	Deprecated, for removal: This API element is subject to removal in a future version. for removal.
void	setSizeX(int sizeX)	Set the x size of the auto-area
void	setSizeZ(int sizeZ)	Set the z size of the auto-area

Methods inherited from class com.plotsquared.core.events.PlotEvent

getEventName

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plotsquared.core.events.CancellablePlotEvent

getEventResultRaw

Constructor Details

PlayerAutoPlotEvent

public PlayerAutoPlotEvent(PlotPlayer<?> player,
 PlotArea plotArea,
 @Nullable String schematic,
 int sizeX,
 int sizeZ)

PlayerAutoPlotEvent: called when a player attempts to auto claim a plot.

Parameters:

player - The player attempting to auto claim

plotArea - The applicable plot area

schematic - The schematic defined or null

sizeX - The size of the auto area

sizeZ - The size of the auto area

Method Details

getPlot

public @Nullable Plot getPlot()

Returns null as the plots to be claimed haven't been chosen yet. This will depend on the size of the auto (setSizeX(int) and setSizeZ(int)). To see which plots have been chosen, see PlayerAutoPlotsChosenEvent.

Overrides:

getPlot in class PlotEvent

Returns:

null

getSchematic

public @Nullable String getSchematic()

Obtain the schematic string as used by the Claim command or null.

Returns:

schematic string

setSchematic

public void setSchematic(String schematic)

Set the schematic string used in the claim.

Parameters:

schematic - the schematic name

getEventResult

public Result getEventResult()

Specified by:

getEventResult in interface CancellablePlotEvent

setEventResult

public void setEventResult(Result e)

Specified by:

setEventResult in interface CancellablePlotEvent

getPlayer

public PlotPlayer<?> getPlayer()

getPlotArea

public PlotArea getPlotArea()

getSize_x

@Deprecated(forRemoval=true,
            since="6.1.0")
public int getSize_x()

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

for removal. Use getSizeX()

setSize_x

@Deprecated(forRemoval=true,
            since="6.1.0")
public void setSize_x(int sizeX)

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

for removal. Use setSizeX(int)

getSize_z

@Deprecated(forRemoval=true,
            since="6.1.0")
public int getSize_z()

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

for removal. Use getSizeZ()

setSize_z

@Deprecated(forRemoval=true,
            since="6.1.0")
public void setSize_z(int sizeZ)

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

for removal. Use setSizeZ(int)

getSizeX

public int getSizeX()

Get the x size of the auto-area

Returns:

x size

Since:

6.1.0

setSizeX

public void setSizeX(int sizeX)

Set the x size of the auto-area

Parameters:

sizeX - x size

Since:

6.1.0

getSizeZ

public int getSizeZ()

Get the z size of the auto-area

Returns:

z size

Since:

6.1.0

setSizeZ

public void setSizeZ(int sizeZ)

Set the z size of the auto-area

Parameters:

sizeZ - z size

Since:

6.1.0