net.minecraftforge.event.entity.player

Class PlayerEvent

java.lang.Object

net.minecraftforge.fml.common.eventhandler.Event

net.minecraftforge.event.entity.EntityEvent

net.minecraftforge.event.entity.living.LivingEvent

net.minecraftforge.event.entity.player.PlayerEvent

Direct Known Subclasses:

AchievementEvent, AnvilRepairEvent, ArrowLooseEvent, ArrowNockEvent, AttackEntityEvent, BonemealEvent, EntityItemPickupEvent, FillBucketEvent, ItemFishedEvent, ItemTooltipEvent, PlayerBrewedPotionEvent, PlayerContainerEvent, PlayerDestroyItemEvent, PlayerEvent.BreakSpeed, PlayerEvent.Clone, PlayerEvent.HarvestCheck, PlayerEvent.LoadFromFile, PlayerEvent.NameFormat, PlayerEvent.SaveToFile, PlayerEvent.StartTracking, PlayerEvent.StopTracking, PlayerEvent.Visibility, PlayerFlyableFallEvent, PlayerInteractEvent, PlayerPickupXpEvent, PlayerSetSpawnEvent, PlayerSleepInBedEvent, PlayerWakeUpEvent, RenderPlayerEvent, SleepingLocationCheckEvent, UseHoeEvent

public class PlayerEvent
extends LivingEvent

PlayerEvent is fired whenever an event involving Living entities 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 and 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 EntityPlayer.canHarvestBlock(IBlockState). This event is fired via the ForgeEventFactory.getBreakSpeed(EntityPlayer, IBlockState, float, BlockPos). PlayerEvent.BreakSpeed.state contains the block being broken.
static class	PlayerEvent.Clone Fired when the EntityPlayer is cloned, typically caused by the network 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 EntityPlayer.canHarvestBlock(IBlockState). This event is fired via the ForgeEventFactory.doPlayerHarvestCheck(EntityPlayer, IBlockState, boolean). PlayerEvent.HarvestCheck.state contains the IBlockState that is being checked for harvesting.
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 EntityPlayer.getDisplayName() or EntityPlayer.refreshDisplayName(). This event is fired via the ForgeEventFactory.getPlayerDisplayName(EntityPlayer, String). PlayerEvent.NameFormat.username contains the username of the player.
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.Visibility Fired when the world checks if a player is near enough to be attacked by an entity.

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

LivingEvent.LivingJumpEvent, LivingEvent.LivingUpdateEvent

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

EntityEvent.CanUpdate, EntityEvent.EnteringChunk, EntityEvent.EntityConstructing

Nested classes/interfaces inherited from class net.minecraftforge.fml.common.eventhandler.Event

Event.HasResult, Event.Result

Constructor Summary

Constructors

Constructor and Description
PlayerEvent(EntityPlayer player)

Method Summary

Modifier and Type	Method and Description
EntityPlayer	getEntityPlayer()

Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent

getEntityLiving

Methods inherited from class net.minecraftforge.event.entity.EntityEvent

getEntity

Methods inherited from class net.minecraftforge.fml.common.eventhandler.Event

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerEvent

public PlayerEvent(EntityPlayer player)

Method Detail

getEntityPlayer

public EntityPlayer getEntityPlayer()