Class SimulatedPlayer

Readonlycamera

import { EasingType, system, world } from "@minecraft/server";

function runCutscene() {
    for (const player of world.getPlayers()) {
        const location = player.location;
        player.camera.setCamera("minecraft:free", {
            location: { x: location.x, y: location.y + 10, z: location.z },
            rotation: { x: 90, y: 0 },
        });
        system.run(() => {
            player.camera.setCamera("minecraft:free", {
                location: player.getHeadLocation(),
                rotation: player.getRotation(),
                easeOptions: {
                    easeTime: 1.0,
                    easeType: EasingType.InCubic,
                },
            });
            system.runTimeout(() => {
                player.camera.clear();
                player.runCommandAsync("/inputpermission @s camera enabled");
                player.runCommandAsync("/inputpermission @s movement enabled");
            }, 20);
        });
        player.runCommandAsync("/inputpermission @s camera disabled");
        player.runCommandAsync("/inputpermission @s movement disabled");
    }
}

runCutscene();
Copy

ReadonlyclientSystemInfo

Readonlydimension

import { ItemStack, world } from "@minecraft/server";

for (const entity of world.getDimension("overworld").getEntities()) {
    entity.dimension.spawnItem(
        new ItemStack("minecraft:diamond_sword"),
        entity.location
    );
}
Copy

Readonlyid

import { Entity, world } from "@minecraft/server";

/**
 * Gets entity id
 * @param {Entity} entity
 */
function showId(entity) {
    entity.runCommandAsync("say My entity ID: " + entity.id);
}

for (const entity of world.getDimension("overworld").getEntities()) {
    showId(entity);
}
Copy

ReadonlyinputPermissions

ReadonlyisClimbing

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    // Get all overworld entities
    for (const entity of world.getDimension("overworld").getEntities()) {
        if (entity.isClimbing) {
            entity.runCommand("say I'm climbing!");
        }
    }
});
Copy

ReadonlyisEmoting

ReadonlyisFalling

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const player of world.getAllPlayers()) {
        player.sendMessage(`isClimbing - ${player.isClimbing}`);
    }
});
Copy

ReadonlyisFlying

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const player of world.getAllPlayers()) {
        player.sendMessage(`player is flying: ${player.isFlying}`);
    }
});
Copy

ReadonlyisGliding

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const player of world.getAllPlayers()) {
        player.sendMessage(
            `player is gliding with Elytra: ${player.isGliding}`
        );
    }
});
Copy

ReadonlyisInWater

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const player of world.getAllPlayers()) {
        player.sendMessage(`player in water: ${player.isInWater}`);
    }
});
Copy

ReadonlyisJumping

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const player of world.getAllPlayers()) {
        player.sendMessage(`player is jumping: ${player.isJumping}`);
    }
});
Copy

ReadonlyisOnGround

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const player of world.getAllPlayers()) {
        player.sendMessage(`player on ground: ${player.isOnGround}`);
    }
});
Copy

ReadonlyisSleeping

isSneaking

import { system, world } from "@minecraft/server";

system.runInterval(() => {
    for (const entity of world.getDimension("overworld").getEntities()) {
        // Force entity to not sneak
        entity.isSneaking = false;
    }
});
Copy

import {
    DimensionLocation,
    MolangVariableMap,
    Vector3,
    system,
    world,
} from "@minecraft/server";

function spawnConfetti(location: DimensionLocation) {
    for (let i = 0; i < 100; i++) {
        const molang = new MolangVariableMap();

        molang.setColorRGB("variable.color", {
            red: Math.random(),
            green: Math.random(),
            blue: Math.random(),
        });

        const newLocation: Vector3 = {
            x: location.x + Math.floor(Math.random() * 8) - 4,
            y: location.y + Math.floor(Math.random() * 8) - 4,
            z: location.z + Math.floor(Math.random() * 8) - 4,
        };
        location.dimension.spawnParticle(
            "minecraft:colored_flame_particle",
            newLocation,
            molang
        );
    }
}

system.runInterval(() => {
    for (const player of world.getPlayers()) {
        if (player.isSneaking) {
            spawnConfetti({
                dimension: player.dimension,
                x: player.location.x,
                y: player.location.y,
                z: player.location.z,
            });
            player.sendMessage("player is sneaking");
        }
    }
});
Copy

ReadonlyisSwimming

Readonlylevel

import { Player, system, world } from "@minecraft/server";

