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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +445 -56
  2. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  // Type definitions for Minecraft Bedrock Edition script APIs
2
- // Project: https://docs.microsoft.com/minecraft/creator/
2
+ // Project: https://learn.microsoft.com/minecraft/creator/
3
3
  // Definitions by: Jake Shirley <https://github.com/JakeShirley>
4
- // Mike Ammerlaan <https://github.com/mammerla>
4
+ // Raphael Landaverde <https://github.com/rlandav>
5
5
 
6
6
  /* *****************************************************************************
7
7
  Copyright (c) Microsoft Corporation.
@@ -2105,6 +2105,13 @@ export enum InputMode {
2105
2105
  *
2106
2106
  */
2107
2107
  Gamepad = 'Gamepad',
2108
+ /**
2109
+ * @rc
2110
+ * @remarks
2111
+ * Gamepad and mouse input.
2112
+ *
2113
+ */
2114
+ GamepadAndMouse = 'GamepadAndMouse',
2108
2115
  /**
2109
2116
  * @remarks
2110
2117
  * Keyboard and mouse input.
@@ -2214,7 +2221,7 @@ export enum InputPermissionCategory {
2214
2221
  * function ItemStack.getComponent.
2215
2222
  */
2216
2223
  export enum ItemComponentTypes {
2217
- BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
2224
+ BlockDynamicProperties = 'minecraft:block_dynamic_properties',
2218
2225
  /**
2219
2226
  * @remarks
2220
2227
  * The minecraft:book component.
@@ -2686,6 +2693,34 @@ export enum PlayerSplitScreenSlot {
2686
2693
  Third = 'Third',
2687
2694
  }
2688
2695
 
2696
+ /**
2697
+ * @rc
2698
+ * Specifies how a block point-of-interest query filters
2699
+ * instances by ticket occupancy.
2700
+ */
2701
+ export enum PoiBlockOccupancyFilter {
2702
+ /**
2703
+ * @remarks
2704
+ * Includes POI instances regardless of their occupancy or
2705
+ * available ticket count.
2706
+ *
2707
+ */
2708
+ Any = 'Any',
2709
+ /**
2710
+ * @remarks
2711
+ * Includes POI instances with no available tickets.
2712
+ *
2713
+ */
2714
+ Full = 'Full',
2715
+ /**
2716
+ * @remarks
2717
+ * Includes POI instances with at least one ticket available to
2718
+ * be claimed.
2719
+ *
2720
+ */
2721
+ HasVacancy = 'HasVacancy',
2722
+ }
2723
+
2689
2724
  /**
2690
2725
  * Contains objectives and participants for the scoreboard.
2691
2726
  */
@@ -3254,7 +3289,7 @@ export type ItemComponentReturnType<T extends string> = T extends keyof ItemComp
3254
3289
  : ItemCustomComponentInstance;
3255
3290
 
3256
3291
  export type ItemComponentTypeMap = {
3257
- block_actor_dynamic_properties: ItemBlockDynamicPropertiesComponent;
3292
+ block_dynamic_properties: ItemBlockDynamicPropertiesComponent;
3258
3293
  book: ItemBookComponent;
3259
3294
  compostable: ItemCompostableComponent;
3260
3295
  cooldown: ItemCooldownComponent;
@@ -3263,7 +3298,7 @@ export type ItemComponentTypeMap = {
3263
3298
  enchantable: ItemEnchantableComponent;
3264
3299
  food: ItemFoodComponent;
3265
3300
  inventory: ItemInventoryComponent;
3266
- 'minecraft:block_actor_dynamic_properties': ItemBlockDynamicPropertiesComponent;
3301
+ 'minecraft:block_dynamic_properties': ItemBlockDynamicPropertiesComponent;
3267
3302
  'minecraft:book': ItemBookComponent;
3268
3303
  'minecraft:compostable': ItemCompostableComponent;
3269
3304
  'minecraft:cooldown': ItemCooldownComponent;
@@ -7544,6 +7579,15 @@ export class Dimension {
7544
7579
  *
7545
7580
  */
7546
7581
  readonly localizationKey: string;
7582
+ /**
7583
+ * @rc
7584
+ * @remarks
7585
+ * Provides access to point-of-interest (POI) managers for this
7586
+ * dimension. This property is available only when the POI
7587
+ * experiment is enabled.
7588
+ *
7589
+ */
7590
+ readonly poiManager: PoiManager;
7547
7591
  /**
7548
7592
  * @remarks
7549
7593
  * Calculates the location of the closest biome of a particular
@@ -7817,7 +7861,7 @@ export class Dimension {
7817
7861
  * The options to decide if a block is a valid result.
7818
7862
  * @throws This function can throw errors.
7819
7863
  */
7820
- getBlockAbove(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
7864
+ getBlockAbove(location: Vector3, options?: BlockSearchOptions): Block | undefined;
7821
7865
  /**
7822
7866
  * @remarks
7823
7867
  * Gets the first block found below a given block location
@@ -7830,7 +7874,7 @@ export class Dimension {
7830
7874
  * The options to decide if a block is a valid result.
7831
7875
  * @throws This function can throw errors.
7832
7876
  */
7833
- getBlockBelow(location: Vector3, options?: BlockRaycastOptions): Block | undefined;
7877
+ getBlockBelow(location: Vector3, options?: BlockSearchOptions): Block | undefined;
7834
7878
  /**
7835
7879
  * @remarks
7836
7880
  * Gets the first block that intersects with a vector emanating
@@ -8386,7 +8430,6 @@ export class Dimension {
8386
8430
  */
8387
8431
  spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
8388
8432
  /**
8389
- * @rc
8390
8433
  * @remarks
8391
8434
  * Spawns an experience orb at a specified location in the
8392
8435
  * dimension.
@@ -11473,7 +11516,6 @@ export class EntityIsStunnedComponent extends EntityComponent {
11473
11516
  export class EntityIsTamedComponent extends EntityComponent {
11474
11517
  private constructor();
11475
11518
  /**
11476
- * @rc
11477
11519
  * @remarks
11478
11520
  * Returns the player that has tamed the entity, or 'undefined'
11479
11521
  * if the entity has no player owner.
@@ -11484,7 +11526,6 @@ export class EntityIsTamedComponent extends EntityComponent {
11484
11526
  */
11485
11527
  readonly tamedToPlayer?: Player;
11486
11528
  /**
11487
- * @rc
11488
11529
  * @remarks
11489
11530
  * Returns the id of the player that has tamed the entity, or
11490
11531
  * 'undefined' if the entity has no player owner.
@@ -14178,7 +14219,7 @@ export class ISerializable {
14178
14219
  // @ts-ignore Class inheritance allowed for native defined classes
14179
14220
  export class ItemBlockDynamicPropertiesComponent extends ItemComponent {
14180
14221
  private constructor();
14181
- static readonly componentId = 'minecraft:block_actor_dynamic_properties';
14222
+ static readonly componentId = 'minecraft:block_dynamic_properties';
14182
14223
  /**
14183
14224
  * @remarks
14184
14225
  * Returns a DynamicProperty that was stored with the provided
@@ -19310,6 +19351,299 @@ export class PlayerWaypoint extends EntityWaypoint {
19310
19351
  );
19311
19352
  }
19312
19353
 
19354
+ /**
19355
+ * @rc
19356
+ * Describes a block point-of-interest instance returned by a
19357
+ * query.
19358
+ */
19359
+ export class PoiBlockInstance {
19360
+ private constructor();
19361
+ /**
19362
+ * @remarks
19363
+ * Block position of this POI instance.
19364
+ *
19365
+ */
19366
+ readonly position: Vector3;
19367
+ /**
19368
+ * @remarks
19369
+ * Number of tickets currently available to be claimed from
19370
+ * this POI instance.
19371
+ *
19372
+ */
19373
+ readonly tickets: number;
19374
+ /**
19375
+ * @remarks
19376
+ * Type of this POI instance.
19377
+ *
19378
+ */
19379
+ readonly 'type': PoiBlockType;
19380
+ }
19381
+
19382
+ /**
19383
+ * @rc
19384
+ * Provides methods for querying and managing block-based
19385
+ * points of interest in a dimension.
19386
+ */
19387
+ export class PoiBlockManager {
19388
+ private constructor();
19389
+ /**
19390
+ * @remarks
19391
+ * Adds a block point of interest at a position. This method is
19392
+ * intended for temporary usage. Will be replaced when chunk is
19393
+ * reloaded
19394
+ *
19395
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19396
+ *
19397
+ * @param position
19398
+ * Block position at which to add the POI.
19399
+ * @param poi
19400
+ * POI type to add, specified by numeric type Id, type name, or
19401
+ * POI type object.
19402
+ */
19403
+ addTemporary(position: Vector3, poi: PoiBlockType | string | number): void;
19404
+ /**
19405
+ * @remarks
19406
+ * Gets the type of the block point of interest at a position.
19407
+ *
19408
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19409
+ *
19410
+ * @param position
19411
+ * Block position to inspect.
19412
+ * @returns
19413
+ * The POI type at the position, or undefined if no POI exists
19414
+ * there.
19415
+ */
19416
+ at(position: Vector3): PoiBlockType | undefined;
19417
+ /**
19418
+ * @remarks
19419
+ * Tests whether a block point of interest at a position
19420
+ * matches a type filter.
19421
+ *
19422
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19423
+ *
19424
+ * @param position
19425
+ * Block position to inspect.
19426
+ * @param filter
19427
+ * Filter used to select the POI type. A callback receives the
19428
+ * POI type and returns whether it matches; a name filter
19429
+ * matches a type name; and a tag filter requires all specified
19430
+ * tags.
19431
+ * @returns
19432
+ * True if a POI exists at the position and its type matches
19433
+ * the filter; otherwise false.
19434
+ */
19435
+ exists(position: Vector3, filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter): boolean;
19436
+ /**
19437
+ * @remarks
19438
+ * Returns block points of interest that match the supplied
19439
+ * type and occupancy filters within the specified distance of
19440
+ * a location.
19441
+ *
19442
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19443
+ *
19444
+ * @param filter
19445
+ * Filter used to select POI types. A callback receives each
19446
+ * POI type and returns whether it should be included; a name
19447
+ * filter matches a type name; and a tag filter requires all
19448
+ * specified tags.
19449
+ * @param center
19450
+ * Center of the search.
19451
+ * @param blockRadius
19452
+ * Maximum three-dimensional distance from the center, in
19453
+ * blocks.
19454
+ * @param occupancyFilter
19455
+ * Optional filter applied to the occupancy state of matching
19456
+ * POIs. If omitted, POIs in any occupancy state are returned.
19457
+ * @returns
19458
+ * The matching POI instances within range. The result order is
19459
+ * not guaranteed.
19460
+ */
19461
+ getInRange(
19462
+ filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
19463
+ center: Vector3,
19464
+ blockRadius: number,
19465
+ occupancyFilter?: PoiBlockOccupancyFilter,
19466
+ ): PoiBlockInstance[];
19467
+ /**
19468
+ * @remarks
19469
+ * Returns block points of interest that match the supplied
19470
+ * type and occupancy filters within an axis-aligned square
19471
+ * centered on the specified location, sorted from nearest to
19472
+ * farthest.
19473
+ *
19474
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19475
+ *
19476
+ * @param filter
19477
+ * Filter used to select POI types. A callback receives each
19478
+ * POI type and returns whether it should be included; a name
19479
+ * filter matches a type name; and a tag filter requires all
19480
+ * specified tags.
19481
+ * @param center
19482
+ * Center of the search and the location from which distances
19483
+ * are calculated.
19484
+ * @param blockRadius
19485
+ * Maximum three-dimensional distance from the center, in
19486
+ * blocks.
19487
+ * @param occupancyFilter
19488
+ * Optional filter applied to the occupancy state of matching
19489
+ * POIs. If omitted, POIs in any occupancy state are returned.
19490
+ * @returns
19491
+ * The matching POI instances and their squared distances from
19492
+ * the center, sorted in ascending distance order.
19493
+ */
19494
+ getInRangeSorted(
19495
+ filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
19496
+ center: Vector3,
19497
+ blockRadius: number,
19498
+ occupancyFilter?: PoiBlockOccupancyFilter,
19499
+ ): PoiDistancePair[];
19500
+ /**
19501
+ * @remarks
19502
+ * Returns block points of interest that match the supplied
19503
+ * type and occupancy filters within an axis-aligned square
19504
+ * centered on the specified location.
19505
+ *
19506
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19507
+ *
19508
+ * @param filter
19509
+ * Filter used to select POI types. A callback receives each
19510
+ * POI type and returns whether it should be included; a name
19511
+ * filter matches a type name; and a tag filter requires all
19512
+ * specified tags.
19513
+ * @param center
19514
+ * Center of the search volume.
19515
+ * @param blockRadius
19516
+ * Half-size of the search volume, in blocks, along each axis.
19517
+ * @param occupancyFilter
19518
+ * Optional filter applied to the occupancy state of matching
19519
+ * POIs. If omitted, POIs in any occupancy state are returned.
19520
+ * @returns
19521
+ * The matching POI instances in the search volume.
19522
+ */
19523
+ getInSquare(
19524
+ filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
19525
+ center: Vector3,
19526
+ blockRadius: number,
19527
+ occupancyFilter?: PoiBlockOccupancyFilter,
19528
+ ): PoiBlockInstance[];
19529
+ /**
19530
+ * @remarks
19531
+ * Releases one previously claimed ticket at a block point of
19532
+ * interest.
19533
+ *
19534
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19535
+ *
19536
+ * @param center
19537
+ * Block position of the POI whose ticket should be released.
19538
+ * @returns
19539
+ * True if a ticket was released; false if no POI exists at the
19540
+ * position or the POI has no claimed tickets.
19541
+ */
19542
+ release(center: Vector3): boolean;
19543
+ /**
19544
+ * @remarks
19545
+ * Claims one available ticket from a matching block point of
19546
+ * interest within range.
19547
+ *
19548
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19549
+ *
19550
+ * @param filter
19551
+ * Filter used to select the POI type to claim. A callback
19552
+ * receives each POI type and returns whether it should be
19553
+ * included; a name filter matches a type name; and a tag
19554
+ * filter requires all specified tags.
19555
+ * @param center
19556
+ * Center of the search.
19557
+ * @param blockRadius
19558
+ * Maximum three-dimensional distance from the center, in
19559
+ * blocks.
19560
+ * @returns
19561
+ * The block position of the claimed POI, or undefined if no
19562
+ * matching POI has an available ticket.
19563
+ */
19564
+ take(
19565
+ filter: ((arg0: PoiBlockType) => boolean) | PoiNameFilter | PoiTagFilter,
19566
+ center: Vector3,
19567
+ blockRadius: number,
19568
+ ): Vector3 | undefined;
19569
+ }
19570
+
19571
+ /**
19572
+ * @rc
19573
+ * Describes a block point-of-interest type.
19574
+ */
19575
+ export class PoiBlockType {
19576
+ private constructor();
19577
+ /**
19578
+ * @remarks
19579
+ * Numeric identifier of this POI type.
19580
+ *
19581
+ */
19582
+ readonly id: number;
19583
+ /**
19584
+ * @remarks
19585
+ * Namespaced identifier of this POI type.
19586
+ *
19587
+ */
19588
+ readonly name: string;
19589
+ /**
19590
+ * @remarks
19591
+ * Maximum number of tickets that can be claimed from each POI
19592
+ * instance of this type.
19593
+ *
19594
+ */
19595
+ readonly tickets: number;
19596
+ /**
19597
+ * @remarks
19598
+ * Maximum range, in blocks, at which this POI type is
19599
+ * considered usable.
19600
+ *
19601
+ */
19602
+ readonly usableRange: number;
19603
+ /**
19604
+ * @remarks
19605
+ * Tests whether this object and another object describe the
19606
+ * same POI type.
19607
+ *
19608
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19609
+ *
19610
+ * @param other
19611
+ * POI type to compare with this type.
19612
+ * @returns
19613
+ * True if both objects describe the same POI type; otherwise
19614
+ * false.
19615
+ */
19616
+ equals(other: PoiBlockType): boolean;
19617
+ /**
19618
+ * @remarks
19619
+ * Tests whether the type has the provided tag attribute
19620
+ *
19621
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
19622
+ *
19623
+ * @param tag
19624
+ * POI tag to check.
19625
+ * @returns
19626
+ * True if the POI conatains the tag; otherwise false.
19627
+ */
19628
+ hasTag(tag: string): boolean;
19629
+ }
19630
+
19631
+ /**
19632
+ * @rc
19633
+ * Provides access to point-of-interest (POI) data in a
19634
+ * dimension.
19635
+ */
19636
+ export class PoiManager {
19637
+ private constructor();
19638
+ /**
19639
+ * @remarks
19640
+ * Provides access to block-based points of interest in the
19641
+ * dimension.
19642
+ *
19643
+ */
19644
+ readonly blocks: PoiBlockManager;
19645
+ }
19646
+
19313
19647
  /**
19314
19648
  * Represents how the potion effect is delivered.
19315
19649
  */
@@ -19530,6 +19864,16 @@ export class PrimitiveShape {
19530
19864
  *
19531
19865
  */
19532
19866
  color: RGBA;
19867
+ /**
19868
+ * @rc
19869
+ * @remarks
19870
+ * Defaults to true. If set to true, we default to being
19871
+ * visible to all players if visibleTo is empty - hiddenFrom
19872
+ * still applies afterwards. If set to false, we default to
19873
+ * hiding the shape from all players if visibleTo is empty.
19874
+ *
19875
+ */
19876
+ defaultVisibleToAll: boolean;
19533
19877
  /**
19534
19878
  * @remarks
19535
19879
  * The dimension the shape is visible within. If the dimension
@@ -19544,6 +19888,15 @@ export class PrimitiveShape {
19544
19888
  *
19545
19889
  */
19546
19890
  readonly hasDuration: boolean;
19891
+ /**
19892
+ * @rc
19893
+ * @remarks
19894
+ * The list of players that this shape will be hidden from. If
19895
+ * a player is listed in both this and visibleTo, this takes
19896
+ * priority (it will be hidden from the player).
19897
+ *
19898
+ */
19899
+ hiddenFrom: Player[];
19547
19900
  /**
19548
19901
  * @remarks
19549
19902
  * The location of the shape.
@@ -21065,7 +21418,6 @@ export class SoundInstance {
21065
21418
  */
21066
21419
  readonly soundEventId: string;
21067
21420
  /**
21068
- * @rc
21069
21421
  * @remarks
21070
21422
  * Fades this sound instance from its current volume multiplier
21071
21423
  * to the target multiplier over the specified duration. Volume
@@ -21085,7 +21437,6 @@ export class SoundInstance {
21085
21437
  */
21086
21438
  fade(duration: number, targetVolume: number): void;
21087
21439
  /**
21088
- * @rc
21089
21440
  * @remarks
21090
21441
  * Pauses this sound.
21091
21442
  *
@@ -21094,7 +21445,6 @@ export class SoundInstance {
21094
21445
  */
21095
21446
  pause(): void;
21096
21447
  /**
21097
- * @rc
21098
21448
  * @remarks
21099
21449
  * Resumes this sound after a pause.
21100
21450
  *
@@ -21103,7 +21453,6 @@ export class SoundInstance {
21103
21453
  */
21104
21454
  resume(): void;
21105
21455
  /**
21106
- * @rc
21107
21456
  * @remarks
21108
21457
  * Sets the playback position of this sound instance.
21109
21458
  *
@@ -21120,7 +21469,6 @@ export class SoundInstance {
21120
21469
  */
21121
21470
  seekTo(seconds: number): void;
21122
21471
  /**
21123
- * @rc
21124
21472
  * @remarks
21125
21473
  * Sets the pitch of this sound instance.
21126
21474
  *
@@ -21133,7 +21481,6 @@ export class SoundInstance {
21133
21481
  */
21134
21482
  setPitch(pitch: number): void;
21135
21483
  /**
21136
- * @rc
21137
21484
  * @remarks
21138
21485
  * Sets the volume multiplier of this sound instance relative
21139
21486
  * to the volume of the selected sound variant.
@@ -21219,7 +21566,6 @@ export class StartupEvent {
21219
21566
  */
21220
21567
  readonly itemComponentRegistry: ItemComponentRegistry;
21221
21568
  /**
21222
- * @rc
21223
21569
  * @remarks
21224
21570
  * @privilege early-execution-readable - This property can be read in early-execution mode.
21225
21571
  *
@@ -21985,7 +22331,6 @@ export class TextPrimitive extends PrimitiveShape {
21985
22331
  */
21986
22332
  depthTest: boolean;
21987
22333
  /**
21988
- * @rc
21989
22334
  * @remarks
21990
22335
  * This value determines the gap between lines for the
21991
22336
  * TextPrimitive. By default the line gap height is 0.
@@ -22133,7 +22478,6 @@ export class TickingAreaManager {
22133
22478
  }
22134
22479
 
22135
22480
  /**
22136
- * @rc
22137
22481
  * A named point in time on a world clock that can occur once
22138
22482
  * or periodically.
22139
22483
  */
@@ -22640,7 +22984,6 @@ export class World {
22640
22984
  */
22641
22985
  getAllPlayers(): Player[];
22642
22986
  /**
22643
- * @rc
22644
22987
  * @remarks
22645
22988
  * Retrieves a world clock by its name.
22646
22989
  *
@@ -23576,7 +23919,6 @@ export class WorldAfterEvents {
23576
23919
  */
23577
23920
  readonly weatherChange: WeatherChangeAfterEventSignal;
23578
23921
  /**
23579
- * @rc
23580
23922
  * @remarks
23581
23923
  * This event fires when a {@link WorldClock} is paused.
23582
23924
  *
@@ -23585,7 +23927,6 @@ export class WorldAfterEvents {
23585
23927
  */
23586
23928
  readonly worldClockOnPaused: WorldClockOnPausedAfterEventSignal;
23587
23929
  /**
23588
- * @rc
23589
23930
  * @remarks
23590
23931
  * This event fires when a {@link WorldClock} is resumed.
23591
23932
  *
@@ -23594,7 +23935,6 @@ export class WorldAfterEvents {
23594
23935
  */
23595
23936
  readonly worldClockOnResumed: WorldClockOnResumedAfterEventSignal;
23596
23937
  /**
23597
- * @rc
23598
23938
  * @remarks
23599
23939
  * This event fires when the time of a {@link WorldClock} hits
23600
23940
  * a {@link TimeMarker} on the clock. This can happen during a
@@ -23605,7 +23945,6 @@ export class WorldAfterEvents {
23605
23945
  */
23606
23946
  readonly worldClockOnTimeMarker: WorldClockOnTimeMarkerAfterEventSignal;
23607
23947
  /**
23608
- * @rc
23609
23948
  * @remarks
23610
23949
  * This event fires when a {@link WorldClock} time is changed.
23611
23950
  * This can happen when the time is directly set through
@@ -23741,7 +24080,6 @@ export class WorldBeforeEvents {
23741
24080
  */
23742
24081
  readonly weatherChange: WeatherChangeBeforeEventSignal;
23743
24082
  /**
23744
- * @rc
23745
24083
  * @remarks
23746
24084
  * This event fires when a {@link WorldClock} reaches its
23747
24085
  * maximum time and is about to restart.
@@ -23753,7 +24091,6 @@ export class WorldBeforeEvents {
23753
24091
  }
23754
24092
 
23755
24093
  /**
23756
- * @rc
23757
24094
  * A class that represents a particular clock within a world.
23758
24095
  */
23759
24096
  export class WorldClock {
@@ -23880,7 +24217,6 @@ export class WorldClock {
23880
24217
  }
23881
24218
 
23882
24219
  /**
23883
- * @rc
23884
24220
  * Contains information related to a {@link WorldClock} being
23885
24221
  * paused.
23886
24222
  */
@@ -23895,7 +24231,6 @@ export class WorldClockOnPausedAfterEvent {
23895
24231
  }
23896
24232
 
23897
24233
  /**
23898
- * @rc
23899
24234
  * Manages callbacks that are connected to a {@link WorldClock}
23900
24235
  * being paused.
23901
24236
  */
@@ -23929,7 +24264,6 @@ export class WorldClockOnPausedAfterEventSignal {
23929
24264
  }
23930
24265
 
23931
24266
  /**
23932
- * @rc
23933
24267
  * Contains information related to a {@link WorldClock}
23934
24268
  * restarting.
23935
24269
  */
@@ -23960,7 +24294,6 @@ export class WorldClockOnRestartBeforeEvent {
23960
24294
  }
23961
24295
 
23962
24296
  /**
23963
- * @rc
23964
24297
  * Manages callbacks that are connected to a {@link WorldClock}
23965
24298
  * restarting.
23966
24299
  */
@@ -24000,7 +24333,6 @@ export class WorldClockOnRestartBeforeEventSignal {
24000
24333
  }
24001
24334
 
24002
24335
  /**
24003
- * @rc
24004
24336
  * Contains information related to a {@link WorldClock} being
24005
24337
  * resumed.
24006
24338
  */
@@ -24015,7 +24347,6 @@ export class WorldClockOnResumedAfterEvent {
24015
24347
  }
24016
24348
 
24017
24349
  /**
24018
- * @rc
24019
24350
  * Manages callbacks that are connected to a {@link WorldClock}
24020
24351
  * being resumed.
24021
24352
  */
@@ -24049,7 +24380,6 @@ export class WorldClockOnResumedAfterEventSignal {
24049
24380
  }
24050
24381
 
24051
24382
  /**
24052
- * @rc
24053
24383
  * Contains information related to when the time of a
24054
24384
  * {@link WorldClock} hits a {@link TimeMarker}.
24055
24385
  */
@@ -24070,7 +24400,6 @@ export class WorldClockOnTimeMarkerAfterEvent {
24070
24400
  }
24071
24401
 
24072
24402
  /**
24073
- * @rc
24074
24403
  * Manages callbacks that are connected to when the time of a
24075
24404
  * {@link WorldClock} hits a {@link TimeMarker}.
24076
24405
  */
@@ -24104,7 +24433,6 @@ export class WorldClockOnTimeMarkerAfterEventSignal {
24104
24433
  }
24105
24434
 
24106
24435
  /**
24107
- * @rc
24108
24436
  * Contains information related to changes to the time of a
24109
24437
  * {@link WorldClock}.
24110
24438
  */
@@ -24119,7 +24447,6 @@ export class WorldClockOnTimeModifiedAfterEvent {
24119
24447
  }
24120
24448
 
24121
24449
  /**
24122
- * @rc
24123
24450
  * Manages callbacks that are connected to changes to the time
24124
24451
  * of a {@link WorldClock}.
24125
24452
  */
@@ -24153,7 +24480,6 @@ export class WorldClockOnTimeModifiedAfterEventSignal {
24153
24480
  }
24154
24481
 
24155
24482
  /**
24156
- * @rc
24157
24483
  * Provides the functionality for registering custom world
24158
24484
  * clocks. World clocks can only be registered during the
24159
24485
  * system startup event.
@@ -24612,7 +24938,35 @@ export interface BlockRaycastOptions extends BlockFilter {
24612
24938
  includePassableBlocks?: boolean;
24613
24939
  /**
24614
24940
  * @remarks
24615
- * Maximum distance, in blocks, to process the raycast.
24941
+ * Maximum raycast distance, in blocks.
24942
+ *
24943
+ * Bounds: [-2147483648, 2147483647]
24944
+ */
24945
+ maxDistance?: number;
24946
+ }
24947
+
24948
+ /**
24949
+ * Options for finding blocks.
24950
+ */
24951
+ // @ts-ignore Class inheritance allowed for native defined classes
24952
+ export interface BlockSearchOptions extends BlockFilter {
24953
+ /**
24954
+ * @remarks
24955
+ * When true, includes liquid blocks.
24956
+ *
24957
+ */
24958
+ includeLiquidBlocks?: boolean;
24959
+ /**
24960
+ * @remarks
24961
+ * When true, includes passable blocks, such as vines and
24962
+ * flowers.
24963
+ *
24964
+ */
24965
+ includePassableBlocks?: boolean;
24966
+ /**
24967
+ * @remarks
24968
+ * Maximum search distance, in blocks. Vertical searches use
24969
+ * whole blocks.
24616
24970
  *
24617
24971
  */
24618
24972
  maxDistance?: number;
@@ -25773,8 +26127,9 @@ export interface EntityRaycastOptions extends EntityFilter {
25773
26127
  includePassableBlocks?: boolean;
25774
26128
  /**
25775
26129
  * @remarks
25776
- * Maximum distance, in blocks, to process the raycast.
26130
+ * Maximum raycast distance, in blocks.
25777
26131
  *
26132
+ * Bounds: [-2147483648, 2147483647]
25778
26133
  */
25779
26134
  maxDistance?: number;
25780
26135
  }
@@ -26340,7 +26695,6 @@ export interface PlayerSoundOptions {
26340
26695
  */
26341
26696
  location?: Vector3;
26342
26697
  /**
26343
- * @rc
26344
26698
  * @remarks
26345
26699
  * Number of additional times to repeat the sound after the
26346
26700
  * initial play. `0` (the default) plays the sound once, `-1`
@@ -26423,6 +26777,56 @@ export interface PlayerVisibilityRules extends EntityVisibilityRules {
26423
26777
  showSpectatorToSpectator?: boolean;
26424
26778
  }
26425
26779
 
26780
+ /**
26781
+ * @rc
26782
+ * Associates a block point-of-interest instance with its
26783
+ * squared distance from a query center.
26784
+ */
26785
+ export interface PoiDistancePair {
26786
+ /**
26787
+ * @remarks
26788
+ * Squared three-dimensional distance, in blocks squared, from
26789
+ * the query center to the POI position.
26790
+ *
26791
+ */
26792
+ distance: number;
26793
+ /**
26794
+ * @remarks
26795
+ * POI instance at this distance.
26796
+ *
26797
+ */
26798
+ poi: PoiBlockInstance;
26799
+ }
26800
+
26801
+ /**
26802
+ * @rc
26803
+ * Selects block point-of-interest types by their exact
26804
+ * namespaced identifier.
26805
+ */
26806
+ export interface PoiNameFilter {
26807
+ /**
26808
+ * @remarks
26809
+ * Exact namespaced POI type identifier to match.
26810
+ *
26811
+ */
26812
+ name: string;
26813
+ }
26814
+
26815
+ /**
26816
+ * @rc
26817
+ * Selects block point-of-interest types that have all
26818
+ * specified tags.
26819
+ */
26820
+ export interface PoiTagFilter {
26821
+ /**
26822
+ * @remarks
26823
+ * Namespaced POI tags that a matching type must contain. All
26824
+ * tags in the array are required.
26825
+ *
26826
+ */
26827
+ tags: string[];
26828
+ }
26829
+
26426
26830
  /**
26427
26831
  * Contains optional filters that control which primitive
26428
26832
  * shapes are returned from a primitive shapes query.
@@ -27199,7 +27603,6 @@ export interface TickingAreaOptions {
27199
27603
  }
27200
27604
 
27201
27605
  /**
27202
- * @rc
27203
27606
  * Options for creating time markers for world clocks.
27204
27607
  */
27205
27608
  export interface TimeMarkerOptions {
@@ -27367,7 +27770,6 @@ export interface WaypointTextureSelector {
27367
27770
  }
27368
27771
 
27369
27772
  /**
27370
- * @rc
27371
27773
  * Contains parameters for world clock events that filters out
27372
27774
  * which events are passed to the provided callback.
27373
27775
  */
@@ -27381,7 +27783,6 @@ export interface WorldClockEventOptions {
27381
27783
  }
27382
27784
 
27383
27785
  /**
27384
- * @rc
27385
27786
  * Contains additional options for registering world clocks.
27386
27787
  */
27387
27788
  export interface WorldClockRegistrationOptions {
@@ -27395,7 +27796,6 @@ export interface WorldClockRegistrationOptions {
27395
27796
  }
27396
27797
 
27397
27798
  /**
27398
- * @rc
27399
27799
  * Contains parameters for world clock time marker events that
27400
27800
  * filters out which events are passed to the provided
27401
27801
  * callback.
@@ -27423,7 +27823,6 @@ export interface WorldClockTimeMarkerEventOptions {
27423
27823
  export interface WorldSoundOptions {
27424
27824
  isBroadcast?: boolean;
27425
27825
  /**
27426
- * @rc
27427
27826
  * @remarks
27428
27827
  * Number of additional times to repeat the sound after the
27429
27828
  * initial play. `0` (the default) plays the sound once, `-1`
@@ -27883,7 +28282,6 @@ export class UnloadedChunksError extends Error {
27883
28282
  }
27884
28283
 
27885
28284
  /**
27886
- * @rc
27887
28285
  * Error thrown by {@link WorldClock.addTimeMarker} when
27888
28286
  * failing to add a time marker to a world clock.
27889
28287
  */
@@ -27893,7 +28291,6 @@ export class WorldClockAddTimeMarkerError extends Error {
27893
28291
  }
27894
28292
 
27895
28293
  /**
27896
- * @rc
27897
28294
  * Thrown when trying to register a world clock outside of the
27898
28295
  * system startup event.
27899
28296
  */
@@ -27903,7 +28300,6 @@ export class WorldClockInvalidRegistryError extends Error {
27903
28300
  }
27904
28301
 
27905
28302
  /**
27906
- * @rc
27907
28303
  * Error thrown when a time marker is invalid. This can occur
27908
28304
  * when trying to access data on a time marker that has been
27909
28305
  * removed.
@@ -27914,7 +28310,6 @@ export class WorldClockInvalidTimeMarkerError extends Error {
27914
28310
  }
27915
28311
 
27916
28312
  /**
27917
- * @rc
27918
28313
  * Error thrown when a world clock is not found in the world
27919
28314
  * clock registry.
27920
28315
  */
@@ -27924,7 +28319,6 @@ export class WorldClockNotFoundError extends Error {
27924
28319
  }
27925
28320
 
27926
28321
  /**
27927
- * @rc
27928
28322
  * Error thrown by {@link WorldClockRegistry.registerClock}
27929
28323
  * when failing to register a world clock.
27930
28324
  */
@@ -27934,7 +28328,6 @@ export class WorldClockRegistrationError extends Error {
27934
28328
  }
27935
28329
 
27936
28330
  /**
27937
- * @rc
27938
28331
  * Thrown after using the /reload command when trying to
27939
28332
  * register a world clock that was not previously registered.
27940
28333
  * New world clocks cannot be added during a reload.
@@ -27945,7 +28338,6 @@ export class WorldClockReloadNewWorldClockError extends Error {
27945
28338
  }
27946
28339
 
27947
28340
  /**
27948
- * @rc
27949
28341
  * Error thrown after using the /reload command when trying to
27950
28342
  * re-register an existing world clock with an invalid time
27951
28343
  * marker.
@@ -27956,7 +28348,6 @@ export class WorldClockReloadTimeMarkerError extends Error {
27956
28348
  }
27957
28349
 
27958
28350
  /**
27959
- * @rc
27960
28351
  * Error thrown by {@link WorldClock.removeTimeMarker} when
27961
28352
  * trying to remove a time marker with the 'minecraft'
27962
28353
  * namespace from a world clock.
@@ -27967,7 +28358,6 @@ export class WorldClockRemoveMinecraftTimeMarkerError extends Error {
27967
28358
  }
27968
28359
 
27969
28360
  /**
27970
- * @rc
27971
28361
  * Error thrown by {@link WorldClock.rewindTo} when the world
27972
28362
  * clock's time is already before the time marker's first
27973
28363
  * occurrence.
@@ -27978,7 +28368,6 @@ export class WorldClockRewindError extends Error {
27978
28368
  }
27979
28369
 
27980
28370
  /**
27981
- * @rc
27982
28371
  * Error thrown when performing actions on a world clock with a
27983
28372
  * time marker that does not exist.
27984
28373
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server",
3
- "version": "2.12.0-rc.1.26.70-preview.20",
3
+ "version": "2.12.0-rc.1.26.70-preview.22",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {
@@ -14,7 +14,7 @@
14
14
  ],
15
15
  "peerDependencies": {
16
16
  "@minecraft/common": "^1.2.0",
17
- "@minecraft/vanilla-data": ">=1.20.70 || 1.26.70-preview.20"
17
+ "@minecraft/vanilla-data": ">=1.20.70 || 1.26.70-preview.22"
18
18
  },
19
19
  "license": "MIT"
20
20
  }