#Interface: EntityQueryOptions

Beta

包含在区域内选择实体的选项。

#Examples

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);
    });
}

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);
}

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');
    });
  });
}

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);
      }
    });
}

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,
      });
    });
  });
}

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);
  }
}

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

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);
      }
    }
  }
}

#Extends

• EntityFilter

#Properties

#closest?

optional closest?: number

Beta

#Remarks

限制返回的实体数量，按照此属性指定的最近 N 个实体来选择。查询选项对象上也必须指定 location 值。

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?

optional excludeFamilies?: string[]

Beta

#Remarks

排除匹配一个或多个指定系列的实体。

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

#Inherited from

EntityFilter.excludeFamilies

#excludeGameModes?

optional excludeGameModes?: GameMode[]

Beta

#Remarks

如果实体的特定游戏模式与指定游戏模式匹配，则排除该实体。

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

#Inherited from

EntityFilter.excludeGameModes

#excludeNames?

optional excludeNames?: string[]

Beta

#Remarks

排除名称与指定值之一匹配的实体。

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

#Inherited from

EntityFilter.excludeNames

#excludeTags?

optional excludeTags?: string[]

Beta

#Remarks

排除带有与指定值之一匹配的标签的实体。

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

#Inherited from

EntityFilter.excludeTags

#excludeTypes?

optional excludeTypes?: string[]

Beta

#Remarks

排除如果它们是指定类型之一的实体。

Excludes entities if they are one of the specified types.

#Inherited from

EntityFilter.excludeTypes

#families?

optional families?: string[]

Beta

#Remarks

如果指定，则包含匹配所有指定系列的实体。

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

#Inherited from

EntityFilter.families

#farthest?

optional farthest?: number

Beta

#Remarks

限制返回的实体数量，按照此属性指定的最远 N 个实体来选择。查询选项对象上也必须指定 location 值。

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?

optional gameMode?: GameMode

Beta

#Remarks

如果指定，则包含游戏模式与指定游戏模式匹配的实体。

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

#Inherited from

EntityFilter.gameMode

#location?

optional location?: Vector3

Beta

#Remarks

向查询添加一个种子位置，与 closest、farthest、limit、volume 和 distance 属性配合使用。

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

#maxDistance?

optional maxDistance?: number

Beta

#Remarks

如果指定，则包含距离 location 属性中指定位置小于此距离的实体。

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

#maxHorizontalRotation?

optional maxHorizontalRotation?: number

Beta

#Remarks

如果指定，则仅包含水平旋转角度最多为此值的实体。

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

#Inherited from

EntityFilter.maxHorizontalRotation

#maxLevel?

optional maxLevel?: number

Beta

#Remarks

如果定义，仅返回等级最多为此值的玩家。

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

#Inherited from

EntityFilter.maxLevel

#maxVerticalRotation?

optional maxVerticalRotation?: number

Beta

#Remarks

如果指定，仅返回垂直旋转角度最多为此值的实体。

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

#Inherited from

EntityFilter.maxVerticalRotation

#minDistance?

optional minDistance?: number

Beta

#Remarks

如果指定，则包含距离 location 属性中指定位置至少为此距离的实体。

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

#minHorizontalRotation?

optional minHorizontalRotation?: number

Beta

#Remarks

如果指定，将仅包含水平旋转角度至少为此值的实体。

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

#Inherited from

EntityFilter.minHorizontalRotation

#minLevel?

optional minLevel?: number

Beta

#Remarks

如果定义，仅返回等级至少为此值的玩家。

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

#Inherited from

EntityFilter.minLevel

#minVerticalRotation?

optional minVerticalRotation?: number

Beta

#Remarks

如果指定，将仅包含垂直旋转角度至少为此值的实体。

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

#Inherited from

EntityFilter.minVerticalRotation

#name?

optional name?: string

Beta

#Remarks

包含具有指定名称的实体。

Includes entities with the specified name.

#Inherited from

EntityFilter.name

#propertyOptions?

optional propertyOptions?: EntityQueryPropertyOptions[]

Beta

#Inherited from

EntityFilter.propertyOptions

#scoreOptions?

optional scoreOptions?: EntityQueryScoreOptions[]

Beta

#Remarks

获取/设置一组带有特定计分板目标过滤器的 EntityQueryScoreOptions 对象。

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

#Inherited from

EntityFilter.scoreOptions

#tags?

optional tags?: string[]

Beta

#Remarks

包含匹配所有指定标签的实体。

Includes entities that match all of the specified tags.

#Inherited from

EntityFilter.tags

#type?

optional type?: string

Beta

#Remarks

如果定义，则包含匹配此类型的实体。

If defined, entities that match this type are included.

#Inherited from

EntityFilter.type

#volume?

optional volume?: Vector3

Beta

#Remarks

与 location 结合使用，指定一个要包含的实体的长方体体积。

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

#同领域相关

• BlockComponentEntityEvent
• BlockComponentEntityFallOnEvent
• CarryOverBlockEntityDataFunction
• DamagedByEntityCondition
• DataDrivenEntityTriggerAfterEvent
• DataDrivenEntityTriggerAfterEventSignal