Edit

SimulatedPlayer Class

  • Article

Extends

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. Note that many types of events that may be available for entities more broadly, such as item use events, may not fire in the same capacity for simulated players.

Properties

headRotation

read-only headRotation: minecraftserver.Vector2;

Rotation of the head across pitch and yaw angles.

Type: @minecraft/server.Vector2

Warning

This property can throw errors when used.

isSprinting

isSprinting: boolean;

Returns whether the simulated player is sprinting.

Type: boolean

Important

This property can't be edited in read-only mode.

Methods

attack

attack(): boolean

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.

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

attackEntity

attackEntity(entity: minecraftserver.Entity): boolean

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.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

breakBlock

breakBlock(blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction): boolean

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.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

chat

chat(message: string): void

Parameters

  • message: string

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

disconnect

disconnect(): void

Simulates and performs a disconnection of the simulated player from the world.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

dropSelectedItem

dropSelectedItem(): boolean

Drops the simulated player's selected item

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

fly

fly(): void

Causes the simulated player to start flying as though they were flying in creative mode. For flying with Elytra, see function glide.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

giveItem

giveItem(itemStack: minecraftserver.ItemStack, selectSlot?: boolean): boolean

Gives the simulated player a particular item stack.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

glide

glide(): boolean

Causes the simulated player to start gliding. Elytra must be equipped and the player must be in the air.

Returns boolean - Returns true if the simulated player begins to glide. Returns false if the player is already gliding, or the player does not have Elytra equipped, is in water or is on the ground.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

interact

interact(): boolean

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.

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

interactWithBlock

interactWithBlock(blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction): boolean

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.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

interactWithEntity

interactWithEntity(entity: minecraftserver.Entity): boolean

Causes the simulated player to interact with a mob. Returns true if the interaction was performed.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

jump

jump(): boolean

Causes the simulated player to jump.

Returns boolean - True if a jump was performed.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

lookAtBlock

lookAtBlock(blockLocation: minecraftserver.Vector3, duration?: LookDuration): void

Rotates the simulated player's head/body to look at the given block location.

Parameters

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

lookAtEntity

lookAtEntity(entity: minecraftserver.Entity, duration?: LookDuration): void

Rotates the simulated player's head/body to look at the given entity.

Parameters

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

lookAtLocation

lookAtLocation(location: minecraftserver.Vector3, duration?: LookDuration): void

Rotates the simulated player's head/body to look at the given location.

Parameters

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

move

move(westEast: number, northSouth: number, speed?: number): void

Orders the simulated player to walk in the given direction relative to the GameTest.

Parameters

  • westEast: number
  • northSouth: number
  • speed?: number = 1

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

moveRelative

moveRelative(leftRight: number, backwardForward: number, speed?: number): void

Orders the simulated player to walk in the given direction relative to the player's current rotation.

Parameters

  • leftRight: number
  • backwardForward: number
  • speed?: number = 1

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

moveToBlock

moveToBlock(blockLocation: minecraftserver.Vector3, options?: MoveToOptions): void

Orders 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.

Parameters

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

moveToLocation

moveToLocation(location: minecraftserver.Vector3, options?: MoveToOptions): void

Orders 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.

Parameters

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

navigateToBlock(blockLocation: minecraftserver.Vector3, speed?: number): NavigationResult

Orders 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.

Parameters

Returns NavigationResult

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

navigateToEntity(entity: minecraftserver.Entity, speed?: number): NavigationResult

Will 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.

Parameters

Returns NavigationResult

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

navigateToLocation(location: minecraftserver.Vector3, speed?: number): NavigationResult

Orders 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.

Parameters

Returns NavigationResult

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

navigateToLocations(locations: minecraftserver.Vector3[], speed?: number): void

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.

Parameters

  • locations: @minecraft/server.Vector3[]

    A list of locations to use for routing.

  • speed?: number = 1

    Net speed to use for doing the navigation.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

respawn

respawn(): boolean

Respawns the particular simulated player.

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

rotateBody

rotateBody(angleInDegrees: number): void

Causes the simulated player to turn by the provided angle, relative to the player's current rotation.

Parameters

  • angleInDegrees: number

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

setBodyRotation

setBodyRotation(angleInDegrees: number): void

Causes the simulated player to turn to face the provided angle, relative to the GameTest.

Parameters

  • angleInDegrees: number

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

setItem

setItem(itemStack: minecraftserver.ItemStack, slot: number, selectSlot?: boolean): boolean

Sets a particular item for the simulated player.

Parameters

  • itemStack: @minecraft/server.ItemStack

    Item to set.

  • slot: number

    Slot to place the given item in.

  • selectSlot?: boolean = false

    Whether to set the selected slot once set.

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

startBuild

startBuild(slot?: number): void

Parameters

  • slot?: number = 0

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopBreakingBlock

stopBreakingBlock(): void

Stops destroying the block that is currently being hit.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopBuild

stopBuild(): void

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopFlying

stopFlying(): void

Causes the simulated player to stop flying.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopGliding

stopGliding(): void

Causes the simulated player to stop gliding.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopInteracting

stopInteracting(): void

Stops interacting with entities or blocks.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopMoving

stopMoving(): void

Stops moving/walking/following if the simulated player is moving.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopSwimming

stopSwimming(): void

Causes the simulated player to stop swimming.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

stopUsingItem

stopUsingItem(): minecraftserver.ItemStack | undefined

Stops using the currently active item.

Returns @minecraft/server.ItemStack | undefined - Returns the item that was in use. Undefined if no item was in use.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

swim

swim(): void

Causes the simulated player to start swimming.

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

useItem

useItem(itemStack: minecraftserver.ItemStack): boolean

Causes the simulated player to use an item. Does not consume the item. Returns false if the item is on cooldown.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

useItemInSlot

useItemInSlot(slot: number): boolean

Causes the simulated player to hold and use an item in their inventory.

Parameters

  • slot: number

    Index of the inventory slot.

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

useItemInSlotOnBlock

useItemInSlotOnBlock(slot: number, blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction, faceLocation?: minecraftserver.Vector3): boolean

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.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.

useItemOnBlock

useItemOnBlock(itemStack: minecraftserver.ItemStack, blockLocation: minecraftserver.Vector3, direction?: minecraftserver.Direction, faceLocation?: minecraftserver.Vector3): boolean

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.

Parameters

Returns boolean

Important

This function can't be called in read-only mode.

Warning

This function can throw errors.