net.minecraftforge.fml.common.registry

Class EntityRegistry

java.lang.Object

net.minecraftforge.fml.common.registry.EntityRegistry

public class EntityRegistry
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EntityRegistry.EntityRegistration

Method Summary

Modifier and Type	Method and Description
static void	addSpawn(java.lang.Class<? extends EntityLiving> entityClass, int weightedProb, int min, int max, EnumCreatureType typeOfCreature, BiomeGenBase... biomes) Add a spawn entry for the supplied entity in the supplied BiomeGenBase list
static void	addSpawn(java.lang.String entityName, int weightedProb, int min, int max, EnumCreatureType typeOfCreature, BiomeGenBase... biomes) Add a spawn entry for the supplied entity in the supplied BiomeGenBase list
static int	findGlobalUniqueEntityId() Deprecated.
static java.util.Map<java.lang.String,EntityList.EntityEggInfo>	getEggs() Returns a Unmodifiable view of the registered entity eggs list.
static EntityRegistry	instance()
EntityRegistry.EntityRegistration	lookupModSpawn(java.lang.Class<? extends Entity> clazz, boolean keepLooking)
EntityRegistry.EntityRegistration	lookupModSpawn(ModContainer mc, int modEntityId)
static void	registerEgg(java.lang.Class<? extends Entity> entityClass, int primary, int secondary) Registers a spawn egg for the specified entity class.
static void	registerGlobalEntityID(java.lang.Class<? extends Entity> entityClass, java.lang.String entityName, int id) Deprecated.
static void	registerGlobalEntityID(java.lang.Class<? extends Entity> entityClass, java.lang.String entityName, int id, int backgroundEggColour, int foregroundEggColour) Deprecated.
static void	registerModEntity(java.lang.Class<? extends Entity> entityClass, java.lang.String entityName, int id, java.lang.Object mod, int trackingRange, int updateFrequency, boolean sendsVelocityUpdates) Register the mod entity type with FML
static void	registerModEntity(java.lang.Class<? extends Entity> entityClass, java.lang.String entityName, int id, java.lang.Object mod, int trackingRange, int updateFrequency, boolean sendsVelocityUpdates, int eggPrimary, int eggSecondary) Register the mod entity type with FML This will also register a spawn egg.
static void	removeSpawn(java.lang.Class<? extends EntityLiving> entityClass, EnumCreatureType typeOfCreature, BiomeGenBase... biomes) Remove the spawn entry for the supplied entity
static void	removeSpawn(java.lang.String entityName, EnumCreatureType typeOfCreature, BiomeGenBase... biomes) Remove the spawn entry for the supplied entity
boolean	tryTrackingEntity(EntityTracker entityTracker, Entity entity)

Methods inherited from class java.lang.Object

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

Method Detail

instance

public static EntityRegistry instance()

registerModEntity

public static void registerModEntity(java.lang.Class<? extends Entity> entityClass,
                                     java.lang.String entityName,
                                     int id,
                                     java.lang.Object mod,
                                     int trackingRange,
                                     int updateFrequency,
                                     boolean sendsVelocityUpdates)

Register the mod entity type with FML

Parameters:

entityClass - The entity class

entityName - A unique name for the entity

id - A mod specific ID for the entity

mod - The mod

trackingRange - The range at which MC will send tracking updates

updateFrequency - The frequency of tracking updates

sendsVelocityUpdates - Whether to send velocity information packets as well

registerModEntity

public static void registerModEntity(java.lang.Class<? extends Entity> entityClass,
                                     java.lang.String entityName,
                                     int id,
                                     java.lang.Object mod,
                                     int trackingRange,
                                     int updateFrequency,
                                     boolean sendsVelocityUpdates,
                                     int eggPrimary,
                                     int eggSecondary)

Register the mod entity type with FML This will also register a spawn egg.

Parameters:

entityClass - The entity class

entityName - A unique name for the entity

id - A mod specific ID for the entity

mod - The mod

trackingRange - The range at which MC will send tracking updates

updateFrequency - The frequency of tracking updates

sendsVelocityUpdates - Whether to send velocity information packets as well

eggPrimary - Primary egg color

eggSecondary - Secondary egg color

registerEgg

public static void registerEgg(java.lang.Class<? extends Entity> entityClass,
                               int primary,
                               int secondary)

