ScriptAPI/scripts/simulated-player/index.js at adding-readme · LeGend077/ScriptAPI

This repository was archived by the owner on Nov 13, 2023. It is now read-only.
770 lines (770 loc) · 25.6 KB
// Script example for ScriptAPI
// Author: Jayly <https://github.com/JaylyDev>
// Project: https://github.com/JaylyDev/ScriptAPI
import * as Minecraft from "@minecraft/server";
 * A simulated player can be used 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 {@link Minecraft.Player} type.
export class SimulatedPlayer {
     * Dimension that the simulated player is currently within.
     * @throws This property can throw when used.
    get 'dimension'() { return this.__player.dimension; }
     * Location of the center of the head component of the player.
     * @throws This property can throw when used.
    get 'headLocation'() { return this.__player.getHeadLocation(); }
     * Rotation of the head across pitch and yaw angles.
     * @throws This property can throw when used.
    get 'headRotation'() { return this.__player.headRotation; }
     * Identifier for the player.
     * @throws This property can throw when used.
    get 'id'() { return this.__player.id; }
     * Unique identifier of the type of the entity - for example,
     * 'minecraft:player'.
     * @throws This property can throw when used.
    get 'typeId'() { return this.__player.typeId; }
     * True if the player is currently using a sneaking movement.
    get 'isSneaking'() {
        return this.__player.isSneaking;
    set 'isSneaking'(value) {
        this.__player.isSneaking = value;
     * Current location of the player.
     * @throws This property can throw when used.
    get 'location'() { return this.__player.location; }
     * Name of the player.
     * @throws This property can throw when used.
    get 'name'() { return this.__player.name; }
     * Optional name tag of the player.
    get 'nameTag'() {
        return this.__player.nameTag;
    set 'nameTag'(value) {
        this.__player.nameTag = value;
     * Contains methods for manipulating the on-screen display of a
     * Player.
    get 'onScreenDisplay'() { return this.__player.onScreenDisplay; }
     * Main rotation of the entity.
     * @throws This property can throw when used.
    get 'rotation'() { return this.__player.getRotation(); }
     * Returns a scoreboard identity that represents this entity.
     * @throws This property can throw when used.
    get 'scoreboard'() { return this.__player.scoreboard; }
     * Manages the selected slot in the player's hotbar.
    get 'selectedSlot'() {
        return this.__player.selectedSlot;
    set 'selectedSlot'(value) {
        this.__player.selectedSlot = value;
     * Retrieves or sets an entity that is used as the target of
     * AI-related behaviors, like attacking.
    get 'target'() {
        return this.__player.target;
     * Current speed of the player across X, Y, and Z dimensions.
     * @throws This property can throw when used.
    get 'velocity'() { return new Minecraft.Vector(this.__player.getVelocity().x, this.__player.getVelocity().y, this.__player.getVelocity().z); }
     * Vector of the current view of the player.
     * @throws This property can throw when used.
    get 'viewDirection'() { return this.__player.getViewDirection(); }
     * @remarks
     * Adds an effect, like poison, to the entity.
     * @param effectType
     * Type of effect to add to the entity.
     * @param duration
     * Amount of time, in seconds, for the effect to apply.
     * @param amplifier
     * Optional amplification of the effect to apply.
     * @param showParticles
     * @throws This function can throw errors.
    addEffect(effectType, duration, amplifier, showParticles) { return this.__player.addEffect(effectType, duration, amplifier, showParticles); }
     * @remarks
     * Adds experience to a simulated player.
     * @param amount
     * Amount of experience to add.
     * @throws This function can throw errors.
    addExperience(amount) { return this.__player.addExperience(amount); }
     * @remarks
     * Adds a specified tag to a simulated player.
     * @param tag
     * Content of the tag to add.
     * @throws This function can throw errors.
    addTag(tag) { return this.__player.addTag(tag); }
     * @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.
    attack() { return this.__player.attack(); }
     * @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.
     * @param entity
     * @throws This function can throw errors.
    attackEntity(entity) { return this.__player.attackEntity(entity); }
     * @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.
     * @param blockLocation
     * Location of the block to interact with.
     * @param direction
     * Direction to place the specified item within.
     * @throws This function can throw errors.
    breakBlock(blockLocation, direction) { return this.__player.breakBlock(blockLocation, direction); }
     * @remarks
     * Gets the first block that intersects with the vector of the
     * view of this entity.
     * @param options
     * Additional options for processing this raycast query.
     * @throws This function can throw errors.
    getBlockFromViewDirection(options) { return this.__player.getBlockFromViewDirection(options); }
     * @remarks
     * Gets a component (that represents additional capabilities)
     * for an entity.
     * @param componentId
     * 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.
    getComponent(componentId) { return this.__player.getComponent(componentId); }
     * @remarks
     * Returns all components that are both present on this entity
     * and supported by the API.
    getComponents() { return this.__player.getComponents(); }
     * @remarks
     * Returns a property value.
     * @param identifier
     * @returns
     * Returns the value for the property, or undefined if the
     * property has not been set.
     * @throws This function can throw errors.
    getDynamicProperty(identifier) { return this.__player.getDynamicProperty(identifier); }
     * @remarks
     * Returns the effect for the specified EffectType on the
     * entity, or undefined if the effect is not present.
     * @param effectType
     * @returns
     * Effect object for the specified effect, or undefined if the
     * effect is not present.
     * @throws This function can throw errors.
    getEffect(effectType) { return this.__player.getEffect(effectType); }
     * @remarks
     * Gets the first entity that intersects with the vector of the
     * view of this entity.
     * @param options
     * Additional options for processing this raycast query.
     * @throws This function can throw errors.
    getEntitiesFromViewDirection(options) { return this.__player.getEntitiesFromViewDirection(options); }
     * @remarks
     * Gets the current item cooldown time for a particular
     * cooldown category.
  velocity   * @param itemCategory
     * Specifies the cooldown category to retrieve the current
     * cooldown for.
     * @throws This function can throw errors.
    getItemCooldown(itemCategory) { return this.__player.getItemCooldown(itemCategory); }
     * @remarks
     * Returns all tags associated with this simulated player.
     * @throws This function can throw errors.
    getTags() { return this.__player.getTags(); }
     * @remarks
     * Gives the simulated player a particular item stack.
     * @param itemStack
     * Item to give.
     * @param selectSlot
     * Whether to set the selected slot once given.
     * @throws This function can throw errors.
    giveItem(itemStack, selectSlot) { return this.__player.giveItem(itemStack, selectSlot); }
     * @remarks
     * Returns true if the specified component is present on this
     * entity.
     * @param componentId
     * The identifier of the component (e.g., 'minecraft:rideable')
     * to retrieve. If no namespace prefix is specified,
     * 'minecraft:' is assumed.
    hasComponent(componentId) { return this.__player.hasComponent(componentId); }
     * @remarks
     * Tests whether a simulated player has a particular tag.
     * @param tag
     * Identifier of the tag to test for.
     * @throws This function can throw errors.
    hasTag(tag) { return this.__player.hasTag(tag); }
     * @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.
    interact() { return this.__player.interact(); }
     * @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.
     * @param blockLocation
     * Location of the block to interact with.
     * @param direction
     * Direction to place the specified item within.
     * @throws This function can throw errors.
    interactWithBlock(blockLocation, direction) { return this.__player.interactWithBlock(blockLocation, direction); }
     * @remarks
     * Causes the simulated player to interact with a mob. Returns
     * true if the interaction was performed.
     * @param entity
     * Entity to interact with.
     * @throws This function can throw errors.
    interactWithEntity(entity) { return this.__player.interactWithEntity(entity); }
     * @remarks
     * Causes the simulated player to jump.
     * @returns
     * True if a jump was performed.
     * @throws This function can throw errors.
    jump() { return this.__player.jump(); }
     * @remarks
     * Removes this simulated player from the world.
    kick(reason) {
        if (reason)
            this.__test.print(`§e${this.__player.name} is kicked from the game: ${reason}`);
        else
            this.__test.print(`§e${this.__player.name} is kicked from the game`);
        return this.__test.removeSimulatedPlayer(this.__player);
     * @remarks
     * Kills this entity. The entity will drop loot as normal.
     * @throws This function can throw errors.
    kill() { return this.__player.kill(); }
     * @remarks
     * Rotates the simulated player's head/body to look at the
     * given block location.
     * @param blockLocation
     * @throws This function can throw errors.
    lookAtBlock(blockLocation) { return this.__player.lookAtBlock(blockLocation); }
     * @remarks
     * Rotates the simulated player's head/body to look at the
     * given entity.
     * @param entity
     * @throws This function can throw errors.
    lookAtEntity(entity) { return this.__player.lookAtEntity(entity); }
     * @remarks
     * Rotates the simulated player's head/body to look at the
     * given location.
     * @param location
     * @throws This function can throw errors.
    lookAtLocation(location) { return this.__player.lookAtLocation(location); }
     * @remarks
     * Orders the simulated player to walk in the given direction
     * relative to the GameTest.
     * @param westEast
     * @param northSouth
     * @param speed
     * @throws This function can throw errors.
    move(westEast, northSouth, speed) { return this.__player.move(westEast, northSouth, speed); }
     * @remarks
     * Orders the simulated player to walk in the given direction
     * relative to the player's current rotation.
     * @param leftRight
     * @param backwardForward
     * @param speed
     * @throws This function can throw errors.
    moveRelative(leftRight, backwardForward, speed) { return this.__player.moveRelative(leftRight, backwardForward, speed); }
     * @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.
     * @param blockLocation
     * @param speed
     * @throws This function can throw errors.
    moveToBlock(blockLocation, speed) { return this.__player.moveToBlock(blockLocation, speed); }
     * @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.
     * @param location
     * @param speed
     * @throws This function can throw errors.
    moveToLocation(location, speed) { return this.__player.moveToLocation(location, speed); }
     * @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.
     * @param blockLocation
     * @param speed
     * @throws This function can throw errors.
    navigateToBlock(blockLocation, speed) { return this.__player.navigateToBlock(blockLocation, speed); }
     * @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.
     * @param entity
     * @param speed
     * @throws This function can throw errors.
    navigateToEntity(entity, speed) { return this.__player.navigateToEntity(entity, speed); }
     * @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.
     * @param location
     * @param speed
     * @throws This function can throw errors.
    navigateToLocation(location, speed) { return this.__player.navigateToLocation(location, speed); }
     * @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.
     * @param locations
     * A list of locations to use for routing.
     * @param speed
     * Net speed to use for doing the navigation.
     * @throws This function can throw errors.
    navigateToLocations(locations, speed) { return this.__player.navigateToLocations(locations, speed); }
     * @remarks
     * This method is inherited from Player, but is inoperative in
     * the case of a SimulatedPlayer.
     * @param soundID
     * Identifier of the sound to play.
     * @param soundOptions
     * Additional optional options for the sound.
     * @throws This function can throw errors.
    playSound(soundID, soundOptions) { return this.__player.playSound(soundID, soundOptions); }
     * @remarks
     * Removes a specified property.
     * @param identifier
     * @throws This function can throw errors.
    removeDynamicProperty(identifier) { return this.__player.removeDynamicProperty(identifier); }
     * @remarks
     * Removes a specified tag from a simulated player.
     * @param tag
     * Content of the tag to remove.
     * @throws This function can throw errors.
    removeTag(tag) { return this.__player.removeTag(tag); }
     * @remarks
     * Causes the simulated player to turn by the provided angle,
     * relative to the player's current rotation.
     * @param angleInDegrees
     * @throws This function can throw errors.
    rotateBody(angleInDegrees) { return this.__player.rotateBody(angleInDegrees); }
     * @remarks
     * Runs a particular command from the context of this simulated
     * player.
     * @param commandString
     * Command to run. Note that command strings should not start
     * with slash.
     * @returns
     * For commands that return data, returns a JSON structure with
     * command response values.
     * @throws This function can throw errors.
     * @example commands.js
     * ```typescript
     *        player.runCommandAsync("say You got a new high score!");
     *        player.runCommandAsync("scoreboard players set @s score 10");
     * @deprecated
    runCommand(commandString) {
        throw new ReferenceError("runCommand function has been deprecated");
     * @remarks
     * Runs a particular command asynchronously from the context of
     * this entity. Where possible, running a command
     * asynchronously is recommended, especially for long running
     * operations.
     * @param commandString
     * Command to run. Note that command strings should not start
     * with slash.
     * @returns
     * For commands that return data, returns a JSON structure with
     * command response values.
     * @throws This function can throw errors.
    runCommandAsync(commandString) { return this.__player.runCommandAsync(commandString); }
     * @remarks
     * Causes the simulated player to turn to face the provided
     * angle, relative to the GameTest.
     * @param angleInDegrees
     * @throws This function can throw errors.
    setBodyRotation(angleInDegrees) { return this.__player.setBodyRotation(angleInDegrees); }
     * @remarks
     * Sets a specified property to a value.
     * @param identifier
     * @param value
     * Data value of the property to set.
     * @throws This function can throw errors.
    setDynamicProperty(identifier, value) { return this.__player.setDynamicProperty(identifier, value); }
     * @remarks
     * Sets the game mode that the simulated player is operating
     * under.
     * @param gameMode
     * Game mode to set.
     * @throws This function can throw errors.
    setGameMode(gameMode) { return this.__player.setGameMode(gameMode); }
     * @remarks
     * Sets a particular item for the simulated player.
     * @param itemStack
     * Item to set.
     * @param slot
     * Slot to place the given item in.
     * @param selectSlot
     * Whether to set the selected slot once set.
     * @throws This function can throw errors.
    setItem(itemStack, slot, selectSlot) { return this.__player.setItem(itemStack, slot, selectSlot); }
     * @remarks
     * Sets the main rotation of the entity.
     * @param degreesX
     * @param degreesY
     * @throws This function can throw errors.
    setRotation(degreesX, degreesY) { return this.__player.setRotation(degreesX, degreesY); }
     * @remarks
     * Sets a velocity for the entity to move with.
     * @param velocity
     * X/Y/Z components of the velocity.
     * @throws This function can throw errors.
    setVelocity(velocity) { return this.__player.applyImpulse(velocity); }
     * @remarks
     * Sets the item cooldown time for a particular cooldown
     * category.
     * @param itemCategory
     * Specifies the cooldown category to retrieve the current
     * cooldown for.
     * @param tickDuration
     * Duration in ticks of the item cooldown.
     * @throws This function can throw errors.
    startItemCooldown(itemCategory, tickDuration) { return this.__player.startItemCooldown(itemCategory, tickDuration); }
     * @remarks
     * Stops destroying the block that is currently being hit.
     * @throws This function can throw errors.
    stopBreakingBlock() { return this.__player.stopBreakingBlock(); }
     * @remarks
     * Stops interacting with entities or blocks.
     * @throws This function can throw errors.
    stopInteracting() { return this.__player.stopInteracting(); }
     * @remarks
     * Stops moving/walking/following if the simulated player is
     * moving.
     * @throws This function can throw errors.
    stopMoving() { return this.__player.stopMoving(); }
     * @remarks
     * Stops using the currently active item.
     * @throws This function can throw errors.
    stopUsingItem() { return this.__player.stopUsingItem(); }
     * @remarks
     * Teleports the selected player to a new location
     * @param location
     * New location for the player.
     * @param dimension
     * Dimension to move the selected player to.
     * @param xRotation
     * X rotation of the player after teleportation.
     * @param yRotation
     * Y rotation of the player after teleportation.
     * @throws This function can throw errors.
    teleport(location, dimension, xRotation, yRotation) { return this.__player.teleport(location, dimension, xRotation, yRotation); }
     * @remarks
     * Teleports the selected player to a new location, and will
     * have the player facing a specified location.
     * @param location
     * New location for the player.
     * @param dimension
     * Dimension to move the selected player to.
     * @param facingLocation
     * Location that this player will be facing.
     * @throws This function can throw errors.
    teleportFacing(location, dimension, facingLocation) { return this.__player.teleportFacing(location, dimension, facingLocation); }
     * @remarks
     * 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.
     * @param eventName
     * Name of the entity type event to trigger. If a namespace is
     * not specified, minecraft: is assumed.
     * @throws This function can throw errors.
    triggerEvent(eventName) { return this.__player.triggerEvent(eventName); }
     * @remarks
     * Causes the simulated player to use an item. Does not consume
     * the item. Returns false if the item is on cooldown.
     * @param itemStack
     * Item to use.
     * @throws This function can throw errors.
    useItem(itemStack) { return this.__player.useItem(itemStack); }
     * @remarks
     * Causes the simulated player to hold and use an item in their
     * inventory.
     * @param slot
     * Index of the inventory slot.
     * @throws This function can throw errors.
    useItemInSlot(slot) { return this.__player.useItemInSlot(slot); }
     * @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.
     * @param slot
     * Index of the slot to use.
     * @param blockLocation
     * Location to use the item upon.
     * @param direction
     * Direction to place the specified item within.
     * @param faceLocationX
     * Block-face-relative X position where to place the item.
     * @param faceLocationY
     * Block-face-relative Y position where to place the item.
     * @throws This function can throw errors.
    useItemInSlotOnBlock(slot, blockLocation, direction, faceLocationX, faceLocationY) { return this.__player.useItemInSlotOnBlock(slot, blockLocation, direction, faceLocationX, faceLocationY); }
     * @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.
     * @param itemStack
     * Item to use.
     * @param blockLocation
     * Location to use the item upon.
     * @param direction
     * Direction to place the specified item within.
     * @param faceLocationX
     * Block-face-relative X position where to place the item.
     * @param faceLocationY
     * Block-face-relative Y position where to place the item.
     * @throws This function can throw errors.
    useItemOnBlock(itemStack, blockLocation, direction, faceLocationX, faceLocationY) { return this.__player.useItemOnBlock(itemStack, blockLocation, direction, faceLocationX, faceLocationY); }
    constructor(player, test) {
        this.__player = player;
        this.__test = test;
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.js

Latest commit

History

index.js

File metadata and controls
