Protected constructorReadonly dimensionDimension that the simulated player is currently within.
This property can throw when used.
Readonly headLocation of the center of the head component of the player.
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 player. 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.
True if the player is currently using a sneaking movement.
Readonly locationCurrent location of the player.
This property can throw when used.
Readonly nameName of the player.
This property can throw when used.
Optional name tag of the player.
Readonly onContains methods for manipulating the on-screen display of a Player.
Readonly rotationMain rotation of the entity.
This property can throw when used.
Readonly scoreboardReturns a scoreboard identity that represents this entity.
This property can throw when used.
Manages the selected slot in the player's hotbar.
Readonly targetRetrieves or sets an entity that is used as the target of AI-related behaviors, like attacking.
This property can throw when used.
Readonly typeUnique identifier of the type of the entity - for example, 'minecraft:player'.
This property can throw when used.
Readonly velocityCurrent speed of the player across X, Y, and Z dimensions.
This property can throw when used.
Readonly viewVector of the current view of the player.
This property can throw when used.
Type of effect to add to the entity.
Amount of time, in ticks, for the effect to apply.
Optional amplifier: numberOptional amplification of the effect to apply.
Optional showParticles: booleanAdds an effect, like poison, to the entity.
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 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 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 throw errors.
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.
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.
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 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 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 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 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 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 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 throw errors.
Identifier of the sound to play.
Optional soundOptions: SoundOptionsAdditional optional options for the sound.
This method is inherited from Player, but is inoperative in the case of a SimulatedPlayer.
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. Where possible, running a command asynchronously is recommended, especially for long running operations.
This function can throw errors.
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 throw errors.
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 throw errors.
New location for the player.
Dimension to move the selected player to.
X rotation of the player after teleportation.
Y rotation of the player after teleportation.
Optional keepVelocity: booleanTeleports the selected player to a new location
This function can throw errors.
New location for the player.
Dimension to move the selected player to.
Location that this player will be facing.
Optional keepVelocity: booleanTeleports the selected player to a new location, and will have the player facing a specified location.
This function can throw errors.
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 throw errors.
Index of the slot to use.
Location to use the item upon.
Optional direction: DirectionDirection to place the specified item within.
Optional faceLocationX: numberBlock-face-relative X position where to place the item.
Optional faceLocationY: numberBlock-face-relative Y position where to place the item.
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 throw errors.
Item to use.
Location to use the item upon.
Optional direction: DirectionDirection to place the specified item within.
Optional faceLocationX: numberBlock-face-relative X position where to place the item.
Optional faceLocationY: numberBlock-face-relative Y position where to place the item.
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 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.