Package org.bukkit.event.player
Class PlayerPortalEvent
java.lang.Object
org.bukkit.event.Event
org.bukkit.event.player.PlayerEvent
org.bukkit.event.player.PlayerMoveEvent
org.bukkit.event.player.PlayerTeleportEvent
org.bukkit.event.player.PlayerPortalEvent
- All Implemented Interfaces:
Cancellable
Called when a player is about to teleport because it is in contact with a
portal which will generate an exit portal.
For other entities see EntityPortalEvent
-
Nested Class Summary
Nested classes/interfaces inherited from class org.bukkit.event.player.PlayerTeleportEvent
PlayerTeleportEvent.TeleportCause
Nested classes/interfaces inherited from class org.bukkit.event.Event
Event.Result
-
Field Summary
Fields inherited from class org.bukkit.event.player.PlayerEvent
player
-
Constructor Summary
ConstructorDescriptionPlayerPortalEvent
(@NotNull Player player, @NotNull Location from, @Nullable Location to, @NotNull PlayerTeleportEvent.TeleportCause cause) PlayerPortalEvent
(@NotNull Player player, @NotNull Location from, @Nullable Location to, @NotNull PlayerTeleportEvent.TeleportCause cause, int getSearchRadius, boolean canCreatePortal, int creationRadius) -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns whether the server will attempt to create a destination portal or not.int
Gets the maximum radius the world is searched for a free space from the given location.static @NotNull HandlerList
Deprecated.No effectint
Gets the search radius value for finding an available portal.getTo()
ForPlayerTeleportEvent.TeleportCause.NETHER_PORTAL
, this is initially just the starting point for the search for a portal to teleport to.void
setCanCreatePortal
(boolean canCreatePortal) Sets whether the server should attempt to create a destination portal or not.void
setCreationRadius
(int creationRadius) Sets the maximum radius the world is searched for a free space from the given location.void
setSearchRadius
(int searchRadius) Set the Block radius to search in for available portals.void
See the description ofgetTo()
.boolean
Deprecated.No effectMethods inherited from class org.bukkit.event.player.PlayerTeleportEvent
getCause
Methods inherited from class org.bukkit.event.player.PlayerMoveEvent
getFrom, hasChangedBlock, hasChangedOrientation, hasChangedPosition, hasExplicitlyChangedBlock, hasExplicitlyChangedPosition, isCancelled, setCancelled, setFrom
Methods inherited from class org.bukkit.event.player.PlayerEvent
getPlayer
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
PlayerPortalEvent
-
PlayerPortalEvent
-
PlayerPortalEvent
-
-
Method Details
-
getTo
ForPlayerTeleportEvent.TeleportCause.NETHER_PORTAL
, this is initially just the starting point for the search for a portal to teleport to. It will initially just be thePlayerMoveEvent.getFrom()
scaled for dimension scaling and clamped to be inside the world border.For
PlayerTeleportEvent.TeleportCause.END_PORTAL
, this will initially be the exact destination either, the world spawn for end->any world or end spawn for any world->end.- Overrides:
getTo
in classPlayerMoveEvent
- Returns:
- starting point for search or exact destination
-
setTo
See the description ofgetTo()
.- Overrides:
setTo
in classPlayerMoveEvent
- Parameters:
to
- starting point for search or exact destination
-
willDismountPlayer
Deprecated.No effectNo effect- Overrides:
willDismountPlayer
in classPlayerTeleportEvent
- Returns:
- no effect
-
getRelativeTeleportationFlags
Deprecated.No effectNo effect- Overrides:
getRelativeTeleportationFlags
in classPlayerTeleportEvent
- Returns:
- no effect
-
setSearchRadius
public void setSearchRadius(int searchRadius) Set the Block radius to search in for available portals.- Parameters:
searchRadius
- the radius in which to search for a portal from the location
-
getSearchRadius
public int getSearchRadius()Gets the search radius value for finding an available portal.- Returns:
- the currently set search radius
-
getCanCreatePortal
public boolean getCanCreatePortal()Returns whether the server will attempt to create a destination portal or not.- Returns:
- whether there should create be a destination portal created
-
setCanCreatePortal
public void setCanCreatePortal(boolean canCreatePortal) Sets whether the server should attempt to create a destination portal or not.- Parameters:
canCreatePortal
- Sets whether there should be a destination portal created
-
setCreationRadius
public void setCreationRadius(int creationRadius) Sets the maximum radius the world is searched for a free space from the given location. If enough free space is found then the portal will be created there, if not it will force create with air-space at the target location. Does not apply to end portal target platforms which will always appear at the target location.- Parameters:
creationRadius
- the radius in which to create a portal from the location
-
getCreationRadius
public int getCreationRadius()Gets the maximum radius the world is searched for a free space from the given location. If enough free space is found then the portal will be created there, if not it will force create with air-space at the target location. Does not apply to end portal target platforms which will always appear at the target location.- Returns:
- the currently set creation radius
-
getHandlers
- Overrides:
getHandlers
in classPlayerTeleportEvent
-
getHandlerList
-