function countdownFromTen(player: Player) {
    player.addLevels(-10000);
    player.addLevels(11);
    const id = system.runInterval(() => {
        player.addExperience(
            Math.round(-player.totalXpNeededForNextLevel / 10)
        );
        if (player.getTotalXp() === 0) {
            system.clearRun(id);
        }
        if (player.xpEarnedAtCurrentLevel == 0) {
            player.addLevels(-1);
            player.addExperience(player.totalXpNeededForNextLevel - 1);
        }
    }, 2);
}
for (const player of world.getPlayers()) {
    countdownFromTen(player);
}
Copy

import { world } from "@minecraft/server";

for (const player of world.getAllPlayers()) {
    player.onScreenDisplay.setActionBar(
        `Level: ${player.level}, xp at current level: ${player.xpEarnedAtCurrentLevel} / ${player.totalXpNeededForNextLevel}`
    );
}
Copy

Readonlylocation

import { world } from "@minecraft/server";

world.afterEvents.buttonPush.subscribe((event) => {
    if (event.source.typeId === "minecraft:player") {
        event.source.kill();
    }
});
Copy

Readonlyname

import { world } from "@minecraft/server";

world.afterEvents.playerSpawn.subscribe((event) => {
    world.sendMessage("Welcome to the server, " + event.player.name + "!");
});
Copy

nameTag

import { system, world } from "@minecraft/server";

system.afterEvents.scriptEventReceive.subscribe(({ message }) => {
    if (message === "dinnerbone:true") {
        for (const entity of world.getDimension("overworld").getEntities()) {
            entity.nameTag = "Dinnerbone";
        }
    }
});
Copy

ReadonlyonScreenDisplay

import { world } from "@minecraft/server";

for (const player of world.getAllPlayers()) {
    player.onScreenDisplay.setActionBar("Hello World");
}
Copy

import { HudElement, world } from "@minecraft/server";

for (const player of world.getAllPlayers()) {
    player.onScreenDisplay.hideAllExcept([HudElement.Hotbar]);
}
Copy

import { world } from "@minecraft/server";

for (const player of world.getAllPlayers()) {
    player.onScreenDisplay.setTitle("  "); // spaces needed
    player.onScreenDisplay.updateSubtitle("Insert Subtitle");
}
Copy

import { world } from "@minecraft/server";

for (const player of world.getAllPlayers()) {
    player.onScreenDisplay.setTitle("Hello World");
    player.onScreenDisplay.updateSubtitle("Welcome to the server!");
}
Copy

Optional ReadonlyscoreboardIdentity

selectedSlotIndex

import { world } from "@minecraft/server";

for (const player of world.getPlayers()) {
    const inventory = player.getComponent("inventory");
    const selectedItem = inventory.container.getItem(player.selectedSlotIndex);
    player.sendMessage("Selected Item: " + selectedItem.typeId);
}
Copy

ReadonlytotalXpNeededForNextLevel

ReadonlytypeId

import { system, world } from "@minecraft/server";

// This event triggers when world is loaded
system.runInterval(() => {
    const entity = world.getDimension("overworld").getEntities()[0];
    // Finally, show that location as title
    entity.runCommandAsync(
        `title @a actionbar X: ${Math.floor(
            entity.location.x
        )} | Y: ${Math.floor(entity.location.y)} | Z: ${Math.floor(
            entity.location.z
        )}`
    );
});
Copy

ReadonlyxpEarnedAtCurrentLevel

addEffect

• addEffect(
      effectType: string | EffectType,
      duration: number,
      options?: EntityEffectOptions,
  ): Effect

