BetaProtectedconstructorBetaReadonly BetadimensionReadonly BetaheadReadonly BetaidBetaisWhether the entity is sneaking - that is, moving more slowly and more quietly.
This property can't be edited in read-only mode.
BetaisThis property can't be edited in read-only mode.
Readonly BetalevelReadonly BetalocationReadonly BetanameBetanameReadonly BetaonReadonly BetascoreboardBetaselectedManages the selected slot in the player's hotbar.
This property can't be edited in read-only mode.
Optional Readonly BetaspawnReadonly BetatargetReadonly BetatotalReadonly BetatypeReadonly BetaxpBetaType of effect to add to the entity.
Amount of time, in ticks, for the effect to apply.
Optionalamplifier: numberOptional amplification of the effect to apply.
OptionalshowParticles: booleanconst 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(MinecraftEffectTypes.poison, duration, 1);
const fox = overworld.spawnEntity("minecraft:fox", {
x: targetLocation.x + 1,
y: targetLocation.y + 2,
z: targetLocation.z + 3,
});
fox.addEffect(mc.MinecraftEffectTypes.speed, 10, 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, 20);
wolf.isSneaking = true;
log("Created a sneaking wolf.", 1);
BetaAmount 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.
BetaAmount 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.
BetaContent of the tag to add.
BetaAmount of damage to apply.
Optionalsource: EntityDamageSourceBetaImpulse vector.
Applies impulse vector to the current velocity of the entity.
This function can't be called in read-only mode.
BetaX 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.
BetaCauses 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.
BetaCauses 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.
BetaDestroys 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.
BetaClears the spawn point that has been individually set for a player.
This function can't be called in read-only mode.
BetaSets the current velocity of the Entity to zero. Note that this method may not have an impact on Players.
This function can't be called in read-only mode.
BetaSimulates and performs a disconnection of the simulated player from the world.
This function can't be called in read-only mode.
BetaOptionaluseEffects: 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.
BetaOptionaloptions: BlockRaycastOptionsReturns the first intersecting block from the direction that this entity is looking at.
This function can't be called in read-only mode.
BetaThe 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.
This function can't be called in read-only mode.
BetaReturns all components that are both present on this entity and supported by the API.
This function can't be called in read-only mode.
BetaReturns the value for the property, or undefined if the property has not been set.
BetaEffect 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't be called in read-only mode.
BetaList of effects.
Returns a set of effects applied to this item.
This function can't be called in read-only mode.
BetaOptionaloptions: EntityRaycastOptionsReturns a potential set of entities from the direction that this entity is looking at.
This function can't be called in read-only mode.
BetaReturns the current location of the head component of this entity.
This function can't be called in read-only mode.
BetaSpecifies the cooldown category to retrieve the current cooldown for.
Gets the current item cooldown time for a particular cooldown category.
This function can't be called in read-only mode.
BetaReturns the current rotation component of this entity.
This function can't be called in read-only mode.
BetaThe individual spawn position, or undefined if there is no specific spawn position set for a player.
Returns an individualized spawn position, if set, for a player.
This function can't be called in read-only mode.
BetaBetaBetaReturns the current velocity vector of the entity.
This function can't be called in read-only mode.
BetaReturns the current view direction of the entity.
This function can't be called in read-only mode.
BetaItem to give.
OptionalselectSlot: 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.
BetaThe identifier of the component (e.g., 'minecraft:rideable') to retrieve. If no namespace prefix is specified, 'minecraft:' is assumed.
Returns true if the specified component is present on this entity.
This function can't be called in read-only mode.
BetaIdentifier of the tag to test for.
Tests whether an entity has a particular tag.
This function can't be called in read-only mode.
BetaPerforms 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.
BetaCauses 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.
BetaEntity to interact with.
Causes the simulated player to interact with a mob. Returns true if the interaction was performed.
This function can't be called in read-only mode.
BetaReturns true if this player has operator-level permissions.
This function can't be called in read-only mode.
BetaTrue if a jump was performed.
BetaReturns true if entity can be killed (even if it is already dead), otherwise it returns false.
Kills this entity. The entity will drop loot as normal.
This function can't be called in read-only mode.
BetaRotates the simulated player's head/body to look at the given block location.
This function can't be called in read-only mode.
BetaRotates the simulated player's head/body to look at the given entity.
This function can't be called in read-only mode.
BetaRotates the simulated player's head/body to look at the given location.
This function can't be called in read-only mode.
BetaOptionalspeed: numberOrders the simulated player to walk in the given direction relative to the GameTest.
This function can't be called in read-only mode.
BetaOptionalspeed: 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.
BetaOptionalspeed: 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.
BetaOptionalspeed: 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.
BetaOptionalspeed: 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.
BetaOptionalspeed: 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.
BetaOptionalspeed: 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.
BetaA list of locations to use for routing.
Optionalspeed: 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.
BetaOptionaloptions: PlayAnimationOptionsThis function can't be called in read-only mode.
BetaIdentifier of the sound to play.
OptionalsoundOptions: SoundOptionsAdditional 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.
BetaThis is an internal-facing method for posting a system message to downstream clients.
This function can't be called in read-only mode.
BetaBetaContent of the tag to remove.
BetaBetaBetaCauses the simulated player to turn by the provided angle, relative to the player's current rotation.
This function can't be called in read-only mode.
BetaThis function can't be called in read-only mode.
BetaCommand 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't be called in read-only mode.
BetaThe message to be displayed.
This method can throw if the provided RawMessage is
in an invalid format. For example, if an empty name string
is provided to score.
// Displays "Apple or Coal"
let rawMessage = {
translate: "accessibility.list.or.two",
with: { rawtext: [{ translate: "item.apple.name" }, { translate: "item.coal.name" }] },
};
player.sendMessage(rawMessage);
BetaCauses the simulated player to turn to face the provided angle, relative to the GameTest.
This function can't be called in read-only mode.
BetaData value of the property to set.
BetaGame mode to set.
Sets the game mode that the simulated player is operating under.
This function can't be called in read-only mode.
BetaItem to set.
Slot to place the given item in.
OptionalselectSlot: 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.
BetaLength of time to set the entity on fire.
OptionaluseEffects: 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.
BetaWill change the specified players permissions, and whether they are operator or not.
This function can't be called in read-only mode.
BetaBetaReturns undefined/void.
Sets the individual spawn point of this player.
This function can't be called in read-only mode.
BetaSpecifies 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.
BetaStops destroying the block that is currently being hit.
This function can't be called in read-only mode.
BetaBetaStops moving/walking/following if the simulated player is moving.
This function can't be called in read-only mode.
BetaBetaTeleports the selected entity to a new location
This function can't be called in read-only mode.
BetaTeleports the selected entity to a new location, and will have the entity facing a specified location.
This function can't be called in read-only mode.
BetaName 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.
BetaItem to use.
Causes the simulated player to use an item. Does not consume the item. Returns false if the item is on cooldown.
This function can't be called in read-only mode.
BetaIndex of the inventory slot.
Causes the simulated player to hold and use an item in their inventory.
This function can't be called in read-only mode.
BetaCauses 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.
BetaCauses 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.
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.