Импорт класса

Link to импорт-класса

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;

Name: addTag

Adds a new tag to the Entity.

There is a limit of 1024 tags per Entity.

These are not tags like MCTag<EntityType>, 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.
Return Type: boolean

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

myMCEntity.addTag("foundMesa");
ПараметрТипОписание
Параметр
tag
Тип
string
Описание
The name of the tag to add.

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);
ПараметрТипОписание
Параметр
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.

Link to g-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);
ПараметрТипОписание
Параметр
other
Тип
MCEntity
Описание
The Entity to collide with.

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();

Name: changeDimension

Teleports this Entity to the given world.

Return Type: void

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

myMCEntity.changeDimension(world);
ПараметрТипОписание
Параметр
world
Тип
MCServerWorld
Описание
The new world for the Entity.

Name: dismount

Return Type: void

ZenScript
Copy
// MCEntity.dismount() as void

myMCEntity.dismount();

Name: extinguish

Extinguishes the Entity if it is on fire.

Return Type: void

ZenScript
Copy
// MCEntity.extinguish() as void

myMCEntity.extinguish();

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);
ПараметрТипОписание
Параметр
ticks
Тип
int
Описание
The amount of ticks the Entity should burn for.

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);
ПараметрТипОписание
Параметр
x
Тип
double
Описание
The new X value.
Параметр
y
Тип
double
Описание
The new Y value.
Параметр
z
Тип
double
Описание
The new Z value.

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();

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();

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();

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);
ПараметрТипОписание
Параметр
other
Тип
MCEntity
Описание
The Entity to get the distance to.

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);
ПараметрТипОписание
Параметр
other
Тип
MCEntity
Описание
The other Entity to check the squared distance to.

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);
ПараметрТипОписание
Параметр
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.

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();

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();

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();

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();

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();

Name: getPersistentData

Gets the persisted NBT tag.

Return Type: MapData

ZenScript
Copy
// MCEntity.getPersistentData() as MapData

myMCEntity.getPersistentData();

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();

Name: getPositionVec

Return Type: MCVector3d

ZenScript
Copy
// MCEntity.getPositionVec() as MCVector3d

myMCEntity.getPositionVec();

Name: getTags

Gets all the tags that are attached to the entity.

These are not tags like MCTag<EntityType>, 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.
Return Type: Set<string>

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

myMCEntity.getTags();

Name: getType

Gets this Entity's type.

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

ZenScript
Copy
// MCEntity.getType() as MCEntityType

myMCEntity.getType();

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();

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();

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();

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);
ПараметрТипОписание
Параметр
entity
Тип
MCEntity
Описание
The Entity to check if it is in range.
Параметр
distance
Тип
double
Описание
The distance to check for.

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();

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();

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();

Link to g-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();

Link to g-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();

Link to g-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);
ПараметрТипОписание
Параметр
x
Тип
double
Описание
The X offset.
Параметр
y
Тип
double
Описание
The Y offset.
Параметр
z
Тип
double
Описание
The Z offset.

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();

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();

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();

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();

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();

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);
ПараметрТипОписание
Параметр
x
Тип
double
Описание
The new X value.
Параметр
y
Тип
double
Описание
The new Y value.
Параметр
z
Тип
double
Описание
The new Z value.

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);
ПараметрТипОписание
Параметр
playerEntity
Тип
MCPlayerEntity
Описание
The player to collide with.

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();

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);
ПараметрТипОписание
Параметр
distance
Тип
float
Описание
The distance the Entity has fallen.
Параметр
damageMultiplier
Тип
float
Описание
The damage multiplier.

Name: remove

Removes the entity from the world.

Return Type: void

ZenScript
Copy
// MCEntity.remove() as void

myMCEntity.remove();

Name: removePassengers

Return Type: void

ZenScript
Copy
// MCEntity.removePassengers() as void

myMCEntity.removePassengers();

Name: removeTag

Removes a tag from the Entity.

These are not tags like MCTag<EntityType>, 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.
Return Type: boolean

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

myMCEntity.removeTag("foundMesa");
ПараметрТипОписание
Параметр
tag
Тип
string
Описание
The name of the tag to remove.

Name: setAir

Sets the air value for the Entity

Return Type: void

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

myMCEntity.setAir(20);
ПараметрТипОписание
Параметр
air
Тип
int
Описание
The new air value.

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);
ПараметрТипОписание
Параметр
id
Тип
int
Описание
0

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);
ПараметрТипОписание
Параметр
seconds
Тип
int
Описание
The amount of seconds the Entity should be on fire for.

Link to g-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);
ПараметрТипОписание
Параметр
x
Тип
double
Описание
The new x position.
Параметр
y
Тип
double
Описание
The new y position.
Параметр
z
Тип
double
Описание
The new z position.
Параметр
yaw
Тип
float
Описание
The new yaw value.
Параметр
pitch
Тип
float
Описание
The new pitch value.

Name: setNoGravity

