MCEntity - CraftTweaker Documentation

Version:

Language:

Home Migration Guide Getting Started With Scripts Commands Examples

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.entity.MCEntity;

Extending CapabilityProvider<MCEntity>

MCEntity extends CapabilityProvider<MCEntity>. That means all methods available in CapabilityProvider<MCEntity> are also available in MCEntity

Methods

addTag

Name: addTag

Adds a new tag to the Entity.

There is a limit of 1024 tags per Entity.

These are not tags like MCTag, these are tags that are added by the /tag command.

You can read more about how they can be used here: https://minecraft.wiki/w/Commands/tag

Returns: True if the tag could ba added, and it did not replace a preexisting tag. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.addTag(tag as string) as boolean

myMCEntity.addTag("foundMesa");

Parameter	Type	Description
Parameter tag	Type string	Description The name of the tag to add.

addVelocity

Name: addVelocity

Adds velocity to this Entity.

Return Type: void

ZenScript
 Copy
// MCEntity.addVelocity(x as double, y as double, z as double) as void

myMCEntity.addVelocity(5, 9, -1);

Parameter	Type	Description
Parameter x	Type double	Description The amount of X velocity to add.
Parameter y	Type double	Description The amount of Y velocity to add.
Parameter z	Type double	Description The amount of Z velocity to add.

applyEntityCollision

Name: applyEntityCollision

Applies entity collision between this Entity and the other Entity, pushing them away from each other.

Return Type: void

ZenScript
 Copy
// MCEntity.applyEntityCollision(other as MCEntity) as void

myMCEntity.applyEntityCollision(entity);

Parameter	Type	Description
Parameter other	Type MCEntity	Description The Entity to collide with.

canSwim

Name: canSwim

Checks if this Entity can swim.

Returns: True if this Entity can swim. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.canSwim() as boolean

myMCEntity.canSwim();

changeDimension

Name: changeDimension

Teleports this Entity to the given world.

Return Type: void

ZenScript
 Copy
// MCEntity.changeDimension(world as MCServerWorld) as void

myMCEntity.changeDimension(world);

Parameter	Type	Description
Parameter world	Type MCServerWorld	Description The new world for the Entity.

dismount

Name: dismount

Return Type: void

ZenScript
 Copy
// MCEntity.dismount() as void

myMCEntity.dismount();

extinguish

Name: extinguish

Extinguishes the Entity if it is on fire.

Return Type: void

ZenScript
 Copy
// MCEntity.extinguish() as void

myMCEntity.extinguish();

forceFireTicks

Name: forceFireTicks

Sets the Entity on fire for the given amount of ticks.

This method can be used to override how long the Entity is on fire for.

Return Type: void

ZenScript
 Copy
// MCEntity.forceFireTicks(ticks as int) as void

myMCEntity.forceFireTicks(25);

Parameter	Type	Description
Parameter ticks	Type int	Description The amount of ticks the Entity should burn for.

forceSetPosition

Name: forceSetPosition

Forcefully sets this Entity to the new position.

Return Type: void

ZenScript
 Copy
// MCEntity.forceSetPosition(x as double, y as double, z as double) as void

myMCEntity.forceSetPosition(5, 2, 9);

Parameter	Type	Description
Parameter x	Type double	Description The new X value.
Parameter y	Type double	Description The new Y value.
Parameter z	Type double	Description The new Z value.

getAir

Name: getAir

Gets the air value for the Entity. The air value is used to determine when the Entity will start drowning when swimming.

Returns: The air value of the Entity.
Return Type: int

ZenScript
 Copy
// MCEntity.getAir() as int

myMCEntity.getAir();

getBrightness

Name: getBrightness

Gets how bright this Entity is.

Returns: How bright the Entity is.
Return Type: float

ZenScript
 Copy
// MCEntity.getBrightness() as float

myMCEntity.getBrightness();

getData

Name: getData

Gets the NBT data of this Entity.

Returns: The NBT data of this Entity.
Return Type: MapData

ZenScript
 Copy
// MCEntity.getData() as MapData

myMCEntity.getData();

getDistance

Name: getDistance

Gets the distance between this Entity and the given Entity.

Returns: The distance between this Entity and the other Entity.
Return Type: float

ZenScript
 Copy
// MCEntity.getDistance(other as MCEntity) as float

myMCEntity.getDistance(entity);

Parameter	Type	Description
Parameter other	Type MCEntity	Description The Entity to get the distance to.

getDistanceSq

Name: getDistanceSq

