Class SimulatedPlayerBeta

Readonly BetaheadRotation

BetaisSprinting

attack

• attack(): boolean
  Beta

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.

attackEntity

• attackEntity(entity: Entity): boolean
  Beta

  Parameters

  • entity: Entity

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.

breakBlock

• breakBlock(blockLocation: Vector3, direction?: Direction): boolean
  Beta

  Parameters

  • blockLocation: Vector3

    Location of the block to interact with.
  • Optionaldirection: Direction

    Direction to place the specified item within.

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.

disconnect

• disconnect(): void
  Beta

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

giveItem

• giveItem(itemStack: ItemStack, selectSlot?: boolean): boolean
  Beta

  Parameters

  • itemStack: ItemStack

    Item to give.
  • OptionalselectSlot: boolean

    Whether to set the selected slot once given.

  Returns boolean

  Remarks

  Gives the simulated player a particular item stack.

  Throws

  This function can throw errors.

interact

• interact(): boolean
  Beta

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.

interactWithBlock

• interactWithBlock(blockLocation: Vector3, direction?: Direction): boolean
  Beta

  Parameters

  • blockLocation: Vector3

    Location of the block to interact with.
  • Optionaldirection: Direction

    Direction to place the specified item within.

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.

interactWithEntity

• interactWithEntity(entity: Entity): boolean
  Beta

  Parameters

  • entity: Entity

    Entity to interact with.

  Returns boolean

  Remarks

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

  Throws

  This function can throw errors.

jump

• jump(): boolean
  Beta

  Returns boolean

  True if a jump was performed.

  Remarks

  Causes the simulated player to jump.

  Throws

  This function can throw errors.

lookAtBlock

• lookAtBlock(blockLocation: Vector3): void
  Beta

  Parameters

  • blockLocation: Vector3

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

lookAtEntity

• lookAtEntity(entity: Entity): void
  Beta

  Parameters

  • entity: Entity

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

lookAtLocation

• lookAtLocation(location: Vector3): void
  Beta

  Parameters

  • location: Vector3

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

move

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

  Parameters

  • westEast: number
  • northSouth: number
  • Optionalspeed: number

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

moveRelative

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

  Parameters

  • leftRight: number
  • backwardForward: number
  • Optionalspeed: number

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

moveToBlock

• moveToBlock(blockLocation: Vector3, speed?: number): void
  Beta

  Parameters

  • blockLocation: Vector3
  • Optionalspeed: number

  Returns void

  Remarks

  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.

  Throws

  This function can throw errors.

moveToLocation

• moveToLocation(location: Vector3, speed?: number): void
  Beta

  Parameters

  • location: Vector3
  • Optionalspeed: number

  Returns void

  Remarks

  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.

  Throws

  This function can throw errors.

navigateToBlock

• navigateToBlock(blockLocation: Vector3, speed?: number): NavigationResult
  Beta

  Parameters

  • blockLocation: Vector3
  • Optionalspeed: number

  Returns NavigationResult

  Remarks

  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.

  Throws

  This function can throw errors.

navigateToEntity

• navigateToEntity(entity: Entity, speed?: number): NavigationResult
  Beta

  Parameters

  • entity: Entity
  • Optionalspeed: number

  Returns NavigationResult

  Remarks

  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.

  Throws

  This function can throw errors.

navigateToLocation

• navigateToLocation(location: Vector3, speed?: number): NavigationResult
  Beta

  Parameters

  • location: Vector3
  • Optionalspeed: number

  Returns NavigationResult

  Remarks

  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.

  Throws

  This function can throw errors.

navigateToLocations

• navigateToLocations(locations: Vector3[], speed?: number): void
  Beta

  Parameters

  • locations: Vector3[]

    A list of locations to use for routing.
  • Optionalspeed: number

    Net speed to use for doing the navigation.

  Returns void

  Remarks

  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.

  Throws

  This function can throw errors.

respawn

• respawn(): boolean
  Beta

  Returns boolean

  Remarks

  Respawns the particular simulated player.

  Throws

  This function can throw errors.

rotateBody

• rotateBody(angleInDegrees: number): void
  Beta

  Parameters

  • angleInDegrees: number

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

setBodyRotation

• setBodyRotation(angleInDegrees: number): void
  Beta

  Parameters

  • angleInDegrees: number

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

setGameMode

• setGameMode(gameMode: GameMode): void
  Beta

  Parameters

  • gameMode: GameMode

    Game mode to set.

  Returns void

  Remarks

  Sets the game mode that the simulated player is operating under.

  Throws

  This function can throw errors.

setItem

• setItem(itemStack: ItemStack, slot: number, selectSlot?: boolean): boolean
  Beta

  Parameters

  • itemStack: ItemStack

    Item to set.
  • slot: number

    Slot to place the given item in.
  • OptionalselectSlot: boolean

    Whether to set the selected slot once set.

  Returns boolean

  Remarks

  Sets a particular item for the simulated player.

  Throws

  This function can throw errors.

stopBreakingBlock

• stopBreakingBlock(): void
  Beta

  Returns void

  Remarks

  Stops destroying the block that is currently being hit.

  Throws

  This function can throw errors.

stopInteracting

• stopInteracting(): void
  Beta

  Returns void

  Remarks

  Stops interacting with entities or blocks.

  Throws

  This function can throw errors.

stopMoving

• stopMoving(): void
  Beta

  Returns void

  Remarks

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

  Throws

  This function can throw errors.

stopUsingItem

• stopUsingItem(): void
  Beta

  Returns void

  Remarks

  Stops using the currently active item.

  Throws

  This function can throw errors.

useItem

• useItem(itemStack: ItemStack): boolean
  Beta

  Parameters

  • itemStack: ItemStack

    Item to use.

  Returns boolean

  Remarks

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

  Throws

  This function can throw errors.

useItemInSlot

• useItemInSlot(slot: number): boolean
  Beta

  Parameters

  • slot: number

    Index of the inventory slot.

  Returns boolean

  Remarks

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

  Throws

  This function can throw errors.

useItemInSlotOnBlock

• useItemInSlotOnBlock(
      slot: number,
      blockLocation: Vector3,
      direction?: Direction,
      faceLocationX?: number,
      faceLocationY?: number,
  ): boolean
  Beta

  Parameters

  • slot: number

    Index of the slot to use.
  • blockLocation: Vector3

    Location to use the item upon.
  • Optionaldirection: Direction

    Direction to place the specified item within.
  • OptionalfaceLocationX: number

    Block-face-relative X position where to place the item.
  • OptionalfaceLocationY: number

    Block-face-relative Y position where to place the item.

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.

useItemOnBlock

• useItemOnBlock(
      itemStack: ItemStack,
      blockLocation: Vector3,
      direction?: Direction,
      faceLocationX?: number,
      faceLocationY?: number,
  ): boolean
  Beta

  Parameters

  • itemStack: ItemStack

    Item to use.
  • blockLocation: Vector3

    Location to use the item upon.
  • Optionaldirection: Direction

    Direction to place the specified item within.
  • OptionalfaceLocationX: number

    Block-face-relative X position where to place the item.
  • OptionalfaceLocationY: number

    Block-face-relative Y position where to place the item.

  Returns boolean

  Remarks

  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.

  Throws

  This function can throw errors.