@minecraft/server 2.12.0-rc.1.26.70-preview.20 → 2.12.0-rc.1.26.70-preview.21

package/index.d.ts

@@ -2105,6 +2105,13 @@ export enum InputMode {
      *
      */
     Gamepad = 'Gamepad',
+    /**
+     * @rc
+     * @remarks
+     * Gamepad and mouse input.
+     *
+     */
+    GamepadAndMouse = 'GamepadAndMouse',
     /**
      * @remarks
      * Keyboard and mouse input.
@@ -2214,7 +2221,7 @@ export enum InputPermissionCategory {
  * function ItemStack.getComponent.
  */
 export enum ItemComponentTypes {
-    BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
+    BlockDynamicProperties = 'minecraft:block_dynamic_properties',
     /**
      * @remarks
      * The minecraft:book component.
@@ -2686,6 +2693,34 @@ export enum PlayerSplitScreenSlot {
     Third = 'Third',
 }
 
+/**
+ * @rc
+ * Specifies how a block point-of-interest query filters
+ * instances by ticket occupancy.
+ */
+export enum PoiBlockOccupancyFilter {
+    /**
+     * @remarks
+     * Includes POI instances regardless of their occupancy or
+     * available ticket count.
+     *
+     */
+    Any = 'Any',
+    /**
+     * @remarks
+     * Includes POI instances with no available tickets.
+     *
+     */
+    Full = 'Full',
+    /**
+     * @remarks
+     * Includes POI instances with at least one ticket available to
+     * be claimed.
+     *
+     */
+    HasVacancy = 'HasVacancy',
+}
+
 /**
  * Contains objectives and participants for the scoreboard.
  */
@@ -3254,7 +3289,7 @@ export type ItemComponentReturnType<T extends string> = T extends keyof ItemComp
     : ItemCustomComponentInstance;
 
 export type ItemComponentTypeMap = {
-    block_actor_dynamic_properties: ItemBlockDynamicPropertiesComponent;
+    block_dynamic_properties: ItemBlockDynamicPropertiesComponent;
     book: ItemBookComponent;
     compostable: ItemCompostableComponent;
     cooldown: ItemCooldownComponent;
@@ -3263,7 +3298,7 @@ export type ItemComponentTypeMap = {
     enchantable: ItemEnchantableComponent;
     food: ItemFoodComponent;
     inventory: ItemInventoryComponent;
-    'minecraft:block_actor_dynamic_properties': ItemBlockDynamicPropertiesComponent;
+    'minecraft:block_dynamic_properties': ItemBlockDynamicPropertiesComponent;
     'minecraft:book': ItemBookComponent;
     'minecraft:compostable': ItemCompostableComponent;
     'minecraft:cooldown': ItemCooldownComponent;
@@ -7544,6 +7579,15 @@ export class Dimension {
      *
      */
     readonly localizationKey: string;
+    /**
+     * @rc
+     * @remarks
+     * Provides access to point-of-interest (POI) managers for this
+     * dimension. This property is available only when the POI
+     * experiment is enabled.
+     *
+     */
+    readonly poiManager: PoiManager;
     /**
      * @remarks
      * Calculates the location of the closest biome of a particular
@@ -7817,7 +7861,7 @@ export class Dimension {
      * The options to decide if a block is a valid result.
      * @throws This function can throw errors.
      */
-    getBlockAbove(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
+    getBlockAbove(location: Vector3, options?: BlockSearchOptions): Block | undefined;
     /**
      * @remarks
      * Gets the first block found below a given block location
@@ -7830,7 +7874,7 @@ export class Dimension {
      * The options to decide if a block is a valid result.
      * @throws This function can throw errors.
      */
-    getBlockBelow(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
+    getBlockBelow(location: Vector3, options?: BlockSearchOptions): Block | undefined;
     /**
      * @remarks
      * Gets the first block that intersects with a vector emanating
@@ -14178,7 +14222,7 @@ export class ISerializable {
 // @ts-ignore Class inheritance allowed for native defined classes
 export class ItemBlockDynamicPropertiesComponent extends ItemComponent {
     private constructor();
-    static readonly componentId = 'minecraft:block_actor_dynamic_properties';
+    static readonly componentId = 'minecraft:block_dynamic_properties';
     /**
      * @remarks
      * Returns a DynamicProperty that was stored with the provided
@@ -19310,6 +19354,299 @@ export class PlayerWaypoint extends EntityWaypoint {
     );
 }
 
+/**
+ * @rc
+ * Describes a block point-of-interest instance returned by a
+ * query.
+ */
+export class PoiBlockInstance {
+    private constructor();
+    /**
+     * @remarks
+     * Block position of this POI instance.
+     *
+     */
+    readonly position: Vector3;
+    /**
+     * @remarks
+     * Number of tickets currently available to be claimed from
+     * this POI instance.
+     *
+     */
+    readonly tickets: number;
+    /**
+     * @remarks
+     * Type of this POI instance.
+     *
+     */
+    readonly 'type': PoiBlockType;
+}
+
+/**
+ * @rc
+ * Provides methods for querying and managing block-based
+ * points of interest in a dimension.
+ */
+export class PoiBlockManager {
+    private constructor();
+    /**
+     * @remarks
+     * Adds a block point of interest at a position. This method is
+     * intended for temporary usage. Will be replaced when chunk is
+     * reloaded
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param position
+     * Block position at which to add the POI.
+     * @param poi
+     * POI type to add, specified by numeric type Id, type name, or
+     * POI type object.
+     */
+    addTemporary(position: Vector3, poi: PoiBlockType | string | number): void;
+    /**
+     * @remarks
+     * Gets the type of the block point of interest at a position.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param position
+     * Block position to inspect.
+     * @returns
+     * The POI type at the position, or undefined if no POI exists
+     * there.
+     */
+    at(position: Vector3): PoiBlockType | undefined;
+    /**
+     * @remarks
+     * Tests whether a block point of interest at a position
+     * matches a type filter.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param position
+     * Block position to inspect.
+     * @param filter
+     * Filter used to select the POI type. A callback receives the
+     * POI type and returns whether it matches; a name filter
+     * matches a type name; and a tag filter requires all specified
+     * tags.
+     * @returns
+     * True if a POI exists at the position and its type matches
+     * the filter; otherwise false.
+     */
+    exists(position: Vector3, filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter): boolean;
+    /**
+     * @remarks
+     * Returns block points of interest that match the supplied
+     * type and occupancy filters within the specified distance of
+     * a location.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param filter
+     * Filter used to select POI types. A callback receives each
+     * POI type and returns whether it should be included; a name
+     * filter matches a type name; and a tag filter requires all
+     * specified tags.
+     * @param center
+     * Center of the search.
+     * @param blockRadius
+     * Maximum three-dimensional distance from the center, in
+     * blocks.
+     * @param occupancyFilter
+     * Optional filter applied to the occupancy state of matching
+     * POIs. If omitted, POIs in any occupancy state are returned.
+     * @returns
+     * The matching POI instances within range. The result order is
+     * not guaranteed.
+     */
+    getInRange(
+        filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
+        center: Vector3,
+        blockRadius: number,
+        occupancyFilter?: PoiBlockOccupancyFilter,
+    ): PoiBlockInstance[];
+    /**
+     * @remarks
+     * Returns block points of interest that match the supplied
+     * type and occupancy filters within an axis-aligned square
+     * centered on the specified location, sorted from nearest to
+     * farthest.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param filter
+     * Filter used to select POI types. A callback receives each
+     * POI type and returns whether it should be included; a name
+     * filter matches a type name; and a tag filter requires all
+     * specified tags.
+     * @param center
+     * Center of the search and the location from which distances
+     * are calculated.
+     * @param blockRadius
+     * Maximum three-dimensional distance from the center, in
+     * blocks.
+     * @param occupancyFilter
+     * Optional filter applied to the occupancy state of matching
+     * POIs. If omitted, POIs in any occupancy state are returned.
+     * @returns
+     * The matching POI instances and their squared distances from
+     * the center, sorted in ascending distance order.
+     */
+    getInRangeSorted(
+        filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
+        center: Vector3,
+        blockRadius: number,
+        occupancyFilter?: PoiBlockOccupancyFilter,
+    ): PoiDistancePair[];
+    /**
+     * @remarks
+     * Returns block points of interest that match the supplied
+     * type and occupancy filters within an axis-aligned square
+     * centered on the specified location.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param filter
+     * Filter used to select POI types. A callback receives each
+     * POI type and returns whether it should be included; a name
+     * filter matches a type name; and a tag filter requires all
+     * specified tags.
+     * @param center
+     * Center of the search volume.
+     * @param blockRadius
+     * Half-size of the search volume, in blocks, along each axis.
+     * @param occupancyFilter
+     * Optional filter applied to the occupancy state of matching
+     * POIs. If omitted, POIs in any occupancy state are returned.
+     * @returns
+     * The matching POI instances in the search volume.
+     */
+    getInSquare(
+        filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
+        center: Vector3,
+        blockRadius: number,
+        occupancyFilter?: PoiBlockOccupancyFilter,
+    ): PoiBlockInstance[];
+    /**
+     * @remarks
+     * Releases one previously claimed ticket at a block point of
+     * interest.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param center
+     * Block position of the POI whose ticket should be released.
+     * @returns
+     * True if a ticket was released; false if no POI exists at the
+     * position or the POI has no claimed tickets.
+     */
+    release(center: Vector3): boolean;
+    /**
+     * @remarks
+     * Claims one available ticket from a matching block point of
+     * interest within range.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param filter
+     * Filter used to select the POI type to claim. A callback
+     * receives each POI type and returns whether it should be
+     * included; a name filter matches a type name; and a tag
+     * filter requires all specified tags.
+     * @param center
+     * Center of the search.
+     * @param blockRadius
+     * Maximum three-dimensional distance from the center, in
+     * blocks.
+     * @returns
+     * The block position of the claimed POI, or undefined if no
+     * matching POI has an available ticket.
+     */
+    take(
+        filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
+        center: Vector3,
+        blockRadius: number,
+    ): Vector3 | undefined;
+}
+
+/**
+ * @rc
+ * Describes a block point-of-interest type.
+ */
+export class PoiBlockType {
+    private constructor();
+    /**
+     * @remarks
+     * Numeric identifier of this POI type.
+     *
+     */
+    readonly id: number;
+    /**
+     * @remarks
+     * Namespaced identifier of this POI type.
+     *
+     */
+    readonly name: string;
+    /**
+     * @remarks
+     * Maximum number of tickets that can be claimed from each POI
+     * instance of this type.
+     *
+     */
+    readonly tickets: number;
+    /**
+     * @remarks
+     * Maximum range, in blocks, at which this POI type is
+     * considered usable.
+     *
+     */
+    readonly usableRange: number;
+    /**
+     * @remarks
+     * Tests whether this object and another object describe the
+     * same POI type.
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param other
+     * POI type to compare with this type.
+     * @returns
+     * True if both objects describe the same POI type; otherwise
+     * false.
+     */
+    equals(other: PoiBlockType): boolean;
+    /**
+     * @remarks
+     * Tests whether the type has the provided tag attribute
+     *
+     * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
+     *
+     * @param tag
+     * POI tag to check.
+     * @returns
+     * True if the POI conatains the tag; otherwise false.
+     */
+    hasTag(tag: string): boolean;
+}
+
+/**
+ * @rc
+ * Provides access to point-of-interest (POI) data in a
+ * dimension.
+ */
+export class PoiManager {
+    private constructor();
+    /**
+     * @remarks
+     * Provides access to block-based points of interest in the
+     * dimension.
+     *
+     */
+    readonly blocks: PoiBlockManager;
+}
+
 /**
  * Represents how the potion effect is delivered.
  */
@@ -19530,6 +19867,16 @@ export class PrimitiveShape {
      *
      */
     color: RGBA;
+    /**
+     * @rc
+     * @remarks
+     * Defaults to true. If set to true, we default to being
+     * visible to all players if visibleTo is empty - hiddenFrom
+     * still applies afterwards. If set to false, we default to
+     * hiding the shape from all players if visibleTo is empty.
+     *
+     */
+    defaultVisibleToAll: boolean;
     /**
      * @remarks
      * The dimension the shape is visible within. If the dimension
@@ -19544,6 +19891,15 @@ export class PrimitiveShape {
      *
      */
     readonly hasDuration: boolean;
+    /**
+     * @rc
+     * @remarks
+     * The list of players that this shape will be hidden from. If
+     * a player is listed in both this and visibleTo, this takes
+     * priority (it will be hidden from the player).
+     *
+     */
+    hiddenFrom: Player[];
     /**
      * @remarks
      * The location of the shape.
@@ -24612,7 +24968,35 @@ export interface BlockRaycastOptions extends BlockFilter {
     includePassableBlocks?: boolean;
     /**
      * @remarks
-     * Maximum distance, in blocks, to process the raycast.
+     * Maximum raycast distance, in blocks.
+     *
+     * Bounds: [-2147483648, 2147483647]
+     */
+    maxDistance?: number;
+}
+
+/**
+ * Options for finding blocks.
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface BlockSearchOptions extends BlockFilter {
+    /**
+     * @remarks
+     * When true, includes liquid blocks.
+     *
+     */
+    includeLiquidBlocks?: boolean;
+    /**
+     * @remarks
+     * When true, includes passable blocks, such as vines and
+     * flowers.
+     *
+     */
+    includePassableBlocks?: boolean;
+    /**
+     * @remarks
+     * Maximum search distance, in blocks. Vertical searches use
+     * whole blocks.
      *
      */
     maxDistance?: number;
@@ -25773,8 +26157,9 @@ export interface EntityRaycastOptions extends EntityFilter {
     includePassableBlocks?: boolean;
     /**
      * @remarks
-     * Maximum distance, in blocks, to process the raycast.
+     * Maximum raycast distance, in blocks.
      *
+     * Bounds: [-2147483648, 2147483647]
      */
     maxDistance?: number;
 }
@@ -26423,6 +26808,56 @@ export interface PlayerVisibilityRules extends EntityVisibilityRules {
     showSpectatorToSpectator?: boolean;
 }
 
+/**
+ * @rc
+ * Associates a block point-of-interest instance with its
+ * squared distance from a query center.
+ */
+export interface PoiDistancePair {
+    /**
+     * @remarks
+     * Squared three-dimensional distance, in blocks squared, from
+     * the query center to the POI position.
+     *
+     */
+    distance: number;
+    /**
+     * @remarks
+     * POI instance at this distance.
+     *
+     */
+    poi: PoiBlockInstance;
+}
+
+/**
+ * @rc
+ * Selects block point-of-interest types by their exact
+ * namespaced identifier.
+ */
+export interface PoiNameFilter {
+    /**
+     * @remarks
+     * Exact namespaced POI type identifier to match.
+     *
+     */
+    name: string;
+}
+
+/**
+ * @rc
+ * Selects block point-of-interest types that have all
+ * specified tags.
+ */
+export interface PoiTagFilter {
+    /**
+     * @remarks
+     * Namespaced POI tags that a matching type must contain. All
+     * tags in the array are required.
+     *
+     */
+    tags: string[];
+}
+
 /**
  * Contains optional filters that control which primitive
  * shapes are returned from a primitive shapes query.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server",
-  "version": "2.12.0-rc.1.26.70-preview.20",
+  "version": "2.12.0-rc.1.26.70-preview.21",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "peerDependencies": {
     "@minecraft/common": "^1.2.0",
-    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.70-preview.20"
+    "@minecraft/vanilla-data": ">=1.20.70 || 1.26.70-preview.21"
   },
   "license": "MIT"
 }