Gets the squared distance from this Entity to the given Entity.

Returns: The squared distance between this Entity and the other Entity.
Return Type: double

ZenScript
 Copy
// MCEntity.getDistanceSq(other as MCEntity) as double

myMCEntity.getDistanceSq(entity);

Parameter	Type	Description
Parameter other	Type MCEntity	Description The other Entity to check the squared distance to.

getDistanceSq

Name: getDistanceSq

Gets the squared distance from this Entity's position to the given position.

Returns: The squared distance from this Entity to the given position.
Return Type: double

ZenScript
 Copy
// MCEntity.getDistanceSq(x as double, y as double, z as double) as double

myMCEntity.getDistanceSq(5, 6, 3);

Parameter	Type	Description
Parameter x	Type double	Description The X value of the position to check against.
Parameter y	Type double	Description The Y value of the position to check against.
Parameter z	Type double	Description The Z value of the position to check against.

getEntityId

Name: getEntityId

Gets this Entity's id that can be used to reference this Entity.

Returns: The id of this Entity.
Return Type: int

ZenScript
 Copy
// MCEntity.getEntityId() as int

myMCEntity.getEntityId();

getFacingDirections

Name: getFacingDirections

Gets which directions the Entity is currently facing.

Returns: An array of direction that the Entity is currently facing
Return Type: Direction[]

ZenScript
 Copy
// MCEntity.getFacingDirections() as Direction[]

myMCEntity.getFacingDirections();

getFireTimer

Name: getFireTimer

Gets the amount of ticks the Entity will be on fire for.

Returns: The amount of ticks the Entity will be on fire for.
Return Type: int

ZenScript
 Copy
// MCEntity.getFireTimer() as int

myMCEntity.getFireTimer();

getMaxInPortalTime

Name: getMaxInPortalTime

Gets the maximum amount of time the Entity needs to be in the portal before they are teleported.

Returns: The amount of time required for the Entity to be in the nether portal before being teleported.
Return Type: int

ZenScript
 Copy
// MCEntity.getMaxInPortalTime() as int

myMCEntity.getMaxInPortalTime();

getName

Name: getName

Gets the name of the Entity.

Returns: The name of the Entity.
Return Type: string

ZenScript
 Copy
// MCEntity.getName() as string

myMCEntity.getName();

getPersistentData

Name: getPersistentData

Gets the persisted NBT tag.

Return Type: MapData

ZenScript
 Copy
// MCEntity.getPersistentData() as MapData

myMCEntity.getPersistentData();

getPosition

Name: getPosition

Gets this Entity's position in the world.

Returns: This Entity's position in the world.
Return Type: BlockPos

ZenScript
 Copy
// MCEntity.getPosition() as BlockPos

myMCEntity.getPosition();

getPositionVec

Name: getPositionVec

Return Type: MCVector3d

ZenScript
 Copy
// MCEntity.getPositionVec() as MCVector3d

myMCEntity.getPositionVec();

getRotationPitch

Name: getRotationPitch

Return Type: float

ZenScript
 Copy
// MCEntity.getRotationPitch() as float

myMCEntity.getRotationPitch();

getRotationYaw

Name: getRotationYaw

Return Type: float

ZenScript
 Copy
// MCEntity.getRotationYaw() as float

myMCEntity.getRotationYaw();

getTags

Name: getTags

Gets all the tags that are attached to the entity.

These are not tags like MCTag, these are tags that are added by the /tag command.

You can read more about how they can be used here: https://minecraft.wiki/w/Commands/tag

Returns: A set of all the Tags that an Entity has.
Return Type: Set<string>

ZenScript
 Copy
// MCEntity.getTags() as Set<string>

myMCEntity.getTags();

getType

Name: getType

Gets this Entity's type.

Returns: The type of this Entity.
Return Type: MCEntityType

ZenScript
 Copy
// MCEntity.getType() as MCEntityType

myMCEntity.getType();

getUUID

Name: getUUID

Gets the UUID of this Entity.

Returns: The UUID of this Entity.
Return Type: string

ZenScript
 Copy
// MCEntity.getUUID() as string

myMCEntity.getUUID();

getWorld

Name: getWorld

Gets the World that this Entity is in.

Returns: The World this Entity is in.
Return Type: MCWorld

ZenScript
 Copy
// MCEntity.getWorld() as MCWorld

myMCEntity.getWorld();

hasNoGravity

Name: hasNoGravity

Checks if this Entity has no gravity.

Returns: True if this Entity does not have gravity. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.hasNoGravity() as boolean