• Parameters

  • effectType: string | EffectType

    Type of effect to add to the entity.
  • duration: number

    Amount of time, in ticks, for the effect to apply. There are 20 ticks per second. Use TicksPerSecond constant to convert between ticks and seconds. The value must be within the range [0, 20000000].
  • Optionaloptions: EntityEffectOptions

    Additional options for the effect.

  Returns Effect

  Returns nothing if the effect was added or updated successfully. This can throw an error if the duration or amplifier are outside of the valid ranges, or if the effect does not exist.

  Remarks

  Adds or updates an effect, like poison, to the entity.

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

  Throws

  This function can throw errors.

  Example: spawnPoisonedVillager.ts

  import { DimensionLocation } from "@minecraft/server";
  import { MinecraftEffectTypes } from "@minecraft/vanilla-data";
  
  function spawnPoisonedVillager(
      targetLocation: DimensionLocation
  ) {
    const villagerType = "minecraft:villager_v2<minecraft:ageable_grow_up>";
    const villager = targetLocation.dimension.spawnEntity(villagerType, targetLocation);
    const duration = 20;
  
    villager.addEffect(MinecraftEffectTypes.Poison, duration, { amplifier: 1 });
  }
  Copy

  Example: quickFoxLazyDog.ts

  import { DimensionLocation } from "@minecraft/server";
  import { MinecraftEntityTypes, MinecraftEffectTypes } from "@minecraft/vanilla-data";
  
  function quickFoxLazyDog(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
    const fox = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Fox, {
      x: targetLocation.x + 1,
      y: targetLocation.y + 2,
      z: targetLocation.z + 3,
    });
  
    fox.addEffect(MinecraftEffectTypes.Speed, 10, {
      amplifier: 2,
    });
    log("Created a fox.");
  
    const wolf = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Wolf, {
      x: targetLocation.x + 4,
      y: targetLocation.y + 2,
      z: targetLocation.z + 3,
    });
    wolf.addEffect(MinecraftEffectTypes.Slowness, 10, {
      amplifier: 2,
    });
    wolf.isSneaking = true;
    log("Created a sneaking wolf.", 1);
  }
  Copy

addExperience

• addExperience(amount: number): number

• Parameters

  • amount: number

    Amount of experience to add. Note that this can be negative. Min/max bounds at -2^24 ~ 2^24

  Returns number

  Returns the current experience of the Player.

  Remarks

  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.

  Throws

  This function can throw errors.

  Example: addXpToPlayer.ts

  import { Player, world } from "@minecraft/server";
  
  // Command equivalent to /xp player 100
  function addExperience(player: Player) {
      const xpAdded = player.addExperience(100);
      console.log(`Player ${player.name} now has ${xpAdded} experience points.`);
  }
  
  for (const player of world.getPlayers()) {
      addExperience(player);
  }
  Copy

addLevels

• addLevels(amount: number): number

• Parameters

  • amount: number

    Amount to add to the player. Min/max bounds at -2^24 ~ 2^24

  Returns number

  Returns the current level of the Player.

  Remarks

  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.

  Throws

  This function can throw errors.

  Example: addLevels.ts

  import { Player, world } from "@minecraft/server";
  
  // Command equivalent to /xp player 5L
  function addLevels(player: Player) {
      const levels = player.addLevels(5);
      console.log(`Player ${player.name} now has ${levels} levels.`);
  }
  Copy

addTag

• addTag(tag: string): boolean

• Parameters

  • tag: string

    Content of the tag to add. The tag must be less than 256 characters.

  Returns boolean

  Returns true if the tag was added successfully. This can fail if the tag already exists on the entity.

  Remarks

  Adds a specified tag to an entity.

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

  Throws

  This function can throw errors.

  Example: tagsQuery.ts

  import { EntityQueryOptions, DimensionLocation } from "@minecraft/server";
  
  function tagsQuery(targetLocation: DimensionLocation) {
    const mobs = ["creeper", "skeleton", "sheep"];
  
    // create some sample mob data
    for (let i = 0; i < 10; i++) {
      const mobTypeId = mobs[i % mobs.length];
      const entity = targetLocation.dimension.spawnEntity(mobTypeId, targetLocation);
      entity.addTag("mobparty." + mobTypeId);
    }
  
    const eqo: EntityQueryOptions = {
      tags: ["mobparty.skeleton"],
    };
  
    for (const entity of targetLocation.dimension.getEntities(eqo)) {
      entity.kill();
    }
  }
  Copy

applyDamage

• applyDamage(
      amount: number,
      options?: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions,
  ): boolean

