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.
import crafttweaker. api. entity. MCEntity ;
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.fandom.com/wiki/Commands/tag
Returns: True if the tag could ba added, and it did not replace a preexisting tag. False otherwise.
// MCEntity.addTag(tag as string) as boolean
myMCEntity. addTag ( "foundMesa" ) ;
Parameter Type Description tag string The name of the tag to add.
Adds velocity to this Entity.
Return Type: void
// MCEntity.addVelocity(x as double, y as double, z as double) as void
myMCEntity. addVelocity ( 5 , 9 , -1 ) ;
Parameter Type Description x double The amount of X velocity to add. y double The amount of Y velocity to add. z double The amount of Z velocity to add.
Applies entity collision between this Entity and the other Entity, pushing them away from each other.
Return Type: void
// MCEntity.applyEntityCollision(other as MCEntity) as void
myMCEntity. applyEntityCollision ( entity ) ;
Parameter Type Description other MCEntity The Entity to collide with.
Checks if this Entity can swim.
Returns: True if this Entity can swim. False otherwise.
// MCEntity.canSwim() as boolean
myMCEntity. canSwim ( ) ;
Teleports this Entity to the given world.
Return Type: void
// MCEntity.changeDimension(world as MCServerWorld) as void
myMCEntity. changeDimension ( world ) ;
Parameter Type Description world MCServerWorld The new world for the Entity.
Extinguishes the Entity if it is on fire.
Return Type: void
// MCEntity.extinguish() as void
myMCEntity. extinguish ( ) ;
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
// MCEntity.forceFireTicks(ticks as int) as void
myMCEntity. forceFireTicks ( 25 ) ;
Parameter Type Description ticks int The amount of ticks the Entity should burn for.
Forcefully sets this Entity to the new position.
Return Type: void
// MCEntity.forceSetPosition(x as double, y as double, z as double) as void
myMCEntity. forceSetPosition ( 5 , 2 , 9 ) ;
Parameter Type Description x double The new X value. y double The new Y value. z double The new Z value.
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.
// MCEntity.getAir() as int
myMCEntity. getAir ( ) ;
Gets how bright this Entity is.
Returns: How bright the Entity is.
// MCEntity.getBrightness() as float
myMCEntity. getBrightness ( ) ;
Gets the NBT data of this Entity.
Returns: The NBT data of this Entity.MapData
// MCEntity.getData() as MapData
myMCEntity. getData ( ) ;
Gets the distance between this Entity and the given Entity.
Returns: The distance between this Entity and the other Entity.
// MCEntity.getDistance(other as MCEntity) as float
myMCEntity. getDistance ( entity ) ;
Parameter Type Description other MCEntity The Entity to get the distance to.
Gets the squared distance from this Entity to the given Entity.
Returns: The squared distance between this Entity and the other Entity.
// MCEntity.getDistanceSq(other as MCEntity) as double
myMCEntity. getDistanceSq ( entity ) ;
Parameter Type Description other MCEntity The other Entity to check the squared distance to.
Gets the squared distance from this Entity's position to the given position.
Returns: The squared distance from this Entity to the given position.
// MCEntity.getDistanceSq(x as double, y as double, z as double) as double
myMCEntity. getDistanceSq ( 5 , 6 , 3 ) ;
Parameter Type Description x double The X value of the position to check against. y double The Y value of the position to check against. z double The Z value of the position to check against.
Gets this Entity's id that can be used to reference this Entity.
Returns: The id of this Entity.
// MCEntity.getEntityId() as int
myMCEntity. getEntityId ( ) ;
Gets which directions the Entity is currently facing.
Returns: An array of direction that the Entity is currently facingDirection []
// MCEntity.getFacingDirections() as Direction[]
myMCEntity. getFacingDirections ( ) ;
Gets the amount of ticks the Entity will be on fire for.
Returns: The amount of ticks the Entity will be on fire for.
// MCEntity.getFireTimer() as int
myMCEntity. getFireTimer ( ) ;
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.
// MCEntity.getMaxInPortalTime() as int
myMCEntity. getMaxInPortalTime ( ) ;
Gets the name of the Entity.
Returns: The name of the Entity.
// MCEntity.getName() as string
myMCEntity. getName ( ) ;
Gets this Entity's position in the world.
Returns: This Entity's position in the world.BlockPos
// MCEntity.getPosition() as BlockPos
myMCEntity. getPosition ( ) ;
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.fandom.com/wiki/Commands/tag
Returns: A set of all the Tags that an Entity has.
// MCEntity.getTags() as Set<string>
myMCEntity. getTags ( ) ;
Gets this Entity's type.
Returns: The type of this Entity.MCEntityType
// MCEntity.getType() as MCEntityType
myMCEntity. getType ( ) ;
Gets the UUID of this Entity.
Returns: The UUID of this Entity.
// MCEntity.getUUID() as string
myMCEntity. getUUID ( ) ;
Gets the World that this Entity is in.
Returns: The World this Entity is in.MCWorld
// MCEntity.getWorld() as MCWorld
myMCEntity. getWorld ( ) ;
Checks if this Entity has no gravity.
Returns: True if this Entity does not have gravity. False otherwise.
// MCEntity.hasNoGravity() as boolean
myMCEntity. hasNoGravity ( ) ;
Checks if this Entity is in the given range (distance) of the other Entity.
Returns: True if this Entity is in range. False otherwise.
// MCEntity.isEntityInRange(entity as MCEntity, distance as double) as boolean
myMCEntity. isEntityInRange ( entity, 2. 5 ) ;
Parameter Type Description entity MCEntity The Entity to check if it is in range. distance double The distance to check for.
Checks if this Entity is immune to fire.
Returns: True if this Entity is immune to fire. False otherwise.
// MCEntity.isImmuneToFire() as boolean
myMCEntity. isImmuneToFire ( ) ;
Checks if this Entity is in lava or not.
Returns: True if the this Entity is in lava.
// MCEntity.isInLava() as boolean
myMCEntity. isInLava ( ) ;
Checks if this Entity is in water.
Returns: True if this Entity is in water. False otherwise.
// MCEntity.isInWater() as boolean
myMCEntity. isInWater ( ) ;
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.
// MCEntity.isInWaterOrBubbleColumn() as boolean
myMCEntity. isInWaterOrBubbleColumn ( ) ;
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.
// MCEntity.isInWaterRainOrBubbleColumn() as boolean
myMCEntity. isInWaterRainOrBubbleColumn ( ) ;
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.
// MCEntity.isOffsetPositionInLiquid(x as double, y as double, z as double) as boolean
myMCEntity. isOffsetPositionInLiquid ( 5 , 4 , 5 ) ;
Parameter Type Description x double The X offset. y double The Y offset. z double The Z offset.
Checks whether the Entity is on the ground or not.
Returns: True if the Entity is on the ground. False otherwise.
// MCEntity.isOnGround() as boolean
myMCEntity. isOnGround ( ) ;
Checks if this Entity is silent.
Silent Entities do not play sounds.
Returns: True if this Entity is silent. False otherwise.
// MCEntity.isSilent() as boolean
myMCEntity. isSilent ( ) ;
Checks if this Entity is sneaking or not.
Returns: True if sneaking. False otherwise.
// MCEntity.isSneaking() as boolean
myMCEntity. isSneaking ( ) ;
Checks if this Entity is in spectator mode.
Returns: True if this Entity is in spectator mode. False otherwise.
// MCEntity.isSpectator() as boolean
myMCEntity. isSpectator ( ) ;
Checks if this Entity is wet.
Returns: True if this Entity is wet. False otherwise.
// MCEntity.isWet() as boolean
myMCEntity. isWet ( ) ;
Forcefully moves this Entity to the new position.
Return Type: void
// MCEntity.moveForced(x as double, y as double, z as double) as void
myMCEntity. moveForced ( 5 , 2 , 9 ) ;
Parameter Type Description x double The new X value. y double The new Y value. z double The new Z value.
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
// MCEntity.onCollideWithPlayer(playerEntity as MCPlayerEntity) as void
myMCEntity. onCollideWithPlayer ( player ) ;
Parameter Type Description playerEntity MCPlayerEntity The player to collide with.
Can be used to simulate the /kill command being used on the Entity.
Return Type: void
// MCEntity.onKillCommand() as void
myMCEntity. onKillCommand ( ) ;
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.
// MCEntity.onLivingFall(distance as float, damageMultiplier as float) as boolean
myMCEntity. onLivingFall ( 5 , 5 ) ;
Parameter Type Description distance float The distance the Entity has fallen. damageMultiplier float The damage multiplier.
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.fandom.com/wiki/Commands/tag
Returns: True if the Entity had the tag and it was removed. False otherwise.
// MCEntity.removeTag(tag as string) as boolean
myMCEntity. removeTag ( "foundMesa" ) ;
Parameter Type Description tag string The name of the tag to remove.
Sets the air value for the Entity
Return Type: void
// MCEntity.setAir(air as int) as void
myMCEntity. setAir ( 20 ) ;
Parameter Type Description air int The new air value.
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
// MCEntity.setEntityId(id as int) as void
myMCEntity. setEntityId ( 0 ) ;
Parameter Type Description id int 0
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
// MCEntity.setFire(seconds as int) as void
myMCEntity. setFire ( 5 ) ;
Parameter Type Description seconds int The amount of seconds the Entity should be on fire for.
Sets this Entity to have no gravity.
Return Type: void
// MCEntity.setNoGravity(noGravity as boolean) as void
myMCEntity. setNoGravity ( true ) ;
Parameter Type Description noGravity boolean The new gravity value.
Sets if the Entity should be considered on the ground or not.
Return Type: void
MCEntity. setOnGround ( grounded as boolean ) as void
Parameter Type Description grounded boolean If the Entity is on the ground or not.
Sets the position of this Entity.
Return Type: void
// MCEntity.setPosition(x as double, y as double, z as double) as void
myMCEntity. setPosition ( 5 , 2 , 59 ) ;
Parameter Type Description x double The new X position of the Entity. y double The new Y position of the Entity. z double The new Z position of the Entity.
Sets if this Entity is silent or not.
silent Entities do not play sounds.
Return Type: void
// MCEntity.setSilent(isSilent as boolean) as void
myMCEntity. setSilent ( true ) ;
Parameter Type Description isSilent boolean If the Entity should be silent or not.
Sets the sneaking value of this Entity.
Return Type: void
// MCEntity.setSneaking(value as boolean) as void
myMCEntity. setSneaking ( true ) ;
Parameter Type Description value boolean The new sneaking value
Teleports the entity, forcing the destination to stay loaded for a short time
Return Type: void
// MCEntity.teleportKeepLoaded(x as double, y as double, z as double) as void
myMCEntity. teleportKeepLoaded ( 20 , 40 , 60 ) ;
Parameter Type Description x double No Description Provided y double No Description Provided z double No Description Provided
Updates the NBT data of this Entity.
Return Type: void
// MCEntity.updateData(data as MapData) as void
myMCEntity. updateData ( { key: "value" } ) ;
Parameter Type Description data MapData The new Data for this Entity
Name Type Has Getter Has Setter Description air int true true Gets the air value for the Entity. canSwim boolean true false Checks if this Entity can swim. data MapData true false Gets the NBT data of this Entity. facingDirections Direction []true false Gets which directions the Entity is currently facing. id int true false Gets this Entity's id that can be used to reference this Entity. inLava boolean true false Checks if this Entity is in lava or not. inWater boolean true false Checks if this Entity is in water. isWet boolean true false Checks if this Entity is wet. name string true false Gets the name of the Entity. onGround MCEntity true true Sets if the Entity should be considered on the ground or not. position BlockPos true false Gets this Entity's position in the world. silent boolean true true Checks if this Entity is silent. sneaking boolean true true Checks if this Entity is sneaking or not. spectator boolean true false Checks if this Entity is in spectator mode. type MCEntityType true false Gets this Entity's type. uuid string true false Gets the UUID of this Entity. world MCWorld true false Gets the World that this Entity is in.
