Protected constructorReadonly Beta dimensionDimension that the entity is currently within.
This property can throw when used.
Readonly headRotation of the head across pitch and yaw angles.
This property can throw when used.
Readonly idUnique 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 can throw when used.
Beta isWhether the entity is sneaking - that is, moving more slowly and more quietly.
This property can't be edited in read-only mode.
This property can't be edited in read-only mode.
Readonly Beta levelThe current overall level for the player, based on their experience.
This property can throw when used.
Readonly Beta lifetimeWhether 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.
Readonly Beta locationCurrent location of the entity.
This property can throw when used.
Readonly nameName of the player.
This property can throw when used.
Beta nameGiven name of the entity.
This property can't be edited in read-only mode.
Readonly Beta onContains methods for manipulating the on-screen display of a Player.
Optional Readonly Beta scoreboardReturns a scoreboard identity that represents this entity.
This property can throw when used.
Beta selectedManages the selected slot in the player's hotbar.
This property can't be edited in read-only mode.
Optional Readonly Beta spawnIf this player has an individual spawn point set, returns the dimension that their spawn point is within.
This property can throw when used.
Readonly Beta targetRetrieves or sets an entity that is used as the target of AI-related behaviors, like attacking.
This property can throw when used.
Readonly Beta totalThe overall total set of experience needed to achieve the next level for a player.
This property can throw when used.
Readonly typeUnique identifier of the type of the entity - for example, 'minecraft:skeleton'.
This property can throw when used.
Readonly Beta xpThe current set of experience achieved for the player.
This property can throw when used.
Beta
Type of effect to add to the entity.
Amount of time, in ticks, for the effect to apply. There are 20 ticks per second. Use TicksPerSecond constant to convert between ticks and seconds.
Optional options: EntityEffectOptionsAdditional options for the effect.
Adds an effect, like poison, to the entity.
This function can't be called in read-only mode.
This function can throw errors.
addEffect.js
const villagerId = 'minecraft:villager_v2<minecraft:ageable_grow_up>';
const villagerLoc: mc.Vector3 = { x: 1, y: 2, z: 1 };
const villager = test.spawn(villagerId, villagerLoc);
const duration = 20;
villager.addEffect(EffectTypes.get('poison'), duration, { amplifier: 1 });
quickFoxLazyDog.ts
const fox = overworld.spawnEntity('minecraft:fox', {
x: targetLocation.x + 1,
y: targetLocation.y + 2,
z: targetLocation.z + 3,
});
fox.addEffect(mc.MinecraftEffectTypes.speed, 10, { amplifier: 20 });
log('Created a fox.');
const wolf = overworld.spawnEntity('minecraft:wolf', {
x: targetLocation.x + 4,
y: targetLocation.y + 2,
z: targetLocation.z + 3,
});
wolf.addEffect(mc.MinecraftEffectTypes.slowness, 10, { amplifier: 20 });
wolf.isSneaking = true;
log('Created a sneaking wolf.', 1);
Beta
Amount of experience to add. Note that this can be negative.
Returns the current experience of the Player.
Adds/removes experience to/from the Player and returns the current experience of the Player.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Amount to add to the player.
Returns the current level of the Player.
Adds/removes level to/from the Player and returns the current level of the Player.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Amount of damage to apply.
Optional options: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptionsAdditional options about the source of damage, which may add additional effects or spur additional behaviors on this entity.
Applies a set of damage to an entity.
This function can't be called in read-only mode.
This function can throw errors.
Beta
X direction in horizontal plane.
Z direction in horizontal plane.
Knockback strength for the horizontal vector.
Knockback strength for the vertical vector.
Applies impulse vector to the current velocity of the entity.
This function can't be called in read-only mode.
This function can throw errors.
Causes the simulated player to make an attack 'swipe'. Returns true if the attack was performed - for example, the player was not on cooldown and had a valid target. Target selection is performed by raycasting from the player's head.
This function can't be called in read-only mode.
This function can throw errors.
Causes the simulated player to attack the provided target. Returns true if the attack was performed - for example, the player was not on cooldown and had a valid target. The attack can be performed at any distance and does not require line of sight to the target entity.
This function can't be called in read-only mode.
This function can throw errors.
Location of the block to interact with.
Optional direction: DirectionDirection to place the specified item within.
Destroys the block at blockLocation, respecting the rules of the server player's game mode. The block will be hit until broken, an item is used or stopBreakingBlock is called. Returns true if the block at blockLocation is solid.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Optional useEffects: booleanWhether to show any visual effects connected to the extinguishing.
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.
This function can't be called in read-only mode.
This function can throw errors.
Beta
The identifier of the component (e.g., 'minecraft:rideable') to retrieve. If no namespace prefix is specified, 'minecraft:' is assumed. If the component is not present on the entity, undefined is returned.
Gets a component (that represents additional capabilities) for an entity.
Beta
Returns the value for the property, or undefined if the property has not been set.
Returns a property value.
This function can throw errors.
Beta
Effect object for the specified effect, or undefined if the effect is not present.
Returns the effect for the specified EffectType on the entity, or undefined if the effect is not present.
This function can throw errors.
Item to give.
Optional selectSlot: booleanWhether to set the selected slot once given.
Gives the simulated player a particular item stack.
This function can't be called in read-only mode.
This function can throw errors.
Performs a raycast from the player’s head and interacts with the first intersected block or entity. Returns true if the interaction was successful. Maximum range is 6 blocks.
This function can't be called in read-only mode.
This function can throw errors.
Location of the block to interact with.
Optional direction: DirectionDirection to place the specified item within.
Causes the simulated player to interact with a block. The block at the specified block location must be solid. Returns true if the interaction was performed.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberOrders the simulated player to walk in the given direction relative to the GameTest.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberOrders the simulated player to walk in the given direction relative to the player's current rotation.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberOrders the simulated player to move to the given block location in a straight line. If a move or navigation is already playing, this will override the last move/navigation.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberOrders the simulated player to move to the given location in a straight line. If a move or navigation is already playing, this will override the last move/navigation.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberOrders the simulated player to move to a specific block location using navigation. If a move or navigation is already playing, this will override the last move/walk. Note that if the simulated player gets stuck, that simulated player will stop. The player must be touching the ground in order to start navigation.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberWill use navigation to follow the selected entity to within a one block radius. If a move or navigation is already playing, this will override the last move/navigation.
This function can't be called in read-only mode.
This function can throw errors.
Optional speed: numberOrders the simulated player to move to a specific location using navigation. If a move or navigation is already playing, this will override the last move/walk. Note that if the simulated player gets stuck, that simulated player will stop. The player must be touching the ground in order to start navigation.
This function can't be called in read-only mode.
This function can throw errors.
A list of locations to use for routing.
Optional speed: numberNet speed to use for doing the navigation.
Use navigation to follow the route provided via the locations parameter. If a move or navigation is already playing, this will override the last move/navigation.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Identifier of the sound to play.
Optional soundOptions: PlayerSoundOptionsAdditional optional options for the sound.
Plays a sound that only this particular player can hear.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Returns true if the effect has been removed and false if the effect is not present.
Removes the specified EffectType on the entity, or returns false if the effect is not present.
This function can't be called in read-only mode.
This function can throw errors.
Command to run. Note that command strings should not start with slash.
For commands that return data, returns a JSON structure with command response values.
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.
This function can throw errors.
Beta
The message to be displayed.
Sends a message to the player.
This method can throw if the provided RawMessage is
in an invalid format. For example, if an empty name string
is provided to score.
nestedTranslation.ts
// Displays "Apple or Coal"
let rawMessage = {
translate: "accessibility.list.or.two",
with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
};
player.sendMessage(rawMessage);
scoreWildcard.ts
// Displays the player's score for objective "obj". Each player will see their own score.
const rawMessage = { score: { name: "*", objective: "obj" } };
world.sendMessage(rawMessage);
simpleString.ts
// Displays "Hello, world!"
world.sendMessage("Hello, world!");
translation.ts
// Displays "First or Second"
const rawMessage = { translate: "accessibility.list.or.two", with: ["First", "Second"] };
player.sendMessage(rawMessage);
Item to set.
Slot to place the given item in.
Optional selectSlot: booleanWhether to set the selected slot once set.
Sets a particular item for the simulated player.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Length of time to set the entity on fire.
Optional useEffects: booleanSets 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.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Location of the spawn point.
Dimension to place the players' individualized spawn point within.
Returns undefined/void.
Sets the individual spawn point of this player.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Specifies the cooldown category to retrieve the current cooldown for.
Duration in ticks of the item cooldown.
Sets the item cooldown time for a particular cooldown category.
This function can't be called in read-only mode.
This function can throw errors.
Beta
New location for the entity.
Optional teleportOptions: TeleportOptionsTeleports the selected entity to a new location
This function can't be called in read-only mode.
This function can throw errors.
Beta
Name of the entity type event to trigger. If a namespace is not specified, minecraft: is assumed.
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.
This function can't be called in read-only mode.
This function can throw errors.
Beta
Location to teleport the entity to.
Optional teleportOptions: TeleportOptionsOptions regarding the teleport operation.
Attempts to try a teleport, but may not complete the teleport operation (for example, if there are blocks at the destination.)
This function can't be called in read-only mode.
This function can throw errors.
Index of the slot to use.
Location to use the item upon.
Optional direction: DirectionDirection to place the specified item within.
Optional faceLocation: Vector3Location relative to the bottom north-west corner of the block where the item is placed.
Causes the simulated player to use an item in their inventory on a block. The block at the specified block location must be solid. Returns true if the item was used.
This function can't be called in read-only mode.
This function can throw errors.
Item to use.
Location to use the item upon.
Optional direction: DirectionDirection to place the specified item within.
Optional faceLocation: Vector3Location relative to the bottom north-west corner of the block where the item is placed.
Causes the simulated player to use an item on a block. The block at the specified block location must be solid. Returns true if the item was used.
This function can't be called in read-only mode.
This function can throw errors.
A simulated player can be used within GameTests to represent how a player moves throughout the world and to support testing of how entities and the environment will react to a player. This type derives much of its structure and methods from the @minecraft/server.Player type.