MCEntity
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.
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
Adds a new tag to the Entity.
There is a limit of 1024 tags per Entity.
These are not tags like MCTag
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
// 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. |
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 |
|---|---|---|
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. |
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 |
|---|---|---|
Parameter other | Type MCEntity | Description The Entity to collide with. |
Checks if this Entity can swim.
Returns: True if this Entity can swim. False otherwise.
Return Type: boolean
// 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 |
|---|---|---|
Parameter world | Type MCServerWorld | Description The new world for the Entity. |
Return Type: void
// MCEntity.dismount() as void
myMCEntity.dismount();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 |
|---|---|---|
Parameter ticks | Type int | Description 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 |
|---|---|---|
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. |
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
// MCEntity.getAir() as int
myMCEntity.getAir();Gets how bright this Entity is.
Returns: How bright the Entity is.
Return Type: float
// MCEntity.getBrightness() as float
myMCEntity.getBrightness();Gets the NBT data of this Entity.
Returns: The NBT data of this Entity.
Return Type: 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.
Return Type: float
// 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. |
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
// 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. |
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
// 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. |
Gets this Entity’s id that can be used to reference this Entity.
Returns: The id of this Entity.
Return Type: int
// MCEntity.getEntityId() as int
myMCEntity.getEntityId();Gets which directions the Entity is currently facing.
Returns: An array of direction that the Entity is currently facing
Return Type: Direction[]
// 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.
Return Type: int
// 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.
Return Type: int
// MCEntity.getMaxInPortalTime() as int
myMCEntity.getMaxInPortalTime();Gets the name of the Entity.
Returns: The name of the Entity.
Return Type: string
// MCEntity.getName() as string
myMCEntity.getName();Gets the persisted NBT tag.
Return Type: MapData
// MCEntity.getPersistentData() as MapData
myMCEntity.getPersistentData();Gets this Entity’s position in the world.
Returns: This Entity’s position in the world.
Return Type: BlockPos
// MCEntity.getPosition() as BlockPos
myMCEntity.getPosition();Return Type: MCVector3d
// MCEntity.getPositionVec() as MCVector3d
myMCEntity.getPositionVec();Return Type: float
// MCEntity.getRotationPitch() as float
myMCEntity.getRotationPitch();Return Type: float
// MCEntity.getRotationYaw() as float
myMCEntity.getRotationYaw();Gets all the tags that are attached to the entity.
These are not tags like MCTag
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>
// MCEntity.getTags() as Set<string>
myMCEntity.getTags();Gets this Entity’s type.
Returns: The type of this Entity.
Return Type: MCEntityType
// MCEntity.getType() as MCEntityType
myMCEntity.getType();Gets the UUID of this Entity.
Returns: The UUID of this Entity.
Return Type: string
// MCEntity.getUUID() as string
myMCEntity.getUUID();Gets the World that this Entity is in.
Returns: The World this Entity is in.
Return Type: 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.
Return Type: boolean
// 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.
Return Type: boolean
// 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. |
Checks if this Entity is immune to fire.
Returns: True if this Entity is immune to fire. False otherwise.
Return Type: boolean
// MCEntity.isImmuneToFire() as boolean
myMCEntity.isImmuneToFire();Checks if this Entity is in lava or not.
Returns: True if the this Entity is in lava.
Return Type: boolean
// MCEntity.isInLava() as boolean
myMCEntity.isInLava();Checks if this Entity is in water.
Returns: True if this Entity is in water. False otherwise.
Return Type: boolean
// 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.
Return Type: boolean
// MCEntity.isInWaterOrBubbleColumn() as boolean
myMCEntity.isInWaterOrBubbleColumn();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
// 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.
Return Type: boolean
// 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. |
Checks whether the Entity is on the ground or not.
Returns: True if the Entity is on the ground. False otherwise.
Return Type: boolean
// 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.
Return Type: boolean
// MCEntity.isSilent() as boolean
myMCEntity.isSilent();Checks if this Entity is sneaking or not.
Returns: True if sneaking. False otherwise.
Return Type: boolean
// 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.
Return Type: boolean
// MCEntity.isSpectator() as boolean
myMCEntity.isSpectator();Checks if this Entity is wet.
Returns: True if this Entity is wet. False otherwise.
Return Type: boolean
// 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 |
|---|---|---|
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. |
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 |
|---|---|---|
Parameter playerEntity | Type MCPlayerEntity | Description 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.
Return Type: boolean
// 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. |
Removes the entity from the world.
Return Type: void
// MCEntity.remove() as void
myMCEntity.remove();Return Type: void
// MCEntity.removePassengers() as void
myMCEntity.removePassengers();Removes a tag from the Entity.
These are not tags like MCTag
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
// 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. |
Sets the air value for the Entity
Return Type: void
// MCEntity.setAir(air as int) as void
myMCEntity.setAir(20);| Parameter | Type | Description |
|---|---|---|
Parameter air | Type int | Description 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 |
|---|---|---|
Parameter id | Type int | Description 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 |
|---|---|---|
Parameter seconds | Type int | Description The amount of seconds the Entity should be on fire for. |
Sets the location and looking angles of the entity.
Return Type: void
// 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. |
Sets this Entity to have no gravity.
Return Type: void
// MCEntity.setNoGravity(noGravity as boolean) as void
myMCEntity.setNoGravity(true);| Parameter | Type | Description |
|---|---|---|
Parameter noGravity | Type boolean | Description 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 |
|---|---|---|
Parameter grounded | Type boolean | Description 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 |
|---|---|---|
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. |
Return Type: void
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 |
Return Type: void
MCEntity.setRotationPitch(newPitch as float) as void| Parameter | Type | Description |
|---|---|---|
Parameter newPitch | Type float | Description No Description Provided |
Return Type: void
MCEntity.setRotationYaw(newYaw as float) as void| Parameter | Type | Description |
|---|---|---|
Parameter newYaw | Type float | Description No Description Provided |
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 |
|---|---|---|
Parameter isSilent | Type boolean | Description 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 |
|---|---|---|
Parameter value | Type boolean | Description The new sneaking value |
Return Type: boolean
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 |
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 |
|---|---|---|
Parameter x | Type double | Description No Description Provided |
Parameter y | Type double | Description No Description Provided |
Parameter z | Type double | Description 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 |
|---|---|---|
Parameter data | Type MapData | Description The new Data for this Entity |
Updates the persisted data.
Return Type: void
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. |