net.minecraftforge.common.extensions

Interface IForgeEntity

All Superinterfaces:

ICapabilityProvider, ICapabilitySerializable<NBTTagCompound>, INBTSerializable<NBTTagCompound>

All Known Implementing Classes:

AbstractChestHorse, AbstractClientPlayer, AbstractFish, AbstractGroupFish, AbstractHorse, AbstractIllager, AbstractSkeleton, Entity, EntityAgeable, EntityAmbientCreature, EntityAnimal, EntityAreaEffectCloud, EntityArmorStand, EntityArrow, EntityBat, EntityBlaze, EntityBoat, EntityCaveSpider, EntityChicken, EntityCod, EntityCow, EntityCreature, EntityCreeper, EntityDolphin, EntityDonkey, EntityDragon, EntityDragonFireball, EntityDrowned, EntityEgg, EntityElderGuardian, EntityEnderCrystal, EntityEnderEye, EntityEnderman, EntityEndermite, EntityEnderPearl, EntityEvoker, EntityEvokerFangs, EntityExpBottle, EntityFallingBlock, EntityFireball, EntityFireworkRocket, EntityFishHook, EntityFlying, EntityGhast, EntityGiantZombie, EntityGolem, EntityGuardian, EntityHanging, EntityHorse, EntityHusk, EntityIllusionIllager, EntityIronGolem, EntityItem, EntityItemFrame, EntityLargeFireball, EntityLeashKnot, EntityLightningBolt, EntityLiving, EntityLivingBase, EntityLlama, EntityLlamaSpit, EntityMagmaCube, EntityMinecart, EntityMinecartChest, EntityMinecartCommandBlock, EntityMinecartContainer, EntityMinecartEmpty, EntityMinecartFurnace, EntityMinecartHopper, EntityMinecartMobSpawner, EntityMinecartTNT, EntityMob, EntityMooshroom, EntityMule, EntityOcelot, EntityOtherPlayerMP, EntityPainting, EntityParrot, EntityPhantom, EntityPig, EntityPigZombie, EntityPlayer, EntityPlayerMP, EntityPlayerSP, EntityPolarBear, EntityPotion, EntityPufferFish, EntityRabbit, EntitySalmon, EntitySheep, EntityShoulderRiding, EntityShulker, EntityShulkerBullet, EntitySilverfish, EntitySkeleton, EntitySkeletonHorse, EntitySlime, EntitySmallFireball, EntitySnowball, EntitySnowman, EntitySpectralArrow, EntitySpellcasterIllager, EntitySpider, EntitySquid, EntityStray, EntityTameable, EntityThrowable, EntityTippedArrow, EntityTNTPrimed, EntityTrident, EntityTropicalFish, EntityTurtle, EntityVex, EntityVillager, EntityVindicator, EntityWaterMob, EntityWeatherEffect, EntityWitch, EntityWither, EntityWitherSkeleton, EntityWitherSkull, EntityWolf, EntityXPOrb, EntityZombie, EntityZombieHorse, EntityZombieVillager, FakePlayer, MultiPartEntityPart

public interface IForgeEntity
extends ICapabilitySerializable<NBTTagCompound>

Method Summary

Modifier and Type	Method and Description
default boolean	canBeRiddenInWater(Entity rider) Checks if this entity can continue to be ridden while it is underwater.
default boolean	canRiderInteract() If a rider of this entity can interact with this entity.
boolean	canTrample(IBlockState state, BlockPos pos, float fallDistance) Checks if this Entity can trample a Block.
boolean	canUpdate()
void	canUpdate(boolean value)
java.util.Collection<EntityItem>	captureDrops()
java.util.Collection<EntityItem>	captureDrops(java.util.Collection<EntityItem> captureDrops)
Entity	changeDimension(DimensionType type, ITeleporter teleporter) Override instead of Entity.changeDimension(DimensionType, ITeleporter) if your entity needs special handling for specific teleporters.
default void	deserializeNBT(NBTTagCompound nbt)
default Entity	getEntity()
NBTTagCompound	getEntityData() Returns a NBTTagCompound that can be used to store custom data for this entity.
default ItemStack	getPickedResult(RayTraceResult target) Called when a user uses the creative pick block button on this entity.
boolean	isAddedToWorld() Gets whether this entity has been added to a world (for tracking).
default boolean	isCreatureType(EnumCreatureType type, boolean forSpawnCount) Returns true if the entity is of the @link{EnumCreatureType} provided
void	onAddedToWorld() Called after the entity has been added to the world's ticking list.
void	onRemovedFromWorld() Called after the entity has been removed to the world's ticking list.
void	revive() Revives an entity that has been removed from a world.
default NBTTagCompound	serializeNBT()
default boolean	shouldRenderInPass(int pass)
default boolean	shouldRiderSit() Used in model rendering to determine if the entity riding this entity should be in the 'sitting' position.

