Package com.plotsquared.core.events

Class PlayerTeleportToPlotEvent

java.lang.Object

com.plotsquared.core.events.PlotEvent

com.plotsquared.core.events.PlotPlayerEvent

com.plotsquared.core.events.PlayerTeleportToPlotEvent

All Implemented Interfaces:

CancellablePlotEvent

public class PlayerTeleportToPlotEvent
extends PlotPlayerEvent
implements CancellablePlotEvent

Called when a player teleports to a plot

Constructor Summary

Constructors

Constructor	Description
PlayerTeleportToPlotEvent(PlotPlayer<?> player, Location from, Plot plot, TeleportCause cause)	PlayerTeleportToPlotEvent: Called when a player teleports to a plot

Method Summary

Modifier and Type	Method	Description
TeleportCause	getCause()	Get the teleport cause
Result	getEventResult()	The currently set Result for this event (as set by potential previous event listeners).
Location	getFrom()	Get the location, from where the teleport was triggered (the players current location when executing the home command for example)
@Nullable UnaryOperator<Location>	getLocationTransformer()	Gets the currently applied transformer or null, if none was set
void	setEventResult(Result e)	Set the Result for this event.
void	setLocationTransformer(@Nullable UnaryOperator<Location> locationTransformer)	Sets the transformer to mutate the location where the player will be teleported to.

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

PlayerTeleportToPlotEvent

public PlayerTeleportToPlotEvent(PlotPlayer<?> player,
 Location from,
 Plot plot,
 TeleportCause cause)

PlayerTeleportToPlotEvent: Called when a player teleports to a plot

Parameters:

player - That was teleported

from - The origin location, from where the teleport was triggered (players location most likely)

plot - Plot to which the player was teleported

cause - Why the teleport is being completed

Since:

6.1.0

Method Details

getCause

public TeleportCause getCause()

Get the teleport cause

Returns:

TeleportCause

Since:

6.1.0

getFrom

public Location getFrom()

Get the location, from where the teleport was triggered (the players current location when executing the home command for example)

Returns:

Location

getLocationTransformer

public @Nullable UnaryOperator<Location> getLocationTransformer()

Gets the currently applied transformer or null, if none was set

Returns:

LocationTransformer

Since:

7.2.1

setLocationTransformer

public void setLocationTransformer(@Nullable UnaryOperator<Location> locationTransformer)

Sets the transformer to mutate the location where the player will be teleported to. May be null, if any previous set transformations should be discarded.

Parameters:

locationTransformer - The new transformer

Since:

7.2.1

getEventResult

public Result getEventResult()

Description copied from interface: CancellablePlotEvent

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

Specified by:

getEventResult in interface CancellablePlotEvent

Returns:

the current result.

setEventResult

public void setEventResult(Result e)

Description copied from interface: CancellablePlotEvent

Set the Result for this event.

Specified by:

setEventResult in interface CancellablePlotEvent

Parameters:

e - the new result.