@minecraft/server 1.1.0-rc.1.19.80-preview.21 → 1.1.0-rc.1.19.80-preview.23

package/index.d.ts

@@ -16,11 +16,44 @@
  * ```json
  * {
  *   "module_name": "@minecraft/server",
- *   "version": "1.2.0-internal.1.19.80-preview.21"
+ *   "version": "1.2.0-internal.1.19.80-preview.23"
  * }
  * ```
  *
  */
+/**
+ * @beta
+ * Represents a game mode for the current world experience.
+ */
+export enum GameMode {
+    /**
+     * @beta
+     * World is in a more locked-down experience, where blocks may
+     * not be manipulated.
+     */
+    adventure = 'adventure',
+    /**
+     * @beta
+     * World is in a full creative mode. In creative mode, the
+     * player has all the resources available in the item selection
+     * tabs and the survival selection tab. They can also destroy
+     * blocks instantly including those which would normally be
+     * indestructible. Command and structure blocks can also be
+     * used in creative mode. Items also do not lose durability or
+     * disappear.
+     */
+    creative = 'creative',
+    spectator = 'spectator',
+    /**
+     * @beta
+     * World is in a survival mode, where players can take damage
+     * and entities may not be peaceful. Survival mode is where the
+     * player must collect resources, build structures while
+     * surviving in their generated world. Activities can, over
+     * time, chip away at player health and hunger bar.
+     */
+    survival = 'survival',
+}
 /**
  * @beta
  * Represents a block in a dimension. A block represents a
@@ -115,6 +148,61 @@ export class Dimension {
      * @throws This function can throw errors.
      */
     getBlock(location: Vector3): Block;