Sets this Entity to have no gravity.

Return Type: void

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

myMCEntity.setNoGravity(true);
ПараметрТипОписание
Параметр
noGravity
Тип
boolean
Описание
The new gravity value.

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
ПараметрТипОписание
Параметр
grounded
Тип
boolean
Описание
If the Entity is on the ground or not.

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);
ПараметрТипОписание
Параметр
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.

Link to g-setpositionandupdate

Name: setPositionAndUpdate

Return Type: void

ZenScript
Copy
MCEntity.setPositionAndUpdate(x as double, y as double, z as double) as void
ПараметрТипОписание
Параметр
x
Тип
double
Описание
No Description Provided
Параметр
y
Тип
double
Описание
No Description Provided
Параметр
z
Тип
double
Описание
No Description Provided

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);
ПараметрТипОписание
Параметр
isSilent
Тип
boolean
Описание
If the Entity should be silent or not.

Name: setSneaking

Sets the sneaking value of this Entity.

Return Type: void

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

myMCEntity.setSneaking(true);
ПараметрТипОписание
Параметр
value
Тип
boolean
Описание
The new sneaking value

Name: startRiding

Return Type: boolean

ZenScript
Copy
MCEntity.startRiding(other as MCEntity, forced as boolean) as boolean
ПараметрТипОписаниеOptionalDefaultValue
Параметр
other
Тип
MCEntity
Описание
No Description Provided
Optional
false
DefaultValue
Параметр
forced
Тип
boolean
Описание
No Description Provided
Optional
true
DefaultValue
false

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);
ПараметрТипОписание
Параметр
x
Тип
double
Описание
No Description Provided
Параметр
y
Тип
double
Описание
No Description Provided
Параметр
z
Тип
double
Описание
No Description Provided

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"});
ПараметрТипОписание
Параметр
data
Тип
MapData
Описание
The new Data for this Entity

Link to g-updatepersistentdata

Name: updatePersistentData

Updates the persisted data.

Return Type: void

ZenScript
Copy
MCEntity.updatePersistentData(data as MapData) as void
ПараметрТипОписание
Параметр
data
Тип
MapData
Описание
No Description Provided

Свойства

Link to свойства

НазваниеТипИмеет GetterИмеет SetterОписание
Название
air
Тип
int
Имеет Getter
true
Имеет Setter
true
Описание
Gets the air value for the Entity. <br /> The air value is used to determine when the Entity will start drowning when swimming.
Название
canSwim
Тип
boolean
Имеет Getter
true
Имеет Setter
false
Описание
Checks if this Entity can swim.
Название
data
Тип
MapData
Имеет Getter
true
Имеет Setter
false
Описание
Gets the NBT data of this Entity.
Название
facingDirections
Тип
Direction[]
Имеет Getter
true
Имеет Setter
false
Описание
Gets which directions the Entity is currently facing.
Название
id
Тип
int
Имеет Getter
true
Имеет Setter
false
Описание
Gets this Entity's id that can be used to reference this Entity.
Название
inLava
Тип
boolean
Имеет Getter
true
Имеет Setter
false
Описание
Checks if this Entity is in lava or not.
Название
inWater
Тип
boolean
Имеет Getter
true
Имеет Setter
false
Описание
Checks if this Entity is in water.
Название
isWet
Тип
boolean
Имеет Getter
true
Имеет Setter
false
Описание
Checks if this Entity is wet.
Название
name
Тип
string
Имеет Getter
true
Имеет Setter
false
Описание
Gets the name of the Entity.
Название
onGround
Тип
MCEntity
Имеет Getter
true
Имеет Setter
true
Описание
Sets if the Entity should be considered on the ground or not.
Название
persistedData
Тип
MapData
Имеет Getter
true
Имеет Setter
false
Описание
Gets the persisted NBT tag.
Название
position
Тип
BlockPos
Имеет Getter
true
Имеет Setter
false
Описание
Gets this Entity's position in the world.
Название
positionVec
Тип
MCVector3d
Имеет Getter
true
Имеет Setter
false
Описание
No Description Provided
Название
silent
Тип
boolean
Имеет Getter
true
Имеет Setter
true
Описание
Checks if this Entity is silent. <br /> <br /> Silent Entities do not play sounds.
Название
sneaking
Тип
boolean
Имеет Getter
true
Имеет Setter
true
Описание
Checks if this Entity is sneaking or not.
Название
spectator
Тип
boolean
Имеет Getter
true
Имеет Setter
false
Описание
Checks if this Entity is in spectator mode.
Название
type
Тип
MCEntityType
Имеет Getter
true
Имеет Setter
false
Описание
Gets this Entity's type.
Название
uuid
Тип
string
Имеет Getter
true
Имеет Setter
false
Описание
Gets the UUID of this Entity.
Название
world
Тип
MCWorld
Имеет Getter
true
Имеет Setter
false
Описание
Gets the World that this Entity is in.