myMCEntity.hasNoGravity();

isEntityInRange

Name: isEntityInRange

Checks if this Entity is in the given range (distance) of the other Entity.

Returns: True if this Entity is in range. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isEntityInRange(entity as MCEntity, distance as double) as boolean

myMCEntity.isEntityInRange(entity, 2.5);

Parameter	Type	Description
Parameter entity	Type MCEntity	Description The Entity to check if it is in range.
Parameter distance	Type double	Description The distance to check for.

isImmuneToFire

Name: isImmuneToFire

Checks if this Entity is immune to fire.

Returns: True if this Entity is immune to fire. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isImmuneToFire() as boolean

myMCEntity.isImmuneToFire();

isInLava

Name: isInLava

Checks if this Entity is in lava or not.

Returns: True if the this Entity is in lava.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isInLava() as boolean

myMCEntity.isInLava();

isInWater

Name: isInWater

Checks if this Entity is in water.

Returns: True if this Entity is in water. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isInWater() as boolean

myMCEntity.isInWater();

isInWaterOrBubbleColumn

Name: isInWaterOrBubbleColumn

Checks if this Entity is in water or a bubble column.

Returns: True if this entity is in water or a bubble column. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isInWaterOrBubbleColumn() as boolean

myMCEntity.isInWaterOrBubbleColumn();

isInWaterRainOrBubbleColumn

Name: isInWaterRainOrBubbleColumn

Checks if this Entity is in rain or a bubble column.

Returns: True if this entity is in rain or a bubble column. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isInWaterRainOrBubbleColumn() as boolean

myMCEntity.isInWaterRainOrBubbleColumn();

isOffsetPositionInLiquid

Name: isOffsetPositionInLiquid

Checks if the offset position from the Entity's current position is inside of a liquid.

Returns: True if the offset position is in a liquid. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isOffsetPositionInLiquid(x as double, y as double, z as double) as boolean

myMCEntity.isOffsetPositionInLiquid(5, 4, 5);

Parameter	Type	Description
Parameter x	Type double	Description The X offset.
Parameter y	Type double	Description The Y offset.
Parameter z	Type double	Description The Z offset.

isOnGround

Name: isOnGround

Checks whether the Entity is on the ground or not.

Returns: True if the Entity is on the ground. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isOnGround() as boolean

myMCEntity.isOnGround();

isSilent

Name: isSilent

Checks if this Entity is silent.

Silent Entities do not play sounds.

Returns: True if this Entity is silent. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isSilent() as boolean

myMCEntity.isSilent();

isSneaking

Name: isSneaking

Checks if this Entity is sneaking or not.

Returns: True if sneaking. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isSneaking() as boolean

myMCEntity.isSneaking();

isSpectator

Name: isSpectator

Checks if this Entity is in spectator mode.

Returns: True if this Entity is in spectator mode. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isSpectator() as boolean

myMCEntity.isSpectator();

isWet

Name: isWet

Checks if this Entity is wet.

Returns: True if this Entity is wet. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.isWet() as boolean

myMCEntity.isWet();

moveForced

Name: moveForced

Forcefully moves this Entity to the new position.

Return Type: void

ZenScript
 Copy
// MCEntity.moveForced(x as double, y as double, z as double) as void

myMCEntity.moveForced(5, 2, 9);

Parameter	Type	Description
Parameter x	Type double	Description The new X value.
Parameter y	Type double	Description The new Y value.
Parameter z	Type double	Description The new Z value.

onCollideWithPlayer

Name: onCollideWithPlayer

Triggers the collide effect between this Entity and the player.

Some examples of collide effects are: Puffer fish damaging and applying poison. Experience orbs being collected.

Return Type: void

ZenScript
 Copy
// MCEntity.onCollideWithPlayer(playerEntity as MCPlayerEntity) as void

myMCEntity.onCollideWithPlayer(player);

Parameter	Type	Description
Parameter playerEntity	Type MCPlayerEntity	Description The player to collide with.

onKillCommand

Name: onKillCommand

Can be used to simulate the /kill command being used on the Entity.

Return Type: void

ZenScript
 Copy
// MCEntity.onKillCommand() as void

myMCEntity.onKillCommand();

onLivingFall

Name: onLivingFall

Can be used to simulate the Entity falling the given distance with the given damage multiplier.

Returns: True if the Entity took damage. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.onLivingFall(distance as float, damageMultiplier as float) as boolean

myMCEntity.onLivingFall(5, 5);

