Package net.fabricmc.fabric.api.object.builder.v1.entity

Class FabricEntityTypeBuilder<T extends Entity>

java.lang.Object

net.fabricmc.fabric.api.object.builder.v1.entity.FabricEntityTypeBuilder<T>

Type Parameters:

T - Entity class.

Direct Known Subclasses:

FabricEntityTypeBuilder.Living

public class FabricEntityTypeBuilder<T extends Entity>
extends Object

Extended version of EntityType.Builder with added registration for server->client entity tracking values.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FabricEntityTypeBuilder.Living<T extends LivingEntity>	An extended version of FabricEntityTypeBuilder with support for features on present on living entities, such as default attributes.
static class	FabricEntityTypeBuilder.Mob<T extends MobEntity>	An extended version of FabricEntityTypeBuilder with support for features on present on mob entities, such as spawn restrictions.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FabricEntityTypeBuilder(SpawnGroup spawnGroup, EntityType.EntityFactory<T> factory)

Method Summary

Modifier and Type	Method	Description
EntityType<T>	build()	Creates the entity type.
static <T extends Entity> FabricEntityTypeBuilder<T>	create()	Creates an entity type builder.
static <T extends Entity> FabricEntityTypeBuilder<T>	create(SpawnGroup spawnGroup)	Creates an entity type builder.
static <T extends Entity> FabricEntityTypeBuilder<T>	create(SpawnGroup spawnGroup, EntityType.EntityFactory<T> factory)	Creates an entity type builder.
static <T extends LivingEntity> FabricEntityTypeBuilder.Living<T>	createLiving()	Creates an entity type builder for a living entity.
static <T extends MobEntity> FabricEntityTypeBuilder.Mob<T>	createMob()	Creates an entity type builder for a mob entity.
FabricEntityTypeBuilder<T>	dimensions(EntityDimensions dimensions)	Sets the dimensions of this entity type.
FabricEntityTypeBuilder<T>	disableSaving()
FabricEntityTypeBuilder<T>	disableSummon()	Whether this entity type is summonable using the /summon command.
<N extends T> FabricEntityTypeBuilder<N>	entityFactory(EntityType.EntityFactory<N> factory)
FabricEntityTypeBuilder<T>	fireImmune()	Sets this entity type to be fire immune.
FabricEntityTypeBuilder<T>	forceTrackedVelocityUpdates(boolean forceTrackedVelocityUpdates)
FabricEntityTypeBuilder<T>	requires(FeatureFlag... requiredFeatures)	Sets the features this entity requires.
FabricEntityTypeBuilder<T>	spawnableFarFromPlayer()	Sets whether this entity type can be spawned far away from a player.
FabricEntityTypeBuilder<T>	spawnGroup(SpawnGroup group)
FabricEntityTypeBuilder<T>	specificSpawnBlocks(Block... blocks)	Sets the ImmutableSet of blocks this entity can spawn on.
FabricEntityTypeBuilder<T>	trackable(int trackRangeBlocks, int trackedUpdateRate)	Deprecated. use trackRangeBlocks(int), trackedUpdateRate(int) and forceTrackedVelocityUpdates(boolean)
FabricEntityTypeBuilder<T>	trackable(int trackRangeBlocks, int trackedUpdateRate, boolean forceTrackedVelocityUpdates)	Deprecated. use trackRangeBlocks(int), trackedUpdateRate(int) and forceTrackedVelocityUpdates(boolean)
FabricEntityTypeBuilder<T>	trackedUpdateRate(int rate)
FabricEntityTypeBuilder<T>	trackRangeBlocks(int range)	Sets the maximum block range at which players can see this entity type.
FabricEntityTypeBuilder<T>	trackRangeChunks(int range)	Sets the maximum chunk tracking range of this entity type.

Methods inherited from class java.lang.Object

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

Constructor Details

FabricEntityTypeBuilder

protected FabricEntityTypeBuilder(SpawnGroup spawnGroup,
 EntityType.EntityFactory<T> factory)

Method Details

create

public static <T extends Entity>
FabricEntityTypeBuilder<T> create()

Creates an entity type builder.

This entity's spawn group will automatically be set to SpawnGroup.MISC.

Type Parameters:

T - the type of entity