Methods inherited from interface net.minecraftforge.common.capabilities.ICapabilityProvider

getCapability, getCapability

Method Detail

getEntity

default Entity getEntity()

deserializeNBT

default void deserializeNBT(NBTTagCompound nbt)

Specified by:

deserializeNBT in interface INBTSerializable<NBTTagCompound>

serializeNBT

default NBTTagCompound serializeNBT()

Specified by:

serializeNBT in interface INBTSerializable<NBTTagCompound>

canUpdate

boolean canUpdate()

canUpdate

void canUpdate(boolean value)

captureDrops

@Nullable
java.util.Collection<EntityItem> captureDrops()

captureDrops

java.util.Collection<EntityItem> captureDrops(@Nullable
                                              java.util.Collection<EntityItem> captureDrops)

getEntityData

NBTTagCompound getEntityData()

Returns a NBTTagCompound that can be used to store custom data for this entity. It will be written, and read from disc, so it persists over world saves.

Returns:

A NBTTagCompound

shouldRiderSit

default boolean shouldRiderSit()

Used in model rendering to determine if the entity riding this entity should be in the 'sitting' position.

Returns:

false to prevent an entity that is mounted to this entity from displaying the 'sitting' animation.

getPickedResult

default ItemStack getPickedResult(RayTraceResult target)

Called when a user uses the creative pick block button on this entity.

Parameters:

target - The full target the player is looking at

Returns:

A ItemStack to add to the player's inventory, empty ItemStack if nothing should be added.

shouldRenderInPass

default boolean shouldRenderInPass(int pass)

canRiderInteract

default boolean canRiderInteract()

If a rider of this entity can interact with this entity. Should return true on the ridden entity if so.

Returns:

if the entity can be interacted with from a rider

canBeRiddenInWater

default boolean canBeRiddenInWater(Entity rider)

Checks if this entity can continue to be ridden while it is underwater.

Parameters:

rider - The entity that is riding this entity

Returns:

true if the entity can continue to ride underwater. false otherwise.

changeDimension

@Nullable
Entity changeDimension(DimensionType type,
                                 ITeleporter teleporter)

Override instead of Entity.changeDimension(DimensionType, ITeleporter) if your entity needs special handling for specific teleporters.

Parameters:

type - The target dimension

teleporter - The teleporter being used to move the entity to the dimension

Returns:

The entity to be placed in the target dimension. null if the entity should despawn.

canTrample

boolean canTrample(IBlockState state,
                   BlockPos pos,
                   float fallDistance)

Checks if this Entity can trample a Block.

Parameters:

pos - The block pos

fallDistance - The fall distance

Returns:

true if this entity can trample, false otherwise

isCreatureType

default boolean isCreatureType(EnumCreatureType type,
                               boolean forSpawnCount)

Returns true if the entity is of the @link{EnumCreatureType} provided

Parameters:

type - The EnumCreatureType type this entity is evaluating

forSpawnCount - If this is being invoked to check spawn count caps.

Returns:

If the creature is of the type provided

isAddedToWorld

boolean isAddedToWorld()

Gets whether this entity has been added to a world (for tracking). Specifically between the times when an entity is added to a world and the entity being removed from the world's tracked lists. See World#onEntityAdded(Entity) and World#onEntityRemoved(Entity).

Returns:

True if this entity is being tracked by a world

onAddedToWorld

void onAddedToWorld()

Called after the entity has been added to the world's ticking list. Can be overriden, but needs to call super to prevent MC-136995.

onRemovedFromWorld

void onRemovedFromWorld()

Called after the entity has been removed to the world's ticking list. Can be overriden, but needs to call super to prevent MC-136995.

revive

void revive()

Revives an entity that has been removed from a world. Used as replacement for entity.removed = true. Having it as a function allows the entity to react to being revived.