• Parameters

  • amount: number

    Amount of damage to apply.
  • Optionaloptions: EntityApplyDamageByProjectileOptions | EntityApplyDamageOptions

    Additional options about the source of damage, which may add additional effects or spur additional behaviors on this entity.

  Returns boolean

  Whether the entity takes any damage. This can return false if the entity is invulnerable or if the damage applied is less than or equal to 0.

  Remarks

  Applies a set of damage to an entity.

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

  Throws

  This function can throw errors.

  Example: applyDamageThenHeal.ts

  import { system, EntityHealthComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
  import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
  
  function applyDamageThenHeal(
    log: (message: string, status?: number) => void,
    targetLocation: DimensionLocation
  ) {
    const skelly = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Skeleton, targetLocation);
  
    skelly.applyDamage(19); // skeletons have max damage of 20 so this is a near-death skeleton
  
    system.runTimeout(() => {
      const health = skelly.getComponent(EntityComponentTypes.Health) as EntityHealthComponent;
      log("Skeleton health before heal: " + health?.currentValue);
      health?.resetToMaxValue();
      log("Skeleton health after heal: " + health?.currentValue);
    }, 20);
  }
  Copy

  Example: applyWither.js

  import { world, EntityDamageCause } from "@minecraft/server";
  const player = world.getAllPlayers()[0];
  player.applyDamage(1000, {
      cause: EntityDamageCause.wither,
  });
  Copy

  Example: damageEntity.js

  import { world } from "@minecraft/server";
  world.afterEvents.itemUse.subscribe((event) => {
      const player = event.source;
      const damageApplied = player.applyDamage(10);
      console.log(`Damage applied: ${damageApplied}`);
  });
  Copy

applyImpulse

• applyImpulse(vector: Vector3): void

• Parameters

  • vector: Vector3

    Impulse vector.

  Returns void

  Remarks

  Applies impulse vector to the current velocity of the entity.

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

  Throws

  This function can throw errors.

  Example: applyImpulse.ts

  import { DimensionLocation } from "@minecraft/server";
  import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
  
  function applyImpulse(targetLocation: DimensionLocation) {
    const zombie = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Zombie, targetLocation);
  
    zombie.clearVelocity();
  
    // throw the zombie up in the air
    zombie.applyImpulse({ x: 0, y: 0.5, z: 0 });
  }
  Copy

applyKnockback

• applyKnockback(
      directionX: number,
      directionZ: number,
      horizontalStrength: number,
      verticalStrength: number,
  ): void

• Parameters

  • directionX: number

    X direction in horizontal plane.
  • directionZ: number

    Z direction in horizontal plane.
  • horizontalStrength: number

    Knockback strength for the horizontal vector.
  • verticalStrength: number

    Knockback strength for the vertical vector.

  Returns void

  Remarks

  Applies impulse vector to the current velocity of the entity.

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

  Throws

  This function can throw errors.

  Example: bounceSkeletons.ts

  import { EntityQueryOptions, DimensionLocation } from "@minecraft/server";
  
  function bounceSkeletons(targetLocation: DimensionLocation) {
    const mobs = ["creeper", "skeleton", "sheep"];
  
    // create some sample mob data
    for (let i = 0; i < 10; i++) {
      targetLocation.dimension.spawnEntity(mobs[i % mobs.length], targetLocation);
    }
  
    const eqo: EntityQueryOptions = {
      type: "skeleton",
    };
  
    for (const entity of targetLocation.dimension.getEntities(eqo)) {
      entity.applyKnockback(0, 0, 0, 1);
    }
  }
  Copy

clearDynamicProperties

• clearDynamicProperties(): void

• Returns void

  Remarks

  Clears all dynamic properties that have been set on this entity.

  Throws

  This function can throw errors.

  Example: resetStats.js

  import { world } from "@minecraft/server";
  
  for (const entity of world.getDimension("overworld").getEntities()) {
      entity.clearDynamicProperties();
  }
  Copy

clearVelocity

• clearVelocity(): void

• Returns void

  Remarks

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

  Throws

  This function can throw errors.

  Example: applyImpulse.ts

  import { DimensionLocation } from "@minecraft/server";
  import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
  
  function applyImpulse(targetLocation: DimensionLocation) {
    const zombie = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Zombie, targetLocation);
  
    zombie.clearVelocity();
  
    // throw the zombie up in the air
    zombie.applyImpulse({ x: 0, y: 0.5, z: 0 });
  }
  Copy

extinguishFire

• extinguishFire(useEffects?: boolean): boolean