Registers a spawn egg for the specified entity class. The class must already be registered in the EntityList.classToStringMapping. This can be done either by using the global ID system, or preferably the registerModEntity functions above. Once registered mob eggs can be created by using minecraft:spawn_egg with NBT entry 'entity_name' with value of the name this class is registered in the classToStringMapping with.

Parameters:

entityClass - The entity class

primary - Primary egg color

secondary - Secondary egg color

Throws:

java.lang.IllegalArgumentException - if entityClass is not registered in classToStringMapping.

getEggs

public static java.util.Map<java.lang.String,EntityList.EntityEggInfo> getEggs()

Returns a Unmodifiable view of the registered entity eggs list.

Returns:

An Unmodifiable view of the registered entity eggs list.

registerGlobalEntityID

@Deprecated
public static void registerGlobalEntityID(java.lang.Class<? extends Entity> entityClass,
                                                       java.lang.String entityName,
                                                       int id)

Deprecated.

Registers in the minecraft Entity ID list. This is generally not a good idea and shouldn't be used. Simply use registerModEntity(Class, String, int, Object, int, int, boolean, int, int) instead.

Parameters:

entityClass - Class of the entity being registered

entityName - Name for the entity being registered

id - A globally unique ID for the entity

registerGlobalEntityID

@Deprecated
public static void registerGlobalEntityID(java.lang.Class<? extends Entity> entityClass,
                                                       java.lang.String entityName,
                                                       int id,
                                                       int backgroundEggColour,
                                                       int foregroundEggColour)

Deprecated.

Registers in the minecraft Entity ID list. This is generally not a good idea, and shouldn't be used. Simply use registerModEntity(Class, String, int, Object, int, int, boolean) instead.

Parameters:

entityClass - The class of the entity being registered

entityName - The name of the entity being registered

id - The globally unique ID of the entity

backgroundEggColour - An RGB colour value for the spawn egg background colour

foregroundEggColour - An RGB colour value for the spawn egg foreground colour

addSpawn

public static void addSpawn(java.lang.Class<? extends EntityLiving> entityClass,
                            int weightedProb,
                            int min,
                            int max,
                            EnumCreatureType typeOfCreature,
                            BiomeGenBase... biomes)

Add a spawn entry for the supplied entity in the supplied BiomeGenBase list

Parameters:

entityClass - Entity class added

weightedProb - Probability

min - Min spawn count

max - Max spawn count

typeOfCreature - Type of spawn

biomes - List of biomes

addSpawn

public static void addSpawn(java.lang.String entityName,
                            int weightedProb,
                            int min,
                            int max,
                            EnumCreatureType typeOfCreature,
                            BiomeGenBase... biomes)

Add a spawn entry for the supplied entity in the supplied BiomeGenBase list

Parameters:

entityName - The entity name

weightedProb - Probability

min - Min spawn count

max - Max spawn count

typeOfCreature - type of spawn

biomes - List of biomes

removeSpawn

public static void removeSpawn(java.lang.Class<? extends EntityLiving> entityClass,
                               EnumCreatureType typeOfCreature,
                               BiomeGenBase... biomes)

Remove the spawn entry for the supplied entity

Parameters:

entityClass - The entity class

typeOfCreature - type of spawn

biomes - Biomes to remove from

removeSpawn

public static void removeSpawn(java.lang.String entityName,
                               EnumCreatureType typeOfCreature,
                               BiomeGenBase... biomes)

Remove the spawn entry for the supplied entity

Parameters:

entityName - Name of entity being removed

typeOfCreature - type of spawn

biomes - Biomes to remove from

findGlobalUniqueEntityId

@Deprecated
public static int findGlobalUniqueEntityId()

Deprecated.

Utility function to try and obtain a globally unique entity ID. Not useful as it requires syncing between client and server. Use registerModEntity(Class, String, int, Object, int, int, boolean) instead, for a much better experience.

Returns:

A theoretically globally unique ID

lookupModSpawn

public EntityRegistry.EntityRegistration lookupModSpawn(java.lang.Class<? extends Entity> clazz,
                                                        boolean keepLooking)

lookupModSpawn

public EntityRegistry.EntityRegistration lookupModSpawn(ModContainer mc,
                                                        int modEntityId)

tryTrackingEntity

public boolean tryTrackingEntity(EntityTracker entityTracker,
                                 Entity entity)