Package org.purpurmc.purpur.event.entity

Class EntityTeleportHinderedEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.entity.EntityEvent

org.purpurmc.purpur.event.entity.EntityTeleportHinderedEvent

@NullMarked
public class EntityTeleportHinderedEvent
extends EntityEvent

Fired when an entity is hindered from teleporting.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EntityTeleportHinderedEvent.Reason	Reason for hindrance in teleports.

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.entity.EntityEvent

entity

Constructor Summary

Constructors

Constructor	Description
EntityTeleportHinderedEvent(Entity what, EntityTeleportHinderedEvent.Reason reason, @Nullable PlayerTeleportEvent.TeleportCause teleportCause)

Method Summary

Modifier and Type	Method	Description
boolean	callEvent()	Calls the event and tests if should retry.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
EntityTeleportHinderedEvent.Reason	getReason()
@Nullable PlayerTeleportEvent.TeleportCause	getTeleportCause()
void	setShouldRetry(boolean retry)	Sets whether the teleport should be retried.
boolean	shouldRetry()	Whether the teleport should be retried.

Methods inherited from class org.bukkit.event.entity.EntityEvent

getEntity, getEntityType

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

EntityTeleportHinderedEvent

@Internal
public EntityTeleportHinderedEvent(Entity what,
 EntityTeleportHinderedEvent.Reason reason,
 @Nullable PlayerTeleportEvent.TeleportCause teleportCause)

Method Details

getReason

public EntityTeleportHinderedEvent.Reason getReason()

Returns:

why the teleport was hindered.

getTeleportCause

public @Nullable PlayerTeleportEvent.TeleportCause getTeleportCause()

Returns:

why the teleport occurred if cause was given, otherwise null.

shouldRetry

public boolean shouldRetry()

Whether the teleport should be retried.

Note that this can put the server in a never-ending loop of trying to teleport someone resulting in a stack overflow. Do not retry more than necessary.

Returns:

whether the teleport should be retried.

setShouldRetry

public void setShouldRetry(boolean retry)

Sets whether the teleport should be retried.

Note that this can put the server in a never-ending loop of trying to teleport someone resulting in a stack overflow. Do not retry more than necessary.

Parameters:

retry - whether the teleport should be retried.

callEvent

public boolean callEvent()

Calls the event and tests if should retry.

Overrides:

callEvent in class Event

Returns:

whether the teleport should be retried.

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()