Package com.plotsquared.core.events

Class PlayerBuyPlotEvent

java.lang.Object

com.plotsquared.core.events.PlotEvent

com.plotsquared.core.events.PlotPlayerEvent

com.plotsquared.core.events.PlayerBuyPlotEvent

All Implemented Interfaces:

CancellablePlotEvent

public class PlayerBuyPlotEvent
extends PlotPlayerEvent
implements CancellablePlotEvent

Called when a user attempts to buy a plot.

Setting the Result to Result.FORCE ignores the price and players account balance and does not charge the player anything. Result.DENY blocks the purchase completely, Result.ACCEPT and null do not modify the behaviour.

Setting the price to 0 makes the plot practically free.

Since:

7.3.2

Constructor Summary

Constructors

Constructor	Description
PlayerBuyPlotEvent(PlotPlayer<?> plotPlayer, Plot plot, @org.checkerframework.checker.index.qual.NonNegative double price)

Method Summary

Modifier and Type	Method	Description
@Nullable Result	getEventResult()	The currently set Result for this event (as set by potential previous event listeners).
@org.checkerframework.checker.index.qual.NonNegative double	price()	Returns the currently set price required to buy the plot.
void	setEventResult(@Nullable Result eventResult)	Set the Result for this event.
void	setPrice(@org.checkerframework.checker.index.qual.NonNegative double price)	Sets the price required to buy the plot.

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

getPlotPlayer

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

getEventName, getPlot

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

PlayerBuyPlotEvent

public PlayerBuyPlotEvent(PlotPlayer<?> plotPlayer,
 Plot plot,
 @org.checkerframework.checker.index.qual.NonNegative double price)

Method Details

setPrice

public void setPrice(@org.checkerframework.checker.index.qual.NonNegative double price)

Sets the price required to buy the plot.

Parameters:

price - the new price.

Since:

7.3.2

price

public @org.checkerframework.checker.index.qual.NonNegative double price()

Returns the currently set price required to buy the plot.

Returns:

the price.

Since:

7.3.2

setEventResult

public void setEventResult(@Nullable Result eventResult)

Set the Result for this event.

Specified by:

setEventResult in interface CancellablePlotEvent

Parameters:

eventResult - the new result.

getEventResult

public @Nullable Result getEventResult()

The currently set Result for this event (as set by potential previous event listeners).

Specified by:

getEventResult in interface CancellablePlotEvent

Returns:

the current result.