Parameter	Type	Description
Parameter distance	Type float	Description The distance the Entity has fallen.
Parameter damageMultiplier	Type float	Description The damage multiplier.

remove

Name: remove

Removes the entity from the world.

Return Type: void

ZenScript
 Copy
// MCEntity.remove() as void

myMCEntity.remove();

removePassengers

Name: removePassengers

Return Type: void

ZenScript
 Copy
// MCEntity.removePassengers() as void

myMCEntity.removePassengers();

removeTag

Name: removeTag

Removes a tag from the Entity.

These are not tags like MCTag, these are tags that are added by the /tag command.

You can read more about how they can be used here: https://minecraft.wiki/w/Commands/tag

Returns: True if the Entity had the tag and it was removed. False otherwise.
Return Type: boolean

ZenScript
 Copy
// MCEntity.removeTag(tag as string) as boolean

myMCEntity.removeTag("foundMesa");

Parameter	Type	Description
Parameter tag	Type string	Description The name of the tag to remove.

setAir

Name: setAir

Sets the air value for the Entity

Return Type: void

ZenScript
 Copy
// MCEntity.setAir(air as int) as void

myMCEntity.setAir(20);

Parameter	Type	Description
Parameter air	Type int	Description The new air value.

setEntityId

Name: setEntityId

This method is marked for removal next breaking change.

It sets the ID of the entity, which is only used in networking code and should never have to be called by mods or scripts.

Return Type: void

ZenScript
 Copy
// MCEntity.setEntityId(id as int) as void

myMCEntity.setEntityId(0);

Parameter	Type	Description
Parameter id	Type int	Description 0

setFire

Name: setFire

Sets the Entity on fire for the given amount of seconds.

This does not take ticks, it only takes full seconds, and you cannot lower the amount of fire ticks the entity has.

Return Type: void

ZenScript
 Copy
// MCEntity.setFire(seconds as int) as void

myMCEntity.setFire(5);

Parameter	Type	Description
Parameter seconds	Type int	Description The amount of seconds the Entity should be on fire for.

setLocationAndAngles

Name: setLocationAndAngles

Sets the location and looking angles of the entity.

Return Type: void

ZenScript
 Copy
// MCEntity.setLocationAndAngles(x as double, y as double, z as double, yaw as float, pitch as float) as void

myMCEntity.setLocationAndAngles(5, 1, 9, 90, 120);

Parameter	Type	Description
Parameter x	Type double	Description The new x position.
Parameter y	Type double	Description The new y position.
Parameter z	Type double	Description The new z position.
Parameter yaw	Type float	Description The new yaw value.
Parameter pitch	Type float	Description The new pitch value.

setNoGravity

Name: setNoGravity

Sets this Entity to have no gravity.

Return Type: void

ZenScript
 Copy
// MCEntity.setNoGravity(noGravity as boolean) as void

myMCEntity.setNoGravity(true);

Parameter	Type	Description
Parameter noGravity	Type boolean	Description The new gravity value.

setOnGround

Name: setOnGround

Sets if the Entity should be considered on the ground or not.

Return Type: void

ZenScript
 Copy
MCEntity.setOnGround(grounded as boolean) as void

Parameter	Type	Description
Parameter grounded	Type boolean	Description If the Entity is on the ground or not.

setPosition

Name: setPosition

Sets the position of this Entity.

Return Type: void

ZenScript
 Copy
// MCEntity.setPosition(x as double, y as double, z as double) as void

myMCEntity.setPosition(5, 2, 59);

Parameter	Type	Description
Parameter x	Type double	Description The new X position of the Entity.
Parameter y	Type double	Description The new Y position of the Entity.
Parameter z	Type double	Description The new Z position of the Entity.

setPositionAndUpdate

Name: setPositionAndUpdate

Return Type: void

ZenScript
 Copy
MCEntity.setPositionAndUpdate(x as double, y as double, z as double) as void

Parameter	Type	Description
Parameter x	Type double	Description No Description Provided
Parameter y	Type double	Description No Description Provided
Parameter z	Type double	Description No Description Provided

setRotationPitch

Name: setRotationPitch

Return Type: void

ZenScript
 Copy
MCEntity.setRotationPitch(newPitch as float) as void

Parameter	Type	Description
Parameter newPitch	Type float	Description No Description Provided

setRotationYaw

Name: setRotationYaw

Return Type: void

ZenScript
 Copy
MCEntity.setRotationYaw(newYaw as float) as void

