io.papermc.paper.event.player

Class PlayerNameEntityEvent

java.lang.Object

org.bukkit.event.Event

org.bukkit.event.player.PlayerEvent

io.papermc.paper.event.player.PlayerNameEntityEvent

All Implemented Interfaces:

Cancellable

public class PlayerNameEntityEvent
extends PlayerEvent
implements Cancellable

Called when the player is attempting to rename a mob

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
PlayerNameEntityEvent(@NotNull Player player, @NotNull LivingEntity entity, @NotNull net.kyori.adventure.text.Component name, boolean persistent)

Method Summary

Modifier and Type	Method and Description
@NotNull LivingEntity	getEntity() Gets the entity involved in this event.
static @NotNull HandlerList	getHandlerList()
@NotNull HandlerList	getHandlers()
@Nullable net.kyori.adventure.text.Component	getName() Gets the name to be given to the entity.
boolean	isCancelled() Gets the cancellation state of this event.
boolean	isPersistent() Gets whether this will set the mob to be persistent.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.
void	setEntity(@NotNull LivingEntity entity) Sets the entity involved in this event.
void	setName(@Nullable net.kyori.adventure.text.Component name) Sets the name to be given to the entity.
void	setPersistent(boolean persistent) Sets whether this will set the mob to be persistent.

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

PlayerNameEntityEvent

public PlayerNameEntityEvent(@NotNull
                             @NotNull Player player,
                             @NotNull
                             @NotNull LivingEntity entity,
                             @NotNull
                             @NotNull net.kyori.adventure.text.Component name,
                             boolean persistent)

Method Detail

getName

@Nullable
public @Nullable net.kyori.adventure.text.Component getName()

Gets the name to be given to the entity.

Returns:

the name

setName

public void setName(@Nullable
                    @Nullable net.kyori.adventure.text.Component name)

Sets the name to be given to the entity.

Parameters:

name - the name

getEntity

@NotNull
public @NotNull LivingEntity getEntity()

Gets the entity involved in this event.

Returns:

the entity

setEntity

public void setEntity(@NotNull
                      @NotNull LivingEntity entity)

Sets the entity involved in this event.

Parameters:

entity - the entity

isPersistent

public boolean isPersistent()

Gets whether this will set the mob to be persistent.

Returns:

persistent

setPersistent

public void setPersistent(boolean persistent)

Sets whether this will set the mob to be persistent.

Parameters:

persistent - persistent

isCancelled

public boolean isCancelled()

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)

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