• Parameters

  • OptionaluseEffects: boolean

    Whether to show any visual effects connected to the extinguishing.

  Returns boolean

  Returns whether the entity was on fire.

  Remarks

  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.

  Throws

  This function can throw errors.

  Example: setOnFire.ts

  import { system, EntityOnFireComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";
  import { MinecraftEntityTypes } from "@minecraft/vanilla-data";
  
  function setOnFire(log: (message: string, status?: number) => void, targetLocation: DimensionLocation) {
    const skelly = targetLocation.dimension.spawnEntity(MinecraftEntityTypes.Skeleton, targetLocation);
  
    skelly.setOnFire(20, true);
  
    system.runTimeout(() => {
      const onfire = skelly.getComponent(EntityComponentTypes.OnFire) as EntityOnFireComponent;
      log(onfire?.onFireTicksRemaining + " fire ticks remaining.");
  
      skelly.extinguishFire(true);
      log("Never mind. Fire extinguished.");
    }, 20);
  }
  Copy

getBlockFromViewDirection

• getBlockFromViewDirection(options?: BlockRaycastOptions): BlockRaycastHit

• Parameters

  • Optionaloptions: BlockRaycastOptions

    Additional configuration options for the ray cast.

  Returns BlockRaycastHit

  Returns the first intersecting block from the direction that this entity is looking at.

  Remarks

  Returns the first intersecting block from the direction that this entity is looking at.

  Throws

  This function can throw errors.

  Example: facingBlock.js

  import { world } from "@minecraft/server";
  
  for (const entity of world.getDimension("overworld").getEntities()) {
      const blockHit = entity.getBlockFromViewDirection();
  
      if (blockHit) {
          console.log("Block Hit:");
          console.log("Block:", blockHit.block);
          console.log("Face:", blockHit.face);
          console.log("Face Location:", JSON.stringify(blockHit.faceLocation));
      } else {
          console.log("No block in view direction.");
      }
  }
  Copy

  Example: setBedrock.js

  import { BlockPermutation, world } from "@minecraft/server";
  
  const entity = world
      .getDimension("overworld")
      .spawnEntity("minecraft:fox", { x: 0, y: 0, z: 0 });
  const blockHit = entity.getBlockFromViewDirection();
  
  if (blockHit) {
      blockHit.block.setPermutation(
          BlockPermutation.resolve("minecraft:bedrock")
      );
  } else {
      console.log("No block in view direction.");
  }
  Copy

getComponent

• getComponent(componentId: string): EntityComponent

• Parameters

  • componentId: string

    The identifier of the component (e.g., 'minecraft:health'). If no namespace prefix is specified, 'minecraft:' is assumed. Available component IDs can be found as part of the EntityComponentTypes enum.

  Returns EntityComponent

  Returns the component if it exists on the entity, otherwise undefined.

  Remarks

  Gets a component (that represents additional capabilities) for an entity.

  Example: entityHealth.js

  import { world } from "@minecraft/server";
  
  for (const player of world.getPlayers()) {
      const health = player.getComponent("health");
      player.sendMessage(
          "Your health is " + health.currentValue + "/" + health.effectiveMax
      );
      health.setCurrentValue(15); // set player to 15 hp
      health.resetToMaxValue(); // reset player to max hp
  }
  Copy

  Example: entityInventory.js

  import { ItemStack, world } from "@minecraft/server";
  
  world.afterEvents.buttonPush.subscribe((event) => {
      const entity = event.source;
      entity
          .getComponent("inventory")
          .container.addItem(new ItemStack("minecraft:dirt", 1));
  });
  Copy

  Example: entityItem.js

  import { world } from "@minecraft/server";
  
  const itemEntities = world
      .getDimension("overworld")
      .getEntities({ type: "minecraft:item" });
  for (const itemEntity of itemEntities) {
      const item = itemEntity.getComponent("item");
      item.itemStack.keepOnDeath = true;
  }
  Copy

getComponents

• getComponents(): EntityComponent[]

• Returns EntityComponent[]

  Returns all components that are both present on this entity and supported by the API.

  Remarks

  Returns all components that are both present on this entity and supported by the API.

  Example: getComponents.js

  import { world } from "@minecraft/server";
  
  for (const entity of world.getDimension("overworld").getEntities()) {
      const components = entity.getComponents();
      console.log(
          `Number of components: ${components.length}: ${components.map(
              (component) => component.typeId
          )}`
      );
  }
  Copy

getDynamicProperty

• getDynamicProperty(identifier: string): string | number | boolean | Vector3

• Parameters

  • identifier: string

    The property identifier.

  Returns string | number | boolean | Vector3

  Returns the value for the property, or undefined if the property has not been set.

  Remarks

  Returns a property value.

  Throws

  This function can throw errors.

  Example: entityRespawn.ts

  import { Vector3, system, world } from "@minecraft/server";
  
  world.afterEvents.entitySpawn.subscribe((event) => {
      event.entity.setDynamicProperty("spawn_location", event.entity.location); // set location spawn
  });
  
  world.beforeEvents.entityRemove.subscribe((event) => {
      const location = event.removedEntity.getDynamicProperty(
          "spawn_location"
      ) as Vector3; // get location spawn
      const dimension = event.removedEntity.dimension;
      system.run(() => {
          dimension.spawnEntity(event.removedEntity.typeId, location);
      });
  });
  Copy

getDynamicPropertyIds

• getDynamicPropertyIds(): string[]

• Returns string[]

  A string array of the dynamic properties set on this entity.

  Remarks

  Returns the available set of dynamic property identifiers that have been used on this entity.

  Throws

  This function can throw errors.

  Example: displayEntries.ts

  import { Player, system } from "@minecraft/server";
  
  system.afterEvents.scriptEventReceive.subscribe((event) => {
      // Type /scriptevent bp:entries to see this message
      if (event.id === "bp:entries" && event.sourceEntity instanceof Player) {
          event.sourceEntity.sendMessage(
              "Here's your dynamic properties entries:"
          );
  
          // Display all dynamic properties
          for (const id of event.sourceEntity.getDynamicPropertyIds()) {
              event.sourceEntity.sendMessage(
                  `- ${id}: ${event.sourceEntity.getDynamicProperty(id)}`
              );
          }
      }
  });
  Copy

getDynamicPropertyTotalByteCount

• getDynamicPropertyTotalByteCount(): number

• Returns number

  Remarks

  Returns the total size, in bytes, of all the dynamic properties that are currently stored for this entity. This includes the size of both the key and the value. This can be useful for diagnosing performance warning signs - if, for example, an entity has many megabytes of associated dynamic properties, it may be slow to load on various devices.

  Throws

  This function can throw errors.

  Example: displayByteCount.ts

  import { Player, system } from "@minecraft/server";
  
  system.afterEvents.scriptEventReceive.subscribe((event) => {
      // Type /scriptevent dp:size to see this message
      if (event.id === "dp:size" && event.sourceEntity instanceof Player) {
          // Returns the total size, in bytes, of all the dynamic properties that are currently stored for this entity.
          const byteCount = event.sourceEntity.getDynamicPropertyTotalByteCount();
  
          // Send the byte count to the player
          event.sourceEntity.sendMessage(
              `Dynamic Properties Byte Count: ${byteCount}`
          );
      }
  });
  Copy

getEffect

• getEffect(effectType: string | EffectType): Effect

• Parameters

  • effectType: string | EffectType

    The effect identifier.

  Returns Effect

  Effect object for the specified effect, undefined if the effect is not present, or throws an error if the effect does not exist.

  Remarks

  Returns the effect for the specified EffectType on the entity, undefined if the effect is not present, or throws an error if the effect does not exist.

  Throws

  This function can throw errors.

  Example: hasNightVision.js

  import { Player, world } from "@minecraft/server";
  
  /**
   * @param {Player} player
   */
  function hasNightVision(player) {
      const nightVision = player.getEffect("night_vision");
      if (nightVision) {
          return true;
      } else return false;
  }
  
  for (const player of world.getAllPlayers()) {
      if (hasNightVision(player)) {
          player.sendMessage("You have night vision.");
      } else {
          player.sendMessage("You don't have night vision.");
      }
  }
  Copy

getEffects

• getEffects(): Effect[]

• Returns Effect[]

  List of effects.

  Remarks

  Returns a set of effects applied to this entity.

  Throws

  This function can throw errors.

  Example: playerEffects.js

  import { world } from "@minecraft/server";
  
  for (const player of world.getAllPlayers()) {
      for (const effect of player.getEffects()) {
          player.sendMessage(
              `Effect: ${effect.displayName} | Duration: ${effect.duration} | Amplifier: ${effect.amplifier}`
          );
      }
  }
  Copy

getEntitiesFromViewDirection

• getEntitiesFromViewDirection(options?: EntityRaycastOptions): EntityRaycastHit[]

• Parameters

  • Optionaloptions: EntityRaycastOptions

    Additional configuration options for the ray cast.

  Returns EntityRaycastHit[]

  Returns a set of entities from the direction that this entity is looking at.

  Remarks

  Gets the entities that this entity is looking at by performing a ray cast from the view of this entity.

  Throws

  This function can throw errors.

  Example: entityView.ts

  import type { EntityRaycastOptions } from "@minecraft/server";
  import { world } from "@minecraft/server";
  
  // Optional: Configure ray cast options
  const raycastOptions: EntityRaycastOptions = {
      maxDistance: 10, // Set your desired maximum distance
  };
  
  // Perform the ray cast
  
  for (const entity of world.getDimension("overworld").getEntities()) {
      const entitiesInView = entity.getEntitiesFromViewDirection(raycastOptions);
  
      // Log the results
      entitiesInView.forEach((hit) => {
          console.log(`Entity hit at distance ${hit.distance} blocks.`);
          console.log("Entity details:", hit.entity); // You can access properties/methods of the hit entity
      });
  }
  Copy

getGameMode

• getGameMode(): GameMode

• Returns GameMode

  Remarks

  Retrieves the active gamemode for this player, if specified.

  Throws

  This function can throw errors.

  Example: displayGameMode.js

  import { world } from "@minecraft/server";
  
  for (const player of world.getAllPlayers()) {
      const gameMode = player.getGameMode();
      player.sendMessage(`Your game mode is ${gameMode}`);
  }
  Copy

getHeadLocation

• getHeadLocation(): Vector3

• Returns Vector3

  Returns the current location of the head component of this entity.

  Remarks

  Returns the current location of the head component of this entity.

  Throws

  This function can throw errors.

  Example: freezePlayerCamera.ts

  import { Player } from "@minecraft/server";
  
  function freezePlayerCamera(player: Player) {
      player.camera.setCamera("minecraft:free", {
          location: player.getHeadLocation(),
          rotation: player.getRotation(),
      });
  }
  Copy

getItemCooldown

• getItemCooldown(cooldownCategory: string): number

• Parameters

  • cooldownCategory: string

    Specifies the cooldown category to retrieve the current cooldown for.

  Returns number

  Remarks

  Gets the current item cooldown time for a particular cooldown category.

  Throws

  This function can throw errors.

  Example: getEquipmentCooldown.js

  import { world } from "@minecraft/server";
  
  const player = world.getAllPlayers()[0];
  const cooldown = player.getItemCooldown("equipment");
  console.log(`Cooldown for the equipment category: ${cooldown} seconds.`);
  Copy

getProperty

• getProperty(identifier: string): string | number | boolean

• Parameters

  • identifier: string

    The entity Property identifier.

  Returns string | number | boolean

  Returns the current property value. For enum properties, a string is returned. For float and int properties, a number is returned. For undefined properties, undefined is returned.

  Remarks

  Gets an entity Property value. If the property was set using the setProperty function within the same tick, the updated value will not be reflected until the subsequent tick.

  Throws

  Throws if the entity is invalid.

  Example: getRotationOffset.js

  import { world } from "@minecraft/server";
  
  const entity = world
      .getDimension("overworld")
      .getEntities({ type: "create:dummy" })[0];
  entity.setProperty("create:rotation_offset", 1);
  console.warn(entity.getProperty("create:rotation_offset"));
  Copy

getRotation

• getRotation(): Vector2

• Returns Vector2

  Returns a Vec2 containing the rotation of this entity (in degrees).

  Remarks

  Returns the current rotation component of this entity.

  Throws

  This function can throw errors.

  Example: getRotation.js

  import { world } from "@minecraft/server";
  
  world.beforeEvents.chatSend.subscribe((event) => {
      const message = event.message;
      const player = event.sender;
      if (message === "rotation get") {
          event.cancel = true;
          const rotation = player.getRotation();
          player.sendMessage(`Spawn point location: ${rotation.x} ${rotation.y}`);
      }
  });
  Copy

getSpawnPoint

• getSpawnPoint(): DimensionLocation

• Returns DimensionLocation

  Remarks

  Gets the current spawn point of the player.

  Throws

  This function can throw errors.

  Example: getSpawnPoint.js

  import { world } from "@minecraft/server";
  
  world.beforeEvents.chatSend.subscribe((event) => {
      const message = event.message;
      const player = event.sender;
      if (message === "spawnpoint get") {
          event.cancel = true;
          const spawnPoint = player.getSpawnPoint();
          if (spawnPoint) {
              player.sendMessage(
                  `Spawn point location: ${spawnPoint.x} ${spawnPoint.y} ${spawnPoint.z} at ${spawnPoint.dimension.id}`
              );
          } else {
              player.sendMessage(`No spawn point set.`);
          }
      }
  });
  Copy