Parameter	Type	Description
Parameter newYaw	Type float	Description No Description Provided

setSilent

Name: setSilent

Sets if this Entity is silent or not.

silent Entities do not play sounds.

Return Type: void

ZenScript
 Copy
// MCEntity.setSilent(isSilent as boolean) as void

myMCEntity.setSilent(true);

Parameter	Type	Description
Parameter isSilent	Type boolean	Description If the Entity should be silent or not.

setSneaking

Name: setSneaking

Sets the sneaking value of this Entity.

Return Type: void

ZenScript
 Copy
// MCEntity.setSneaking(value as boolean) as void

myMCEntity.setSneaking(true);

Parameter	Type	Description
Parameter value	Type boolean	Description The new sneaking value

startRiding

Name: startRiding

Return Type: boolean

ZenScript
 Copy
MCEntity.startRiding(other as MCEntity, forced as boolean) as boolean

Parameter	Type	Description	Optional	DefaultValue
Parameter other	Type MCEntity	Description No Description Provided	Optional false	DefaultValue
Parameter forced	Type boolean	Description No Description Provided	Optional true	DefaultValue false

teleportKeepLoaded

Name: teleportKeepLoaded

Teleports the entity, forcing the destination to stay loaded for a short time

Return Type: void

ZenScript
 Copy
// MCEntity.teleportKeepLoaded(x as double, y as double, z as double) as void

myMCEntity.teleportKeepLoaded(20, 40, 60);

Parameter	Type	Description
Parameter x	Type double	Description No Description Provided
Parameter y	Type double	Description No Description Provided
Parameter z	Type double	Description No Description Provided

updateData

Name: updateData

Updates the NBT data of this Entity.

Return Type: void

ZenScript
 Copy
// MCEntity.updateData(data as MapData) as void

myMCEntity.updateData({key: "value"});

Parameter	Type	Description
Parameter data	Type MapData	Description The new Data for this Entity

updatePersistentData

Name: updatePersistentData

Updates the persisted data.

Return Type: void

ZenScript
 Copy
MCEntity.updatePersistentData(data as MapData) as void

Parameter	Type	Description
Parameter data	Type MapData	Description No Description Provided

Properties

Name	Type	Has Getter	Has Setter	Description
Name air	Type int	Has Getter true	Has Setter true	Description Gets the air value for the Entity. The air value is used to determine when the Entity will start drowning when swimming.
Name canSwim	Type boolean	Has Getter true	Has Setter false	Description Checks if this Entity can swim.
Name data	Type MapData	Has Getter true	Has Setter false	Description Gets the NBT data of this Entity.
Name facingDirections	Type Direction[]	Has Getter true	Has Setter false	Description Gets which directions the Entity is currently facing.
Name id	Type int	Has Getter true	Has Setter false	Description Gets this Entity's id that can be used to reference this Entity.
Name inLava	Type boolean	Has Getter true	Has Setter false	Description Checks if this Entity is in lava or not.
Name inWater	Type boolean	Has Getter true	Has Setter false	Description Checks if this Entity is in water.
Name isWet	Type boolean	Has Getter true	Has Setter false	Description Checks if this Entity is wet.
Name name	Type string	Has Getter true	Has Setter false	Description Gets the name of the Entity.
Name onGround	Type MCEntity	Has Getter true	Has Setter true	Description Sets if the Entity should be considered on the ground or not.
Name persistedData	Type MapData	Has Getter true	Has Setter false	Description Gets the persisted NBT tag.
Name position	Type BlockPos	Has Getter true	Has Setter false	Description Gets this Entity's position in the world.
Name positionVec	Type MCVector3d	Has Getter true	Has Setter false	Description No Description Provided
Name rotationPitch	Type float	Has Getter true	Has Setter true	Description No Description Provided
Name rotationYaw	Type float	Has Getter true	Has Setter true	Description No Description Provided
Name silent	Type boolean	Has Getter true	Has Setter true	Description Checks if this Entity is silent. Silent Entities do not play sounds.
Name sneaking	Type boolean	Has Getter true	Has Setter true	Description Checks if this Entity is sneaking or not.
Name spectator	Type boolean	Has Getter true	Has Setter false	Description Checks if this Entity is in spectator mode.
Name type	Type MCEntityType	Has Getter true	Has Setter false	Description Gets this Entity's type.
Name uuid	Type string	Has Getter true	Has Setter false	Description Gets the UUID of this Entity.
Name world	Type MCWorld	Has Getter true	Has Setter false	Description Gets the World that this Entity is in.