net.minecraftforge.fml.common.registry

Class EntityEntryBuilder<E extends Entity>

java.lang.Object

net.minecraftforge.fml.common.registry.EntityEntryBuilder<E>

Type Parameters:

E - The entity type

public final class EntityEntryBuilder<E extends Entity>
extends java.lang.Object

An entity registry entry builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	EntityEntryBuilder.BuiltEntityEntry
class	EntityEntryBuilder.Spawn

Method Summary

Modifier and Type	Method and Description
EntityEntry	build() Create an entity entry based on the data in this builder.
static <E extends Entity> EntityEntryBuilder<E>	create() Creates a new entity entry builder.
EntityEntryBuilder<E>	egg(int primaryColor, int secondaryColor) Sets the egg of the entity.
EntityEntryBuilder<E>	entity(java.lang.Class<? extends E> entity) Sets the class of the entity.
EntityEntryBuilder<E>	factory(java.util.function.Function<World,E> factory) Sets the factory of the entity.
EntityEntryBuilder<E>	id(ResourceLocation id, int network) Sets the id of the entity.
EntityEntryBuilder<E>	id(java.lang.String id, int network) Sets the id of the entity.
EntityEntryBuilder<E>	name(java.lang.String name) Sets the name of the entity.
EntityEntryBuilder<E>	spawn(EnumCreatureType type, int weight, int min, int max, Biome... biomes) Adds a spawn entry.
EntityEntryBuilder<E>	spawn(EnumCreatureType type, int weight, int min, int max, java.lang.Iterable<Biome> biomes) Adds a spawn entry.
EntityEntryBuilder<E>	tracker(int range, int updateFrequency, boolean sendVelocityUpdates) Sets entity tracking information.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Nonnull
public static <E extends Entity> EntityEntryBuilder<E> create()

Creates a new entity entry builder.

Type Parameters:

E - The entity type

Returns:

A new entity entry builder

entity

@Nonnull
public final EntityEntryBuilder<E> entity(@Nonnull
                                                    java.lang.Class<? extends E> entity)

Sets the class of the entity.

Entities will be constructed using a constructor accepting World. If you wish to use your own factory, use factory(Function).

Parameters:

entity - The entity class

Returns:

This builder

Throws:

java.lang.NullPointerException - If entity is null

factory

@Nonnull
public final EntityEntryBuilder<E> factory(@Nonnull
                                                     java.util.function.Function<World,E> factory)

Sets the factory of the entity.

Parameters:

factory - The entity factory

Returns:

This builder

Throws:

java.lang.NullPointerException - If entity is null

id

@Nonnull
public final EntityEntryBuilder<E> id(@Nonnull
                                                ResourceLocation id,
                                                int network)

Sets the id of the entity.

Parameters:

id - The entity id

network - The network id

Returns:

This builder

Throws:

java.lang.NullPointerException - If id is null

id

@Nonnull
public final EntityEntryBuilder<E> id(@Nonnull
                                                java.lang.String id,
                                                int network)

Sets the id of the entity.

Parameters:

id - The entity id

network - The network id

Returns:

This builder

Throws:

java.lang.NullPointerException - If id is null

name

@Nonnull
public final EntityEntryBuilder<E> name(@Nonnull
                                                  java.lang.String name)

Sets the name of the entity.

Parameters:

name - The entity name

Returns:

This builder

Throws:

java.lang.NullPointerException - If name is null

tracker

@Nonnull
public final EntityEntryBuilder<E> tracker(int range,
                                                     int updateFrequency,
                                                     boolean sendVelocityUpdates)

Sets entity tracking information.

Parameters:

range - The tracking range

updateFrequency - The tracking update frequency

sendVelocityUpdates - If the entity should send velocity updates

Returns:

This builder

spawn

@Nonnull
public final EntityEntryBuilder<E> spawn(@Nonnull
                                                   EnumCreatureType type,
                                                   int weight,
                                                   int min,
                                                   int max,
                                                   @Nonnull
                                                   Biome... biomes)

Adds a spawn entry.

Parameters:

type - The creature type

weight - The spawn entry weight

min - The minimum spawn count

max - The maximum spawn count

biomes - The biomes to add an entry in

Returns:

This builder

Throws:

java.lang.IllegalArgumentException - If the entity is not a EntityLiving

java.lang.NullPointerException - If type is null

java.lang.NullPointerException - If biomes is null

spawn

@Nonnull
public final EntityEntryBuilder<E> spawn(@Nonnull
                                                   EnumCreatureType type,
                                                   int weight,
                                                   int min,
                                                   int max,
                                                   @Nonnull
                                                   java.lang.Iterable<Biome> biomes)

Adds a spawn entry.

Parameters:

type - The creature type

weight - The spawn entry weight

min - The minimum spawn count

max - The maximum spawn count

biomes - The biomes to add an entry in

Returns:

This builder

Throws:

java.lang.IllegalArgumentException - If the entity is not a EntityLiving

java.lang.NullPointerException - If type is null

java.lang.NullPointerException - If biomes is null

egg

@Nonnull
public final EntityEntryBuilder<E> egg(int primaryColor,
                                                 int secondaryColor)

Sets the egg of the entity.

Parameters:

primaryColor - the primary egg color

secondaryColor - the secondary egg color

Returns:

This builder

build

@Nonnull
public EntityEntry build()

Create an entity entry based on the data in this builder.

Returns:

The entity entry

Throws:

java.lang.IllegalStateException - If the entity class has not been provided

java.lang.IllegalStateException - If the entity id has not been provided

java.lang.IllegalStateException - If the entity name has not been provided

java.lang.IllegalStateException - If spawns have been provided for a non EntityLiving

ReflectionHelper.UnknownConstructorException - If a factory has not been provided and entity does not have a constructor accepting World