+    /**
+     * @beta
+     * @remarks
+     * Returns a set of entities based on a set of conditions
+     * defined via the EntityQueryOptions set of filter criteria.
+     * @param options
+     * Additional options that can be used to filter the set of
+     * entities returned.
+     * @returns
+     * An entity array.
+     * @throws This function can throw errors.
+     * @example testThatEntityIsFeatherItem.ts
+     * ```typescript
+     *        const query = {
+     *          type: "item",
+     *          location: targetLocation,
+     *        };
+     *        const items = overworld.getEntities(query);
+     *
+     *        for (const item of items) {
+     *          const itemComp = item.getComponent("item") as any;
+     *
+     *          if (itemComp) {
+     *            if (itemComp.itemStack.id.endsWith("feather")) {
+     *              console.log("Success! Found a feather", 1);
+     *            }
+     *          }
+     *        }
+     *
+     * ```
+     */
+    getEntities(options?: EntityQueryOptions): Entity[];
+    /**
+     * @beta
+     * @remarks
+     * Returns a set of entities at a particular location.
+     * @param location
+     * The location at which to return entities.
+     * @returns
+     * Zero or more entities at the specified location.
+     */
+    getEntitiesAtBlockLocation(location: Vector3): Entity[];
+    /**
+     * @beta
+     * @remarks
+     * Returns a set of players based on a set of conditions
+     * defined via the EntityQueryOptions set of filter criteria.
+     * @param options
+     * Additional options that can be used to filter the set of
+     * players returned.
+     * @returns
+     * A player array.
+     * @throws This function can throw errors.
+     */
+    getPlayers(options?: EntityQueryOptions): Player[];
     /**
      * @remarks
      * Runs a particular command asynchronously from the context of
@@ -137,6 +225,12 @@ export class Dimension {
  */
 export class Entity {
     protected constructor();
+    /**
+     * @beta
+     * Dimension that the entity is currently within.
+     * @throws This property can throw when used.
+     */
+    readonly dimension: Dimension;
     /**
      * Unique identifier of the entity. This identifier is intended
      * to be consistent across loads of a world instance. No
@@ -145,12 +239,38 @@ export class Entity {
      * @throws This property can throw when used.
      */
     readonly id: string;
+    /**
+     * @beta
+     * Current location of the entity.
+     * @throws This property can throw when used.
+     */
+    readonly location: Vector3;
+    /**
+     * @beta
+     * Given name of the entity.
+     */
+    nameTag: string;
     /**
      * Unique identifier of the type of the entity - for example,
      * 'minecraft:skeleton'.
      * @throws This property can throw when used.
      */
     readonly typeId: string;
+    /**
+     * @beta
+     * @throws This function can throw errors.
+     */
+    getHeadLocation(): Vector3;
+    /**
+     * @beta
+     * @throws This function can throw errors.
+     */
+    getVelocity(): Vector3;
+    /**
+     * @beta
+     * @throws This function can throw errors.
+     */
+    getViewDirection(): Vector3;
     /**
      * @remarks
      * Runs a particular command asynchronously from the context of
@@ -169,7 +289,6 @@ export class Entity {
 /**
  * A collection of default Minecraft dimension types.
  */
-// tslint:disable-next-line:no-unnecessary-class
 export class MinecraftDimensionTypes {
     protected constructor();
     /**
@@ -268,7 +387,6 @@ export class System {
      * @remarks
      * Cancels the execution of a function run that was previously
      * scheduled via the `run` function.
-     * @param runId
      */
     clearRun(runId: number): void;
     /**
@@ -328,13 +446,25 @@ export class World {
     /**
      * @remarks
      * Returns a dimension object.
-     * @param dimensionId
      * @returns
      * The requested dimension
      * @throws
      * Throws if the given dimension name is invalid
      */
     getDimension(dimensionId: string): Dimension;
+    /**
+     * @beta
+     * @remarks
+     * Returns a set of players based on a set of conditions
+     * defined via the EntityQueryOptions set of filter criteria.
+     * @param options
+     * Additional options that can be used to filter the set of
+     * players returned.
+     * @returns
+     * A player array.
+     * @throws This function can throw errors.
+     */
+    getPlayers(options?: EntityQueryOptions): Player[];
     /**
      * @beta
      * @remarks
@@ -378,6 +508,153 @@ export class World {
      */
     sendMessage(message: (RawMessage | string)[] | RawMessage | string): void;
 }
+/**
+ * @beta
+ * Contains options for selecting entities within an area.
+ */
+export interface 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?: number;
+    /**
+     * Excludes entities that match one or more of the specified
+     * families.
+     */
+    excludeFamilies?: string[];
+    /**
+     * Excludes entities if have a specific gamemode that matches
+     * the specified gamemode.
+     */
+    excludeGameModes?: GameMode[];
+    /**
+     * Excludes entities that have a name that match one of the
+     * specified values.
+     */
+    excludeNames?: string[];
+    /**
+     * Excludes entities with a tag that matches one of the
+     * specified values.
+     */
+    excludeTags?: string[];
+    /**
+     * Excludes entities if they are one of the specified types.
+     */
+    excludeTypes?: string[];
+    /**
+     * If specified, includes entities that match all of the
+     * specified families.
+     */
+    families?: string[];
+    /**
+     * 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?: number;
+    /**
+     * If specified, includes entities with a gamemode that matches
+     * the specified gamemode.
+     */
+    gameMode?: GameMode;
+    /**
+     * Adds a seed location to the query that is used in
+     * conjunction with closest, farthest, limit, volume, and
+     * distance properties.
+     */
+    location?: Vector3;
+    /**
+     * If specified, includes entities that are less than this
+     * distance away from the location specified in the location
+     * property.
+     */
+    maxDistance?: number;
+    /**
+     * If specified, will only include entities that have at most
+     * this horizontal rotation.
+     */
+    maxHorizontalRotation?: number;
+    /**
+     * If defined, only players that have at most this level are
+     * returned.
+     */
+    maxLevel?: number;
+    /**
+     * If specified, only entities that have at most this vertical
+     * rotation are returned.
+     */
+    maxVerticalRotation?: number;
+    /**
+     * If specified, includes entities that are least this distance
+     * away from the location specified in the location property.
+     */
+    minDistance?: number;
+    /**
+     * If specified, will only include entities that have at a
+     * minimum this horizontal rotation.
+     */
+    minHorizontalRotation?: number;
+    /**
+     * If defined, only players that have at least this level are
+     * returned.
+     */
+    minLevel?: number;
+    /**
+     * If specified, will only include entities that have at least
+     * this vertical rotation.
+     */
+    minVerticalRotation?: number;
+    /**
+     * Includes entities with the specified name.
+     */
+    name?: string;
+    /**
+     * Gets/sets a collection of EntityQueryScoreOptions objects
+     * with filters for specific scoreboard objectives.
+     */
+    scoreOptions?: EntityQueryScoreOptions[];
+    /**
+     * Includes entities that match all of the specified tags.
+     */
+    tags?: string[];
+    /**
+     * If defined, entities that match this type are included.
+     */
+    type?: string;
+}
+/**
+ * @beta
+ * Contains additional options for filtering players based on
+ * their score for an objective.
+ */
+export interface EntityQueryScoreOptions {
+    /**
+     * If set to true, entities and players within this score range
+     * are excluded from query results.
+     */
+    exclude?: boolean;
+    /**
+     * If defined, only players that have a score equal to or under
+     * maxScore are included.
+     */
+    maxScore?: number;
+    /**
+     * If defined, only players that have a score equal to or over
+     * minScore are included.
+     */
+    minScore?: number;
+    /**
+     * Identifier of the scoreboard objective to filter on.
+     */
+    objective?: string;
+}
+/**
+ * @beta
+ */
 export interface RawMessage {
     rawtext?: RawMessage[];
     score?: RawMessageScore;
@@ -385,6 +662,9 @@ export interface RawMessage {
     translate?: string;
     with?: string[] | RawMessage;
 }
+/**
+ * @beta
+ */
 export interface RawMessageScore {
     name?: string;
     objective?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "1.1.0-rc.1.19.80-preview.21",
+  "version": "1.1.0-rc.1.19.80-preview.23",
   "description": "",
   "contributors": [
     {