com.destroystokyo.paper.event.player

Class PlayerStopSpectatingEntityEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

com.destroystokyo.paper.event.player.PlayerStopSpectatingEntityEvent

All Implemented Interfaces:

Cancellable

public class PlayerStopSpectatingEntityEvent
extends PlayerEvent
implements Cancellable

Triggered when a player stops spectating an entity in spectator mode.

Nested Class Summary

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

Constructors

Constructor and Description
PlayerStopSpectatingEntityEvent(@NotNull Player player, @NotNull Entity spectatorTarget)

Method Summary

Modifier and Type	Method and Description
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull Entity	getSpectatorTarget() Gets the entity that the player is spectating
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.

Methods inherited from class org.bukkit.event.player.PlayerEvent

getPlayer

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerStopSpectatingEntityEvent

public PlayerStopSpectatingEntityEvent(@NotNull
                                       @NotNull Player player,
                                       @NotNull
                                       @NotNull Entity spectatorTarget)

Method Detail

getSpectatorTarget

@NotNull
public @NotNull Entity getSpectatorTarget()

Gets the entity that the player is spectating

Returns:

The entity the player is currently spectating (before they will stop).

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getHandlers

@NotNull
public @NotNull HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

@NotNull
public static @NotNull HandlerList getHandlerList()