net.minecraftforge.common

Interface IExtendedEntityProperties

public interface IExtendedEntityProperties

Allows for custom entity data and logic to be hooked to existing entity classes.

Method Summary

Modifier and Type	Method and Description
void	init(Entity entity, World world) Used to initialize the extended properties with the entity that this is attached to, as well as the world object.
void	loadNBTData(NBTTagCompound compound) Called when the entity that this class is attached to is loaded.
void	saveNBTData(NBTTagCompound compound) Called when the entity that this class is attached to is saved.

Method Detail

saveNBTData

void saveNBTData(NBTTagCompound compound)

Called when the entity that this class is attached to is saved. Any custom entity data that needs saving should be saved here.

Parameters:

compound - The compound to save to.

loadNBTData

void loadNBTData(NBTTagCompound compound)

Called when the entity that this class is attached to is loaded. In order to hook into this, you will need to subscribe to the EntityConstructing event. Otherwise, you will need to initialize manually.

Parameters:

compound - The compound to load from.

init

void init(Entity entity,
          World world)

Used to initialize the extended properties with the entity that this is attached to, as well as the world object. Called automatically if you register with the EntityConstructing event. May be called multiple times if the extended properties is moved over to a new entity. Such as when a player switches dimension {Minecraft re-creates the player entity}

Parameters:

entity - The entity that this extended properties is attached to

world - The world in which the entity exists