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

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.Class<? extends Entity>,EntityEntry>	entityClassEntries
private com.google.common.collect.BiMap<java.lang.Class<? extends Entity>,EntityRegistry.EntityRegistration>	entityClassRegistrations
private com.google.common.collect.ListMultimap<ModContainer,EntityRegistry.EntityRegistration>	entityRegistrations
private static EntityRegistry	INSTANCE

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EntityRegistry()

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, Biome... biomes) Add a spawn entry for the supplied entity in the supplied Biome list
static void	addSpawn(java.lang.String entityName, int weightedProb, int min, int max, EnumCreatureType typeOfCreature, Biome... biomes) Add a spawn entry for the supplied entity in the supplied Biome list
private void	doModEntityRegistration(ResourceLocation registryName, java.lang.Class<? extends Entity> entityClass, java.lang.String entityName, int id, java.lang.Object mod, int trackingRange, int updateFrequency, boolean sendsVelocityUpdates)
static EntityEntry	getEntry(java.lang.Class<? extends Entity> entityClass)
(package private) void	insert(java.lang.Class<? extends Entity> entity, EntityRegistry.EntityRegistration registration)
static EntityRegistry	instance()
EntityRegistry.EntityRegistration	lookupModSpawn(java.lang.Class<? extends Entity> clazz, boolean keepLooking)
EntityRegistry.EntityRegistration	lookupModSpawn(ModContainer mc, int modEntityId)
static void	registerEgg(ResourceLocation name, int primary, int secondary) Registers a spawn egg for the specified entity class.
static void	registerModEntity(ResourceLocation registryName, 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(ResourceLocation registryName, 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, Biome... biomes) Remove the spawn entry for the supplied entity
static void	removeSpawn(java.lang.String entityName, EnumCreatureType typeOfCreature, Biome... 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

Field Detail

INSTANCE

private static final EntityRegistry INSTANCE

entityRegistrations

private final com.google.common.collect.ListMultimap<ModContainer,EntityRegistry.EntityRegistration> entityRegistrations

entityClassRegistrations

private final com.google.common.collect.BiMap<java.lang.Class<? extends Entity>,EntityRegistry.EntityRegistration> entityClassRegistrations

entityClassEntries

private final java.util.Map<java.lang.Class<? extends Entity>,EntityEntry> entityClassEntries

Constructor Detail

EntityRegistry

private EntityRegistry()

Method Detail

instance

public static EntityRegistry instance()

registerModEntity

public static void registerModEntity(ResourceLocation registryName,
                                     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(ResourceLocation registryName,
                                     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

doModEntityRegistration

private void doModEntityRegistration(ResourceLocation registryName,
                                     java.lang.Class<? extends Entity> entityClass,
                                     java.lang.String entityName,
                                     int id,
                                     java.lang.Object mod,
                                     int trackingRange,
                                     int updateFrequency,
                                     boolean sendsVelocityUpdates)

registerEgg

public static void registerEgg(ResourceLocation name,
                               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:

name - The entity ResourceLocation

primary - Primary egg color

secondary - Secondary egg color

addSpawn

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

Add a spawn entry for the supplied entity in the supplied Biome 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,
                            Biome... biomes)

Add a spawn entry for the supplied entity in the supplied Biome 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,
                               Biome... 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,
                               Biome... 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

lookupModSpawn

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

lookupModSpawn

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

tryTrackingEntity

public boolean tryTrackingEntity(EntityTracker entityTracker,
                                 Entity entity)

getEntry

@Nullable
public static EntityEntry getEntry(java.lang.Class<? extends Entity> entityClass)

insert

final void insert(java.lang.Class<? extends Entity> entity,
                  EntityRegistry.EntityRegistration registration)