Package com.destroystokyo.paper.event.player

Class PlayerStartSpectatingEntityEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

com.destroystokyo.paper.event.player.PlayerStartSpectatingEntityEvent

All Implemented Interfaces:

Cancellable

public class PlayerStartSpectatingEntityEvent
extends PlayerEvent
implements Cancellable

Triggered when a player starts 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	Description
PlayerStartSpectatingEntityEvent(@NotNull Player player, @NotNull Entity currentSpectatorTarget, @NotNull Entity newSpectatorTarget)

Method Summary

Modifier and Type	Method	Description
@NotNull Entity	getCurrentSpectatorTarget()	Gets the entity that the player is currently spectating or themselves if they weren't spectating anything
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@NotNull Entity	getNewSpectatorTarget()	Gets the new entity that the player will now be 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 Details

PlayerStartSpectatingEntityEvent

public PlayerStartSpectatingEntityEvent(@NotNull
 @NotNull Player player,
 @NotNull
 @NotNull Entity currentSpectatorTarget,
 @NotNull
 @NotNull Entity newSpectatorTarget)

Method Details

getCurrentSpectatorTarget

@NotNull
public @NotNull Entity getCurrentSpectatorTarget()

Gets the entity that the player is currently spectating or themselves if they weren't spectating anything

Returns:

The entity the player is currently spectating (before they start spectating the new target).

getNewSpectatorTarget

@NotNull
public @NotNull Entity getNewSpectatorTarget()

Gets the new entity that the player will now be spectating

Returns:

The entity the player is now going to be spectating.

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()