@minecraft/creator-tools
Version:
Minecraft Creator Tools command line and libraries.
129 lines (128 loc) • 3.5 kB
JavaScript
"use strict";
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
Object.defineProperty(exports, "__esModule", { value: true });
/**
* Contains options for selecting entities within an area.
*/
class EntityQueryOptions {
/**
* 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.
*/
"closest";
/**
* Excludes entities that match one or more of the specified
* families.
*/
"excludeFamilies";
/**
* Excludes entities if have a specific gamemode that matches
* the specified gamemode.
*/
"excludeGameModes";
/**
* Excludes entities that have a name that match one of the
* specified values.
*/
"excludeNames";
/**
* Excludes entities with a tag that matches one of the
* specified values.
*/
"excludeTags";
/**
* Excludes entities if they are one of the specified types.
*/
"excludeTypes";
/**
* If specified, includes entities that match one of the
* specified families.
*/
"families";
/**
* 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.
*/
"farthest";
/**
* If specified, includes entities with a gamemode that matches
* the specified gamemode.
*/
"gameMode";
/**
* Adds a seed location to the query that is used in
* conjunction with closest, farthest, limit, volume, and
* distance properties.
*/
"location";
/**
* If specified, includes entities that are less than this
* distance away from the location specified in the location
* property.
*/
"maxDistance";
/**
* If specified, will only include entities that have at most
* this horizontal rotation.
*/
"maxHorizontalRotation";
/**
* If defined, only players that have at most this level are
* returned.
*/
"maxLevel";
/**
* If specified, only entities that have at most this vertical
* rotation are returned.
*/
"maxVerticalRotation";
/**
* If specified, includes entities that are least this distance
* away from the location specified in the location property.
*/
"minDistance";
/**
* If specified, will only include entities that have at a
* minimum this horizontal rotation.
*/
"minHorizontalRotation";
/**
* If defined, only players that have at least this level are
* returned.
*/
"minLevel";
/**
* If specified, will only include entities that have at least
* this vertical rotation.
*/
"minVerticalRotation";
/**
* Includes entities with the specified name.
*/
"name";
/**
* Gets/sets a collection of EntityQueryScoreOptions objects
* with filters for specific scoreboard objectives.
*/
"scoreOptions";
/**
* Includes entities that match one or more of the specified
* tags.
*/
"tags";
/**
* If defined, entities that match this type are included.
*/
"type";
/**
* In conjunction with location, specified a cuboid volume of
* entities to include.
*/
"volume";
}
exports.default = EntityQueryOptions;