接口 EntityQueryOptions实验性

Contains options for selecting entities within an area.

示例: blockConditional.ts

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

function blockConditional(targetLocation: DimensionLocation) {
  targetLocation.dimension
    .getEntities({
      type: "fox",
    })
    .filter((entity) => {
      const block = targetLocation.dimension.getBlock({
        x: entity.location.x,
        y: entity.location.y - 1,
        z: entity.location.z,
      });

      return block !== undefined && block.matches("minecraft:stone");
    })
    .forEach((entity) => {
      targetLocation.dimension.spawnEntity("salmon", entity.location);
    });
}

示例: findEntitiesHavingPropertyEqualsTo.ts

import { EntityQueryOptions, DimensionLocation } from "@minecraft/server";

function findEntitiesHavingPropertyEqualsTo(
    targetLocation: DimensionLocation
) {
  // Minecraft bees have a has_nectar boolean property
  const queryOption: EntityQueryOptions = {
    propertyOptions: [{ propertyId: "minecraft:has_nectar", value: { equals: true } }],
  };

  const entities = targetLocation.dimension.getEntities(queryOption);
}

示例: playSoundChained.ts

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

function playSoundChained(targetLocation: DimensionLocation) {
  const targetPlayers = targetLocation.dimension.getPlayers();
  const originEntities = targetLocation.dimension.getEntities({
    type: "armor_stand",
    name: "myArmorStand",
    tags: ["dummyTag1"],
    excludeTags: ["dummyTag2"],
  });

  originEntities.forEach((entity) => {
    targetPlayers.forEach((player) => {
      player.playSound("raid.horn");
    });
  });
}

示例: setScoreboardChained.ts

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

function setScoreboardChained(
    targetLocation: DimensionLocation
) {
  const objective = world.scoreboard.addObjective("scoreObjective1", "dummy");
  targetLocation.dimension
    .getEntities({
      type: "armor_stand",
      name: "myArmorStand",
    })
    .forEach((entity) => {
      if (entity.scoreboardIdentity !== undefined) {
        objective.setScore(entity.scoreboardIdentity, -1);
      }
    });
}

示例: summonMobChained.ts

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

function summonMobChained(targetLocation: DimensionLocation) {
  const armorStandArray = targetLocation.dimension.getEntities({
    type: "armor_stand",
  });
  const playerArray = targetLocation.dimension.getPlayers({
    location: { x: 0, y: -60, z: 0 },
    closest: 4,
    maxDistance: 15,
  });
  armorStandArray.forEach((entity) => {
    playerArray.forEach((player) => {
      targetLocation.dimension.spawnEntity("pig", {
        x: player.location.x + 1,
        y: player.location.y,
        z: player.location.z,
      });
    });
  });
}

示例: 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);
  }
}

示例: 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();
  }
}

示例: testThatEntityIsFeatherItem.ts

import { EntityItemComponent, EntityComponentTypes, DimensionLocation } from "@minecraft/server";

function testThatEntityIsFeatherItem(
  log: (message: string, status?: number) => void,
  targetLocation: DimensionLocation
) {
  const items = targetLocation.dimension.getEntities({
    location: targetLocation,
    maxDistance: 20,
  });

  for (const item of items) {
    const itemComp = item.getComponent(EntityComponentTypes.Item) as EntityItemComponent;

    if (itemComp) {
      if (itemComp.itemStack.typeId.endsWith("feather")) {
        log("Success! Found a feather", 1);
      }
    }
  }
}
interface EntityQueryOptions {
    closest?: number;
    excludeFamilies?: string[];
    excludeGameModes?: GameMode[];
    excludeNames?: string[];
    excludeTags?: string[];
    excludeTypes?: string[];
    families?: string[];
    farthest?: number;
    gameMode?: GameMode;
    location?: Vector3;
    maxDistance?: number;
    maxHorizontalRotation?: number;
    maxLevel?: number;
    maxVerticalRotation?: number;
    minDistance?: number;
    minHorizontalRotation?: number;
    minLevel?: number;
    minVerticalRotation?: number;
    name?: string;
    propertyOptions?: EntityQueryPropertyOptions[];
    scoreOptions?: EntityQueryScoreOptions[];
    tags?: string[];
    type?: string;
    volume?: Vector3;
}

层级 (查看完整内容)

属性

closest? excludeFamilies? excludeGameModes? excludeNames? excludeTags? excludeTypes? families? farthest? gameMode? location? maxDistance? maxHorizontalRotation? maxLevel? maxVerticalRotation? minDistance? minHorizontalRotation? minLevel? minVerticalRotation? name? propertyOptions? scoreOptions? tags? type? volume?

属性

可选 实验性closest

closest?: number

备注

Limits the number of entities to return, opting for the closest N entities as specified by this property. The location value must also be specified on the query options object.

可选 实验性excludeFamilies

excludeFamilies?: string[]

备注

Excludes entities that match one or more of the specified families.

可选 实验性excludeGameModes

excludeGameModes?: GameMode[]

备注

Excludes entities if have a specific gamemode that matches the specified gamemode.

可选 实验性excludeNames

excludeNames?: string[]

备注

Excludes entities that have a name that match one of the specified values.

可选 实验性excludeTags

excludeTags?: string[]

备注

Excludes entities with a tag that matches one of the specified values.

可选 实验性excludeTypes

excludeTypes?: string[]

备注

Excludes entities if they are one of the specified types.

可选 实验性families

families?: string[]

备注

If specified, includes entities that match all of the specified families.

可选 实验性farthest

farthest?: number

备注

Limits the number of entities to return, opting for the farthest N entities as specified by this property. The location value must also be specified on the query options object.

可选 实验性gameMode

gameMode?: GameMode

备注

If specified, includes entities with a gamemode that matches the specified gamemode.

可选 实验性location

location?: Vector3

备注

Adds a seed location to the query that is used in conjunction with closest, farthest, limit, volume, and distance properties.

可选 实验性maxDistance

maxDistance?: number

备注

If specified, includes entities that are less than this distance away from the location specified in the location property.

可选 实验性maxHorizontalRotation

maxHorizontalRotation?: number

备注

If specified, will only include entities that have at most this horizontal rotation.

可选 实验性maxLevel

maxLevel?: number

备注

If defined, only players that have at most this level are returned.

可选 实验性maxVerticalRotation

maxVerticalRotation?: number

备注

If specified, only entities that have at most this vertical rotation are returned.

可选 实验性minDistance

minDistance?: number

备注

If specified, includes entities that are least this distance away from the location specified in the location property.

可选 实验性minHorizontalRotation

minHorizontalRotation?: number

备注

If specified, will only include entities that have at a minimum this horizontal rotation.

可选 实验性minLevel

minLevel?: number

备注

If defined, only players that have at least this level are returned.

可选 实验性minVerticalRotation

minVerticalRotation?: number

备注

If specified, will only include entities that have at least this vertical rotation.

可选 实验性name

name?: string

备注

Includes entities with the specified name.

可选 实验性propertyOptions

propertyOptions?: EntityQueryPropertyOptions[]

可选 实验性scoreOptions

scoreOptions?: EntityQueryScoreOptions[]

备注

Gets/sets a collection of EntityQueryScoreOptions objects with filters for specific scoreboard objectives.

可选 实验性tags

tags?: string[]

备注

Includes entities that match all of the specified tags.

可选 实验性type

type?: string

备注

If defined, entities that match this type are included.

可选 实验性volume

volume?: Vector3

备注

In conjunction with location, specified a cuboid volume of entities to include.

显示设置

成员可见性

目录

属性