Returns:

a new entity type builder

create

public static <T extends Entity>
FabricEntityTypeBuilder<T> create(SpawnGroup spawnGroup)

Creates an entity type builder.

Type Parameters:

T - the type of entity

Parameters:

spawnGroup - the entity spawn group

Returns:

a new entity type builder

create

public static <T extends Entity>
FabricEntityTypeBuilder<T> create(SpawnGroup spawnGroup,
 EntityType.EntityFactory<T> factory)

Creates an entity type builder.

Type Parameters:

T - the type of entity

Parameters:

spawnGroup - the entity spawn group

factory - the entity factory used to create this entity

Returns:

a new entity type builder

createLiving

public static <T extends LivingEntity>
FabricEntityTypeBuilder.Living<T> createLiving()

Creates an entity type builder for a living entity.

This entity's spawn group will automatically be set to SpawnGroup.MISC.

Type Parameters:

T - the type of entity

Returns:

a new living entity type builder

createMob

public static <T extends MobEntity>
FabricEntityTypeBuilder.Mob<T> createMob()

Creates an entity type builder for a mob entity.

Type Parameters:

T - the type of entity

Returns:

a new mob entity type builder

spawnGroup

public FabricEntityTypeBuilder<T> spawnGroup(SpawnGroup group)

entityFactory

public <N extends T> FabricEntityTypeBuilder<N> entityFactory(EntityType.EntityFactory<N> factory)

disableSummon

public FabricEntityTypeBuilder<T> disableSummon()

Whether this entity type is summonable using the /summon command.

Returns:

this builder for chaining

disableSaving

public FabricEntityTypeBuilder<T> disableSaving()

fireImmune

public FabricEntityTypeBuilder<T> fireImmune()

Sets this entity type to be fire immune.

Returns:

this builder for chaining

spawnableFarFromPlayer

public FabricEntityTypeBuilder<T> spawnableFarFromPlayer()

Sets whether this entity type can be spawned far away from a player.

Returns:

this builder for chaining

dimensions

public FabricEntityTypeBuilder<T> dimensions(EntityDimensions dimensions)

Sets the dimensions of this entity type.

Parameters:

dimensions - the dimensions representing the entity's size

Returns:

this builder for chaining

trackable

@Deprecated
public FabricEntityTypeBuilder<T> trackable(int trackRangeBlocks,
 int trackedUpdateRate)

Deprecated.

use trackRangeBlocks(int), trackedUpdateRate(int) and forceTrackedVelocityUpdates(boolean)

trackable

@Deprecated
public FabricEntityTypeBuilder<T> trackable(int trackRangeBlocks,
 int trackedUpdateRate,
 boolean forceTrackedVelocityUpdates)

Deprecated.

use trackRangeBlocks(int), trackedUpdateRate(int) and forceTrackedVelocityUpdates(boolean)

trackRangeChunks

public FabricEntityTypeBuilder<T> trackRangeChunks(int range)

Sets the maximum chunk tracking range of this entity type.

Parameters:

range - the tracking range in chunks

Returns:

this builder for chaining

trackRangeBlocks

public FabricEntityTypeBuilder<T> trackRangeBlocks(int range)

Sets the maximum block range at which players can see this entity type.

Parameters:

range - the tracking range in blocks

Returns:

this builder for chaining

trackedUpdateRate

public FabricEntityTypeBuilder<T> trackedUpdateRate(int rate)

forceTrackedVelocityUpdates

public FabricEntityTypeBuilder<T> forceTrackedVelocityUpdates(boolean forceTrackedVelocityUpdates)

specificSpawnBlocks

public FabricEntityTypeBuilder<T> specificSpawnBlocks(Block... blocks)

Sets the ImmutableSet of blocks this entity can spawn on.

Parameters:

blocks - the blocks the entity can spawn on

Returns:

this builder for chaining

requires

public FabricEntityTypeBuilder<T> requires(FeatureFlag... requiredFeatures)

Sets the features this entity requires. If a feature is not enabled, the entity cannot be spawned, and existing ones will despawn immediately.

Parameters:

requiredFeatures - the features

Returns:

this builder for chaining

build

public EntityType<T> build()

Creates the entity type.

Returns:

a new EntityType