Package net.minecraftforge.event.entity.player

Class PlayerEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.event.entity.EntityEvent

net.minecraftforge.event.entity.living.LivingEvent

net.minecraftforge.event.entity.player.PlayerEvent

Direct Known Subclasses:

AdvancementEvent, AnvilRepairEvent, ArrowLooseEvent, ArrowNockEvent, AttackEntityEvent, BonemealEvent, CriticalHitEvent, EntityItemPickupEvent, FillBucketEvent, ItemFishedEvent, ItemTooltipEvent, MovementInputUpdateEvent, PermissionsChangedEvent, PlayerBrewedPotionEvent, PlayerContainerEvent, PlayerDestroyItemEvent, PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.ItemCraftedEvent, PlayerEvent.ItemPickupEvent, 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, PlayerInteractEvent, PlayerSetSpawnEvent, PlayerSleepInBedEvent, PlayerSpawnPhantomsEvent, PlayerWakeUpEvent, PlayerXpEvent, RenderPlayerEvent, SleepingTimeCheckEvent, TradeWithVillagerEvent

public class PlayerEvent
extends LivingEvent

PlayerEvent is fired whenever an event involving a Player occurs.
If a method utilizes this Event as its parameter, the method will receive every child event of this class.

All children of this event are fired on the MinecraftForge.EVENT_BUS.

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. This event is fired whenever a player attempts to harvest a block in invalid reference Player#getDigSpeed(BlockState, BlockPos) . This event is fired via the ForgeEventFactory.getBreakSpeed(Player, BlockState, float, BlockPos). PlayerEvent.BreakSpeed.state contains the block being broken.
static class	PlayerEvent.Clone	Fired when the EntityPlayer 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. This event is fired whenever a player attempts to harvest a block in Player.hasCorrectToolForDrops(BlockState). This event is fired via the ForgeEventFactory.doPlayerHarvestCheck(Player, BlockState, boolean). PlayerEvent.HarvestCheck.state contains the BlockState that is being checked for harvesting.
static class	PlayerEvent.ItemCraftedEvent
static class	PlayerEvent.ItemPickupEvent
static class	PlayerEvent.ItemSmeltedEvent
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. This event is fired whenever a player's name is retrieved in Player.getDisplayName() or Player.refreshDisplayName(). This event is fired via the ForgeEventFactory.getPlayerDisplayName(Player, Component). PlayerEvent.NameFormat.username contains the username of the player.
static class	PlayerEvent.PlayerChangedDimensionEvent
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
static class	PlayerEvent.PlayerLoggedOutEvent
static class	PlayerEvent.PlayerRespawnEvent
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.
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.
static class	PlayerEvent.TabListNameFormat	TabListNameFormat is fired when a player's display name for the tablist is retrieved. This event is fired whenever a player's display name for the tablist is retrieved in ServerPlayer.getTabListDisplayName() or ServerPlayer.refreshTabListName(). This event is fired via the ForgeEventFactory.getPlayerTabListDisplayName(Player). PlayerEvent.TabListNameFormat.getDisplayName() contains the display name of the player or null if the client should determine the display name itself.

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.living.LivingEvent

LivingEvent.LivingJumpEvent, LivingEvent.LivingTickEvent, LivingEvent.LivingVisibilityEvent

Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent

EntityEvent.EnteringSection, EntityEvent.EntityConstructing

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

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 net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.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