EntityType

Version:

Home Commands Examples Getting Started With Scripts Global Keywords 1.21 Migration Guide

Entity EntityAccess EntityDimensions EntityIngredient EntityType HumanoidArm INameTagFunction LivingEntity MobCategory MobSpawnType NameTagResult RemovalReason Shearable Targeting

BracketDumpers BracketHandlers BracketValidators ResourceLocationBracketHandler

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.api.entity.EntityType;

Implements

Undocumented Interfaces

FeatureElement,EntityTypeTest<Entity, Entity>

Operators

Combines two entity ingredients.

// (EntityType<T : Entity> | (other as EntityIngredient)) as EntityIngredient
myEntityType | myCTEntityIngredient

Parameters:

other: EntityIngredient Type: EntityIngredient - The second entity ingredient.

Return Type: EntityIngredient

Members

Casts the entity type to an entity ingredient.

// EntityType<T : Entity> as EntityIngredient
myEntityType as CTEntityIngredient

Return Type: EntityIngredient

Checks if the entity can spawn far from the player.

// EntityType<T : Entity>.canSpawnFarFromPlayer as bool
myEntityType.canSpawnFarFromPlayer

Return Type: bool

Checks if the entity can spawn far from the player.

Returns: True if the entity can spawn far from the player.

// EntityType<T : Entity>.canSpawnFarFromPlayer() as bool;
myEntityType.canSpawnFarFromPlayer();

Return Type: bool

Checks if the entity can be summoned.

// EntityType<T : Entity>.canSummon as bool
myEntityType.canSummon

Return Type: bool

Checks if the entity can be summoned.

Returns: True if the entity can be summoned.

// EntityType<T : Entity>.canSummon() as bool;
myEntityType.canSummon();

Return Type: bool

Gets the category of the entity.

// EntityType<T : Entity>.category as MobCategory
myEntityType.category

Return Type: MobCategory

Gets the category of the entity.

Returns: The category of the entity.

// EntityType<T : Entity>.category() as MobCategory;
myEntityType.category();

Return Type: MobCategory

Gets the command string of the entity.

// EntityType<T : Entity>.commandString as string
myEntityType.commandString

Return Type: string

Creates an entity.

Returns: The created entity.

// EntityType<T : Entity>.create(level as Level) as Entity;
myEntityType.create(myLevel);

Parameters:

level: Level Type: Level - The level to create the entity in.

Return Type: Entity

Gets the default loot table of the entity.

// EntityType<T : Entity>.defaultLootTable as ResourceLocation
myEntityType.defaultLootTable

Return Type: ResourceLocation

Gets the description of the entity.

// EntityType<T : Entity>.description as Component
myEntityType.description

Return Type: Component

Gets the description of the entity.

Returns: The description of the entity.

// EntityType<T : Entity>.description() as Component;
myEntityType.description();

Return Type: Component

Gets the description ID of the entity.

// EntityType<T : Entity>.descriptionId as string
myEntityType.descriptionId

Return Type: string

Gets the description ID of the entity.

Returns: The description ID of the entity.

// EntityType<T : Entity>.descriptionId() as string;
myEntityType.descriptionId();

Return Type: string

Gets the dimensions of the entity.

// EntityType<T : Entity>.dimensions as EntityDimensions
myEntityType.dimensions

Return Type: EntityDimensions

Gets the dimensions of the entity.

Returns: The dimensions of the entity.

// EntityType<T : Entity>.dimensions() as EntityDimensions;
myEntityType.dimensions();

Return Type: EntityDimensions

Checks if the entity is fire immune.

// EntityType<T : Entity>.fireImmune as bool
myEntityType.fireImmune

Return Type: bool

Checks if the entity is fire immune.

Returns: True if the entity is fire immune.

// EntityType<T : Entity>.fireImmune() as bool;
myEntityType.fireImmune();

Return Type: bool

Gets the height of the entity.

// EntityType<T : Entity>.height as float
myEntityType.height

Return Type: float

Gets the height of the entity.

Returns: The height of the entity.

// EntityType<T : Entity>.height() as float;
myEntityType.height();

