author | ms.author | ms.service | title | description |
---|---|---|---|---|
jakeshirley |
jashir |
minecraft-bedrock-edition |
minecraft/server.Entity Class |
Contents of the @minecraft/server.Entity class. |
Represents the state of an entity (a mob, the player, or other moving objects like minecarts) in the world.
read-only dimension: Dimension;
Dimension that the entity is currently within.
Type: Dimension
Warning
This property can throw errors when used.
::: moniker range="=minecraft-bedrock-experimental"
read-only fallDistance: number;
The distance an entity has fallen. The value is reset when the entity is teleported. The value is always 1 when gliding with Elytra.
Type: number
Caution
This property is still in pre-release. Its signature may change or it may be removed in future releases.
Warning
This property can throw errors when used. ::: moniker-end
read-only id: string;
Unique identifier of the entity. This identifier is intended to be consistent across loads of a world instance. No meaning should be inferred from the value and structure of this unique identifier - do not parse or interpret it. This property is accessible even if @minecraft/server.Entity.isValid is false.
Type: string
read-only isClimbing: boolean;
Whether the entity is touching a climbable block. For example, a player next to a ladder or a spider next to a stone wall.
Type: boolean
Warning
This property can throw errors when used.
read-only isFalling: boolean;
Whether the entity has a fall distance greater than 0, or greater than 1 while gliding.
Type: boolean
Warning
This property can throw errors when used.
read-only isInWater: boolean;
Whether any part of the entity is inside a water block.
Type: boolean
Warning
This property can throw errors when used.
read-only isOnGround: boolean;
Whether the entity is on top of a solid block. This property may behave in unexpected ways. This property will always be true when an Entity is first spawned, and if the Entity has no gravity this property may be incorrect.
Type: boolean
Warning
This property can throw errors when used.
read-only isSleeping: boolean;
If true, the entity is currently sleeping.
Type: boolean
Warning
This property can throw errors when used.
isSneaking: boolean;
Whether the entity is sneaking - that is, moving more slowly and more quietly.
Type: boolean
Important
This property can't be edited in read-only mode.
read-only isSprinting: boolean;
Whether the entity is sprinting. For example, a player using the sprint action, an ocelot running away or a pig boosting with Carrot on a Stick.
Type: boolean
Warning
This property can throw errors when used.
read-only isSwimming: boolean;
Whether the entity is in the swimming state. For example, a player using the swim action or a fish in water.
Type: boolean
Warning
This property can throw errors when used.
::: moniker range="=minecraft-bedrock-experimental"
read-only lifetimeState: EntityLifetimeState;
Whether the entity reference that you have is valid or not. For example, an entity may be unloaded if it moves into a chunk that is unloaded, but may be reactivated if the chunk it is within gets reloaded.
Type: EntityLifetimeState
Caution
This property is still in pre-release. Its signature may change or it may be removed in future releases. ::: moniker-end
read-only location: Vector3;
Current location of the entity.
Type: Vector3
Warning
This property can throw errors when used.
nameTag: string;
Given name of the entity.
Type: string
Important
This property can't be edited in read-only mode.
read-only scoreboardIdentity?: ScoreboardIdentity;
Returns a scoreboard identity that represents this entity.
Will remain valid when the entity is killed.
Type: ScoreboardIdentity
::: moniker range="=minecraft-bedrock-experimental"
read-only target?: Entity;
Retrieves or sets an entity that is used as the target of AI-related behaviors, like attacking. If the entity currently has no target returns undefined.
Type: Entity
Caution
This property is still in pre-release. Its signature may change or it may be removed in future releases.
Warning
This property can throw errors when used. ::: moniker-end
read-only typeId: string;
Identifier of the type of the entity - for example, 'minecraft:skeleton'. This property is accessible even if @minecraft/server.Entity.isValid is false.
Type: string
- addEffect
- addTag
- applyDamage
- applyImpulse
- applyKnockback
- clearDynamicProperties
- clearVelocity
- extinguishFire
- getBlockFromViewDirection
- getComponent
- getComponents
- getDynamicProperty
- getDynamicPropertyIds
- getDynamicPropertyTotalByteCount
- getEffect
- getEffects
- getEntitiesFromViewDirection
- getHeadLocation
- getProperty
- getRotation
- getTags
- getVelocity
- getViewDirection
- hasComponent
- hasTag
- isValid
- kill
- matches
- playAnimation
- remove
- removeEffect
- removeTag
- resetProperty
- runCommand
- runCommandAsync
- setDynamicProperty
- setOnFire
- setProperty
- setRotation
- teleport
- triggerEvent
- tryTeleport
addEffect(effectType: EffectType | string, duration: number, options?: EntityEffectOptions): Effect | undefined
Adds or updates an effect, like poison, to the entity.
-
effectType: EffectType | string
Type of effect to add to the entity.
-
duration: number
Amount of time, in ticks, for the effect to apply. There are 20 ticks per second. Use @minecraft/server.TicksPerSecond constant to convert between ticks and seconds. The value must be within the range [0, 20000000].
-
options?: EntityEffectOptions =
null
Additional options for the effect.
Returns Effect | undefined - Returns nothing if the effect was added or updated successfully. This can throw an error if the duration or amplifier are outside of the valid ranges, or if the effect does not exist.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
// Spawns a villager and gives it the poison effect
import {
DimensionLocation,
} from '@minecraft/server';
import { MinecraftEffectTypes } from '@minecraft/vanilla-data';
function spawnPoisonedVillager(location: DimensionLocation) {
const villagerType = 'minecraft:villager_v2<minecraft:ageable_grow_up>';
const villager = location.dimension.spawnEntity(villagerType, location);
const duration = 20;
villager.addEffect(MinecraftEffectTypes.Poison, duration, { amplifier: 1 });
}
// Spawns a fox over a dog
import { DimensionLocation } from '@minecraft/server';
import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
function spawnAdultHorse(location: DimensionLocation) {
// Create fox (our quick brown fox)
const fox = location.dimension.spawnEntity(MinecraftEntityTypes.Fox, {
x: location.x,
y: location.y + 2,
z: location.z,
});
fox.addEffect('speed', 10, {
amplifier: 2,
});
// Create wolf (our lazy dog)
const wolf = location.dimension.spawnEntity(MinecraftEntityTypes.Wolf, location);
wolf.addEffect('slowness', 10, {
amplifier: 2,
});
wolf.isSneaking = true;
}
addTag(tag: string): boolean
Adds a specified tag to an entity.
-
tag: string
Content of the tag to add. The tag must be less than 256 characters.
Returns boolean - Returns true if the tag was added successfully. This can fail if the tag already exists on the entity.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
applyDamage(amount: number, options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions): boolean
Applies a set of damage to an entity.
-
amount: number
Amount of damage to apply.
-
options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions =
null
Additional options about the source of damage, which may add additional effects or spur additional behaviors on this entity.
Returns boolean - Whether the entity takes any damage. This can return false if the entity is invulnerable or if the damage applied is less than or equal to 0.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
// A function that applies damage and then heals the entity
import { Entity, EntityComponentTypes, system, world } from '@minecraft/server';
function applyDamageAndHeal(entity: Entity) {
entity.applyDamage(19); // Many mobs have max damage of 20 so this is a near-death mob
system.runTimeout(() => {
const health = entity.getComponent(EntityComponentTypes.Health);
if (health) {
world.sendMessage(`Entity health before heal: ${health.currentValue}`);
health.resetToMaxValue();
world.sendMessage(`Entity after before heal: ${health.currentValue}`);
} else {
console.warn('Entity does not have health component');
}
}, 40); // Run in a few seconds (40 ticks)
}
applyImpulse(vector: Vector3): void
Applies impulse vector to the current velocity of the entity.
-
vector: Vector3
Impulse vector.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
// A function that throws entities up in the air
import { Entity } from '@minecraft/server';
function yeetEntity(entity: Entity) {
// Zero out the entity's velocity before applying impulse
entity.clearVelocity();
// throw the zombie up in the air
entity.applyImpulse({ x: 0, y: 15, z: 0 });
}
applyKnockback(directionX: number, directionZ: number, horizontalStrength: number, verticalStrength: number): void
Applies impulse vector to the current velocity of the entity.
-
directionX: number
X direction in horizontal plane.
-
directionZ: number
Z direction in horizontal plane.
-
horizontalStrength: number
Knockback strength for the horizontal vector.
-
verticalStrength: number
Knockback strength for the vertical vector.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
import { EntityQueryOptions, DimensionLocation } from '@minecraft/server';
function mobParty(targetLocation: DimensionLocation) {
const mobs = ['creeper', 'skeleton', 'sheep'];
// create some sample mob data
for (let i = 0; i < 10; i++) {
targetLocation.dimension.spawnEntity(mobs[i % mobs.length], targetLocation);
}
const eqo: EntityQueryOptions = {
type: 'skeleton',
};
for (const entity of targetLocation.dimension.getEntities(eqo)) {
entity.applyKnockback(0, 0, 0, 1);
}
}
clearDynamicProperties(): void
Clears all dynamic properties that have been set on this entity.
Warning
This function can throw errors.
clearVelocity(): void
Sets the current velocity of the Entity to zero. Note that this method may not have an impact on Players.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
// A function that throws entities up in the air
import { Entity } from '@minecraft/server';
function yeetEntity(entity: Entity) {
// Zero out the entity's velocity before applying impulse
entity.clearVelocity();
// throw the zombie up in the air
entity.applyImpulse({ x: 0, y: 15, z: 0 });
}
extinguishFire(useEffects?: boolean): boolean
Extinguishes the fire if the entity is on fire. Note that you can call getComponent('minecraft:onfire') and, if present, the entity is on fire.
-
useEffects?: boolean =
true
Whether to show any visual effects connected to the extinguishing.
Returns boolean - Returns whether the entity was on fire.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
import { world, Entity, EntityComponentTypes, system } from "@minecraft/server";
function setAblaze(entity: Entity) {
entity.setOnFire(20, true);
system.runTimeout(() => {
const onfire = entity.getComponent(EntityComponentTypes.OnFire);
if (onfire) {
world.sendMessage(`${onfire.onFireTicksRemaining} fire ticks remaining, extinguishing the entity.`);
}
// This will extinguish the entity
entity.extinguishFire(true);
}, 30); // Run in 30 ticks or ~1.5 seconds
}
getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit | undefined
Returns the first intersecting block from the direction that this entity is looking at.
-
options?: BlockRaycastOptions =
null
Additional configuration options for the ray cast.
Returns BlockRaycastHit | undefined - Returns the first intersecting block from the direction that this entity is looking at.
Warning
This function can throw errors.
getComponent(componentId: T): EntityComponentTypeMap[T] | undefined
Gets a component (that represents additional capabilities) for an entity.
-
componentId: T
The identifier of the component (e.g., 'minecraft:health'). If no namespace prefix is specified, 'minecraft:' is assumed. Available component IDs can be found as part of the @minecraft/server.EntityComponentTypes enum.
Returns EntityComponentTypeMap[T] | undefined - Returns the component if it exists on the entity, otherwise undefined.
getComponents(): EntityComponent[]
Returns all components that are both present on this entity and supported by the API.
Returns EntityComponent[] - Returns all components that are both present on this entity and supported by the API.
getDynamicProperty(identifier: string): boolean | number | string | Vector3 | undefined
Returns a property value.
-
identifier: string
The property identifier.
Returns boolean | number | string | Vector3 | undefined - Returns the value for the property, or undefined if the property has not been set.
Warning
This function can throw errors.
getDynamicPropertyIds(): string[]
Returns the available set of dynamic property identifiers that have been used on this entity.
Returns string[] - A string array of the dynamic properties set on this entity.
Warning
This function can throw errors.
getDynamicPropertyTotalByteCount(): number
Returns the total size, in bytes, of all the dynamic properties that are currently stored for this entity. This includes the size of both the key and the value. This can be useful for diagnosing performance warning signs - if, for example, an entity has many megabytes of associated dynamic properties, it may be slow to load on various devices.
Returns number
Warning
This function can throw errors.
getEffect(effectType: EffectType | string): Effect | undefined
Returns the effect for the specified EffectType on the entity, undefined if the effect is not present, or throws an error if the effect does not exist.
-
effectType: EffectType | string
The effect identifier.
Returns Effect | undefined - Effect object for the specified effect, undefined if the effect is not present, or throws an error if the effect does not exist.
Warning
This function can throw errors.
getEffects(): Effect[]
Returns a set of effects applied to this entity.
Returns Effect[] - List of effects.
Warning
This function can throw errors.
getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[]
Gets the entities that this entity is looking at by performing a ray cast from the view of this entity.
-
options?: EntityRaycastOptions =
null
Additional configuration options for the ray cast.
Returns EntityRaycastHit[] - Returns a set of entities from the direction that this entity is looking at.
Warning
This function can throw errors.
getHeadLocation(): Vector3
Returns the current location of the head component of this entity.
Returns Vector3 - Returns the current location of the head component of this entity.
Warning
This function can throw errors.
getProperty(identifier: string): boolean | number | string | undefined
Gets an entity Property value. If the property was set using the setProperty function within the same tick, the updated value will not be reflected until the subsequent tick.
-
identifier: string
The entity Property identifier.
Returns boolean | number | string | undefined - Returns the current property value. For enum properties, a string is returned. For float and int properties, a number is returned. For undefined properties, undefined is returned.
Warning
This function can throw errors.
Throws if the entity is invalid.
getRotation(): Vector2
Returns the current rotation component of this entity.
Returns Vector2 - Returns a Vec2 containing the rotation of this entity (in degrees).
Warning
This function can throw errors.
getTags(): string[]
Returns all tags associated with the entity.
Returns string[] - An array containing all tags as strings.
Warning
This function can throw errors.
getVelocity(): Vector3
Returns the current velocity vector of the entity.
Returns Vector3 - Returns the current velocity vector of the entity.
Warning
This function can throw errors.
// A function that spawns fireworks and logs their velocity after 5 ticks
import { DimensionLocation, system, world } from '@minecraft/server';
import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
function spawnFireworks(location: DimensionLocation) {
const fireworkRocket = location.dimension.spawnEntity(MinecraftEntityTypes.FireworksRocket, location);
system.runTimeout(() => {
const velocity = fireworkRocket.getVelocity();
world.sendMessage(`Velocity of firework is: ${velocity.x}, ${velocity.y}, ${velocity.z}`);
}, 5);
}
getViewDirection(): Vector3
Returns the current view direction of the entity.
Returns Vector3 - Returns the current view direction of the entity.
Warning
This function can throw errors.
hasComponent(componentId: string): boolean
Returns true if the specified component is present on this entity.
-
componentId: string
The identifier of the component (e.g., 'minecraft:rideable') to retrieve. If no namespace prefix is specified, 'minecraft:' is assumed.
Returns boolean - Returns true if the specified component is present on this entity.
hasTag(tag: string): boolean
Returns whether an entity has a particular tag.
-
tag: string
Identifier of the tag to test for.
Returns boolean - Returns whether an entity has a particular tag.
Warning
This function can throw errors.
isValid(): boolean
Returns whether the entity can be manipulated by script. A Player is considered valid when it's EntityLifetimeState is set to Loaded.
Returns boolean - Whether the entity is valid.
kill(): boolean
Kills this entity. The entity will drop loot as normal.
Returns boolean - Returns true if entity can be killed (even if it is already dead), otherwise it returns false.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
import { EntityQueryOptions, DimensionLocation } from '@minecraft/server';
function mobParty(targetLocation: DimensionLocation) {
const mobs = ['creeper', 'skeleton', 'sheep'];
// create some sample mob data
for (let i = 0; i < 10; i++) {
const mobTypeId = mobs[i % mobs.length];
const entity = targetLocation.dimension.spawnEntity(mobTypeId, targetLocation);
entity.addTag('mobparty.' + mobTypeId);
}
const eqo: EntityQueryOptions = {
tags: ['mobparty.skeleton'],
};
for (const entity of targetLocation.dimension.getEntities(eqo)) {
entity.kill();
}
}
matches(options: EntityQueryOptions): boolean
Matches the entity against the passed in options. Uses the location of the entity for matching if the location is not specified in the passed in EntityQueryOptions.
-
options: EntityQueryOptions
The query to perform the match against.
Returns boolean - Returns true if the entity matches the criteria in the passed in EntityQueryOptions, otherwise it returns false.
Warning
This function can throw errors.
Throws if the query options are misconfigured.
playAnimation(animationName: string, options?: PlayAnimationOptions): void
Cause the entity to play the given animation.
-
animationName: string
The animation identifier. e.g. animation.creeper.swelling
-
options?: PlayAnimationOptions =
null
Additional options to control the playback and transitions of the animation.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
remove(): void
Immediately removes the entity from the world. The removed entity will not perform a death animation or drop loot upon removal.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
removeEffect(effectType: EffectType | string): boolean
Removes the specified EffectType on the entity, or returns false if the effect is not present.
-
effectType: EffectType | string
The effect identifier.
Returns boolean - Returns true if the effect has been removed. Returns false if the effect is not found or does not exist.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
removeTag(tag: string): boolean
Removes a specified tag from an entity.
-
tag: string
Content of the tag to remove.
Returns boolean - Returns whether the tag existed on the entity.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
resetProperty(identifier: string): boolean | number | string
Resets an Entity Property back to its default value, as specified in the Entity's definition. This property change is not applied until the next tick.
-
identifier: string
The Entity Property identifier.
Returns boolean | number | string - Returns the default property value. For enum properties, a string is returned. For float and int properties, a number is returned. For undefined properties, undefined is returned.
Important
This function can't be called in read-only mode.
runCommand(commandString: string): CommandResult
Runs a synchronous command on the entity.
-
commandString: string
The command string. Note: This should not include a leading forward slash.
Returns CommandResult - A command result containing whether the command was successful.
Important
This function can't be called in read-only mode.
runCommandAsync(commandString: string): Promise<CommandResult>
Runs a particular command asynchronously from the context of this entity. Note that there is a maximum queue of 128 asynchronous commands that can be run in a given tick.
-
commandString: string
Command to run. Note that command strings should not start with slash.
Returns Promise<CommandResult> - For commands that return data, returns a JSON structure with command response values.
Warning
This function can throw errors.
setDynamicProperty(identifier: string, value?: boolean | number | string | Vector3): void
Sets a specified property to a value.
-
identifier: string
The property identifier.
-
value?: boolean | number | string | Vector3 =
null
Data value of the property to set.
Warning
This function can throw errors.
setOnFire(seconds: number, useEffects?: boolean): boolean
Sets an entity on fire (if it is not in water or rain). Note that you can call getComponent('minecraft:onfire') and, if present, the entity is on fire.
-
seconds: number
Length of time to set the entity on fire.
-
useEffects?: boolean =
true
Whether side-effects should be applied (e.g. thawing freeze) and other conditions such as rain or fire protection should be taken into consideration.
Returns boolean - Whether the entity was set on fire. This can fail if seconds is less than or equal to zero, the entity is wet or the entity is immune to fire.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
import { world, Entity, EntityComponentTypes, system } from "@minecraft/server";
function setAblaze(entity: Entity) {
entity.setOnFire(20, true);
system.runTimeout(() => {
const onfire = entity.getComponent(EntityComponentTypes.OnFire);
if (onfire) {
world.sendMessage(`${onfire.onFireTicksRemaining} fire ticks remaining, extinguishing the entity.`);
}
// This will extinguish the entity
entity.extinguishFire(true);
}, 30); // Run in 30 ticks or ~1.5 seconds
}
setProperty(identifier: string, value: boolean | number | string): void
Sets an Entity Property to the provided value. This property change is not applied until the next tick.
-
identifier: string
The Entity Property identifier.
-
value: boolean | number | string
The property value. The provided type must be compatible with the type specified in the entity's definition.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
Throws if the entity is invalid.
Throws if an invalid identifier is provided.
Throws if the provided value type does not match the property type.
Throws if the provided value is outside the expected range (int, float properties).
Throws if the provided string value does not match the set of accepted enum values (enum properties
setRotation(rotation: Vector2): void
Sets the main rotation of the entity.
-
rotation: Vector2
The x and y rotation of the entity (in degrees). For most mobs, the x rotation controls the head tilt and the y rotation controls the body rotation.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
teleport(location: Vector3, teleportOptions?: TeleportOptions): void
Teleports the selected entity to a new location
-
location: Vector3
New location for the entity.
-
teleportOptions?: TeleportOptions =
null
Options regarding the teleport operation.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
import { world, system } from '@minecraft/server';
const overworld = world.getDimension('overworld');
const targetLocation = { x: 0, y: 0, z: 0 };
const pig = overworld.spawnEntity('minecraft:pig', targetLocation);
let inc = 1;
const runId = system.runInterval(() => {
pig.teleport(
{ x: targetLocation.x + inc / 4, y: targetLocation.y + inc / 4, z: targetLocation.z + inc / 4 },
{
facingLocation: targetLocation,
},
);
if (inc > 100) {
system.clearRun(runId);
}
inc++;
}, 4);
triggerEvent(eventName: string): void
Triggers an entity type event. For every entity, a number of events are defined in an entities' definition for key entity behaviors; for example, creepers have a minecraft:start_exploding type event.
-
eventName: string
Name of the entity type event to trigger. If a namespace is not specified, minecraft: is assumed.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.
If the event is not defined in the definition of the entity, an error will be thrown.
// A function that spawns a creeper and triggers it to explode immediately
import { DimensionLocation } from '@minecraft/server';
import { MinecraftEntityTypes } from '@minecraft/vanilla-data';
function spawnExplodingCreeper(location: DimensionLocation) {
const creeper = location.dimension.spawnEntity(MinecraftEntityTypes.Creeper, location);
creeper.triggerEvent('minecraft:start_exploding_forced');
}
tryTeleport(location: Vector3, teleportOptions?: TeleportOptions): boolean
Attempts to try a teleport, but may not complete the teleport operation (for example, if there are blocks at the destination.)
-
location: Vector3
Location to teleport the entity to.
-
teleportOptions?: TeleportOptions =
null
Options regarding the teleport operation.
Returns boolean - Returns whether the teleport succeeded. This can fail if the destination chunk is unloaded or if the teleport would result in intersecting with blocks.
Important
This function can't be called in read-only mode.
Warning
This function can throw errors.