Class PlayerEvent

java.lang.Object

net.neoforged.bus.api.Event

net.neoforged.neoforge.event.entity.EntityEvent

net.neoforged.neoforge.event.entity.living.LivingEvent

net.neoforged.neoforge.event.entity.player.PlayerEvent

Direct Known Subclasses:

AdvancementEvent, AnvilCraftEvent, ArrowLooseEvent, ArrowNockEvent, AttackEntityEvent, CanPlayerSleepEvent, ClientInformationUpdatedEvent, CriticalHitEvent, FluidTooltipEvent, ItemFishedEvent, ItemTooltipEvent, MovementInputUpdateEvent, PermissionsChangedEvent, PlayerBrewedPotionEvent, PlayerContainerEvent, PlayerDestroyItemEvent, PlayerEnchantItemEvent, PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemSmeltedEvent, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.PlayerChangedDimensionEvent, PlayerEvent.PlayerChangeGameModeEvent, PlayerEvent.PlayerLoggedInEvent, PlayerEvent.PlayerLoggedOutEvent, PlayerEvent.PlayerRespawnEvent, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.TabListNameFormat, PlayerFlyableFallEvent, PlayerHeartTypeEvent, PlayerInteractEvent, PlayerRespawnPositionEvent, PlayerSetSpawnEvent, PlayerSpawnPhantomsEvent, PlayerTickEvent, PlayerWakeUpEvent, PlayerXpEvent, StatAwardEvent, SweepAttackEvent, TradeWithVillagerEvent

public abstract class PlayerEvent
extends LivingEvent

Base class of the events specific to Players.

See Also:

• PlayerEvent.HarvestCheck
• PlayerEvent.BreakSpeed
• PlayerEvent.NameFormat
• PlayerEvent.TabListNameFormat
• PlayerEvent.Clone
• PlayerEvent.StartTracking
• PlayerEvent.StopTracking
• PlayerEvent.LoadFromFile
• PlayerEvent.SaveToFile
• PlayerEvent.ItemCraftedEvent
• PlayerEvent.ItemSmeltedEvent
• PlayerEvent.PlayerLoggedInEvent
• PlayerEvent.PlayerLoggedOutEvent
• PlayerEvent.PlayerRespawnEvent
• PlayerEvent.PlayerChangedDimensionEvent
• PlayerEvent.PlayerChangeGameModeEvent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlayerEvent.BreakSpeed	BreakSpeed is fired when a player attempts to harvest a block.
static class	PlayerEvent.Clone	Fired when the player is cloned, typically caused by the impl sending a RESPAWN_PLAYER event.
static class	PlayerEvent.HarvestCheck	HarvestCheck is fired when a player attempts to harvest a block.
static class	PlayerEvent.ItemCraftedEvent
static class	PlayerEvent.ItemSmeltedEvent	Fired when a player takes the resultant ItemStack from a furnace-like block.
static class	PlayerEvent.LoadFromFile	The player is being loaded from the world save.
static class	PlayerEvent.NameFormat	NameFormat is fired when a player's display name is retrieved.
static class	PlayerEvent.PlayerChangedDimensionEvent	Fired when the player is teleported to a new dimension via ServerPlayer.teleport(TeleportTransition)
static class	PlayerEvent.PlayerChangeGameModeEvent	Fired when the game type of a server player is changed to a different value than what it was previously.
static class	PlayerEvent.PlayerLoggedInEvent	Fired when the player is placed into the server via PlayerList.placeNewPlayer(Connection, ServerPlayer, CommonListenerCookie)
static class	PlayerEvent.PlayerLoggedOutEvent	Fired when the player is removed from the server via PlayerList.remove(ServerPlayer)
static class	PlayerEvent.PlayerRespawnEvent	Fired when the player is respawned via invalid reference PlayerList#respawn(ServerPlayer, boolean) after creating and initializing the new ServerPlayer.
static class	PlayerEvent.SaveToFile	The player is being saved to the world store.
static class	PlayerEvent.StartTracking	Fired when an Entity is started to be "tracked" by this player (the player receives updates about this entity, e.g. motion).
static class	PlayerEvent.StopTracking	Fired when an Entity is stopped to be "tracked" by this player (the player no longer receives updates about this entity, e.g. motion).
static class	PlayerEvent.TabListNameFormat	TabListNameFormat is fired when a player's display name for the tablist is retrieved.

Nested classes/interfaces inherited from class LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing, EntityEvent.Size

Field Summary

Fields

Modifier and Type	Field	Description
private final Player	player

Constructor Summary

Constructors

Constructor	Description
PlayerEvent(Player player)

Method Summary

Modifier and Type	Method	Description
Player	getEntity()

Methods inherited from class Object

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

Field Details

player

private final Player player

Constructor Details

PlayerEvent

public PlayerEvent(Player player)

Method Details

getEntity

public Player getEntity()

Overrides:

getEntity in class LivingEvent