Return Type: float

Checks if the entity is dangerous to blocks.

Returns: True if the entity is dangerous to blocks.

// EntityType<T : Entity>.isBlockDangerous(state as BlockState) as bool;
myEntityType.isBlockDangerous(myBlockState);

Parameters:

state: BlockState Type: BlockState - The state of the block to check.

Return Type: bool

Checks if the entity is in a tag.

Returns: True if the entity is in the tag.

// EntityType<T : Entity>.isIn(tag as KnownTag<EntityType<Entity>>) as bool;
myEntityType.isIn(myKnownTag);

Parameters:

tag: KnownTag<EntityType<Entity>> Type: KnownTag<EntityType<Entity>> - The tag to check.

Return Type: bool

Gets the registry name of the entity.

// EntityType<T : Entity>.registryName as ResourceLocation
myEntityType.registryName

Return Type: ResourceLocation

Gets the registry name of the entity.

Returns: The registry name of the entity.

// EntityType<T : Entity>.registryName() as ResourceLocation;
myEntityType.registryName();

Return Type: ResourceLocation

Spawns an entity.

Returns: The spawned entity.

// EntityType<T : Entity>.spawn(level as ServerLevel, spawnStack as IItemStack, spawningPlayer as Player, position as BlockPos, spawnType as MobSpawnType, alignPosition as bool, invertY as bool) as Entity;
myEntityType.spawn(myServerLevel, myIItemStack, myPlayer, myBlockPos, myMobSpawnType, myBool, myBool);

Parameters:

level: ServerLevel Type: ServerLevel - The level to spawn the entity in.

spawnStack: IItemStack Type: IItemStack - The stack to spawn the entity with.

spawningPlayer: Player Type: Player - The player that is spawning the entity.

position: BlockPos Type: BlockPos - The position to spawn the entity at.

spawnType: MobSpawnType Type: MobSpawnType - The type of spawn to use.

alignPosition: bool Type: bool - Whether to align the position of the entity.

invertY: bool Type: bool - Whether to offset the y position of the entity.

Return Type: Entity

Spawns an entity.

Returns: The spawned entity.

// EntityType<T : Entity>.spawn(level as ServerLevel, position as BlockPos, spawnType as MobSpawnType) as Entity;
myEntityType.spawn(myServerLevel, myBlockPos, myMobSpawnType);

Parameters:

level: ServerLevel Type: ServerLevel - The level to spawn the entity in.

position: BlockPos Type: BlockPos - The position to spawn the entity at.

spawnType: MobSpawnType Type: MobSpawnType - The type of spawn to use.

Return Type: Entity

Spawns an entity.

Returns: The spawned entity.

// EntityType<T : Entity>.spawn(level as ServerLevel, onSpawn as function(t as Entity) as void, position as BlockPos, spawnType as MobSpawnType, alignPosition as bool, invertY as bool) as Entity;
myEntityType.spawn(myServerLevel, myConsumer, myBlockPos, myMobSpawnType, myBool, myBool);

Parameters:

level: ServerLevel Type: ServerLevel - The level to spawn the entity in.

onSpawn: function(t as Entity) as void Type: function(t as Entity) as void - The consumer to call when the entity is spawned.

position: BlockPos Type: BlockPos - The position to spawn the entity at.

spawnType: MobSpawnType Type: MobSpawnType - The type of spawn to use.

alignPosition: bool Type: bool - Whether to align the position of the entity.

invertY: bool Type: bool - Whether to offset the y position of the entity.

Return Type: Entity

Gets the short string representation of the entity.

// EntityType<T : Entity>.toShortString as string
myEntityType.toShortString

Return Type: string

Gets the short string representation of the entity.

Returns: The short string representation of the entity.

// EntityType<T : Entity>.toShortString() as string;
myEntityType.toShortString();

Return Type: string

Gets the width of the entity.

// EntityType<T : Entity>.width as float
myEntityType.width

Return Type: float

Gets the width of the entity.

Returns: The width of the entity.

// EntityType<T : Entity>.width() as float;
myEntityType.width();

Return Type: float