@minecraft/server 2.12.0-beta.1.26.60-preview.23 → 2.12.0-beta.1.26.60-preview.28

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 (3) hide show
  1. package/README.md +8 -8
  2. package/index.d.ts +288 -78
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -1,9 +1,9 @@
1
- # `@minecraft/server`
2
-
3
- Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
4
-
5
- ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
6
-
7
- See full documentation for this module here:
8
-
1
+ # `@minecraft/server`
2
+
3
+ Contains many types related to manipulating a Minecraft world, including entities, blocks, dimensions, and more.
4
+
5
+ ## **NOTE: This version of this module is still in pre-release. It may change or it may be removed in future releases.**
6
+
7
+ See full documentation for this module here:
8
+
9
9
  https://learn.microsoft.com/en-us/minecraft/creator/scriptapi/minecraft/server/minecraft-server
package/index.d.ts CHANGED
@@ -47,14 +47,12 @@ export enum AimAssistTargetMode {
47
47
  * function Block.getComponent.
48
48
  */
49
49
  export enum BlockComponentTypes {
50
- /**
51
- * @rc
52
- */
53
50
  DynamicProperties = 'minecraft:dynamic_properties',
54
- FluidContainer = 'minecraft:fluid_container',
55
51
  /**
56
- * @rc
52
+ * @beta
57
53
  */
54
+ EntityStorage = 'minecraft:entity_storage',
55
+ FluidContainer = 'minecraft:fluid_container',
58
56
  Instrument = 'minecraft:instrument_sound',
59
57
  /**
60
58
  * @remarks
@@ -206,7 +204,6 @@ export enum ButtonState {
206
204
  }
207
205
 
208
206
  /**
209
- * @rc
210
207
  * Represents the type of shake to apply to the camera.
211
208
  */
212
209
  export enum CameraShakeType {
@@ -225,7 +222,6 @@ export enum CameraShakeType {
225
222
  }
226
223
 
227
224
  /**
228
- * @rc
229
225
  * An enumeration for the clone modes used when cloning blocks.
230
226
  */
231
227
  export enum CloneMode {
@@ -2257,9 +2253,6 @@ export enum InputPermissionCategory {
2257
2253
  * function ItemStack.getComponent.
2258
2254
  */
2259
2255
  export enum ItemComponentTypes {
2260
- /**
2261
- * @rc
2262
- */
2263
2256
  BlockDynamicProperties = 'minecraft:block_actor_dynamic_properties',
2264
2257
  /**
2265
2258
  * @remarks
@@ -3178,11 +3171,13 @@ export type BlockComponentReturnType<T extends string> = T extends keyof BlockCo
3178
3171
 
3179
3172
  export type BlockComponentTypeMap = {
3180
3173
  dynamic_properties: BlockDynamicPropertiesComponent;
3174
+ entity_storage: BlockEntityStorageComponent;
3181
3175
  fluid_container: BlockFluidContainerComponent;
3182
3176
  instrument_sound: BlockInstrumentComponent;
3183
3177
  inventory: BlockInventoryComponent;
3184
3178
  map_color: BlockMapColorComponent;
3185
3179
  'minecraft:dynamic_properties': BlockDynamicPropertiesComponent;
3180
+ 'minecraft:entity_storage': BlockEntityStorageComponent;
3186
3181
  'minecraft:fluid_container': BlockFluidContainerComponent;
3187
3182
  'minecraft:instrument_sound': BlockInstrumentComponent;
3188
3183
  'minecraft:inventory': BlockInventoryComponent;
@@ -4441,6 +4436,15 @@ export class Block {
4441
4436
  * {@link LocationOutOfWorldBoundariesError}
4442
4437
  */
4443
4438
  hasComponent(componentId: string): boolean;
4439
+ /**
4440
+ * @beta
4441
+ * @throws This function can throw errors.
4442
+ *
4443
+ * {@link LocationInUnloadedChunkError}
4444
+ *
4445
+ * {@link LocationOutOfWorldBoundariesError}
4446
+ */
4447
+ hasScheduledNamedTick(eventName: string): boolean;
4444
4448
  /**
4445
4449
  * @remarks
4446
4450
  * Checks to see if the permutation of this block has a
@@ -4581,6 +4585,47 @@ export class Block {
4581
4585
  * {@link LocationOutOfWorldBoundariesError}
4582
4586
  */
4583
4587
  offset(offset: Vector3): Block | undefined;
4588
+ /**
4589
+ * @beta
4590
+ * @remarks
4591
+ * Removes all scheduled named tick events from this block with
4592
+ * the specified event name.
4593
+ *
4594
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
4595
+ *
4596
+ * @param eventName
4597
+ * Name of the scheduled event to remove.
4598
+ * @throws This function can throw errors.
4599
+ *
4600
+ * {@link LocationInUnloadedChunkError}
4601
+ *
4602
+ * {@link LocationOutOfWorldBoundariesError}
4603
+ */
4604
+ removeScheduledNamedTick(eventName: string): void;
4605
+ /**
4606
+ * @beta
4607
+ * @remarks
4608
+ * Schedules a named tick event for this block. The event will
4609
+ * be delivered to block custom components registered with the
4610
+ * `onNamedTick` callback after the specified delay.
4611
+ *
4612
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
4613
+ *
4614
+ * @param eventName
4615
+ * Name of the event to schedule. Up to 31 characters.
4616
+ * @param tickDelay
4617
+ * Number of ticks to wait before the event is raised. Must be
4618
+ * at least 1.
4619
+ * Minimum value: 1
4620
+ * @throws This function can throw errors.
4621
+ *
4622
+ * {@link Error}
4623
+ *
4624
+ * {@link LocationInUnloadedChunkError}
4625
+ *
4626
+ * {@link LocationOutOfWorldBoundariesError}
4627
+ */
4628
+ scheduleNamedTick(eventName: string, tickDelay: number): void;
4584
4629
  /**
4585
4630
  * @remarks
4586
4631
  * Sets the block in the dimension to the state of the
@@ -4924,6 +4969,30 @@ export class BlockComponentEntityFallOnEvent extends BlockEvent {
4924
4969
  readonly fallDistance: number;
4925
4970
  }
4926
4971
 
4972
+ /**
4973
+ * @beta
4974
+ * Contains information regarding a named tick event for a
4975
+ * specific block.
4976
+ */
4977
+ // @ts-ignore Class inheritance allowed for native defined classes
4978
+ export class BlockComponentNamedTickEvent extends BlockEvent {
4979
+ private constructor();
4980
+ /**
4981
+ * @remarks
4982
+ * Checks whether this named tick event has the specified name.
4983
+ * Events are namespaced with their content UUID. Two named
4984
+ * tick events with the same name but scheduled from different
4985
+ * packs will not respond the same to this method.
4986
+ *
4987
+ * @param eventName
4988
+ * The name to check against this event.
4989
+ * @returns
4990
+ * Returns true if the event name matches the specified name;
4991
+ * otherwise, false.
4992
+ */
4993
+ isName(eventName: string): boolean;
4994
+ }
4995
+
4927
4996
  /**
4928
4997
  * Contains information regarding a specific block that was
4929
4998
  * placed.
@@ -5239,7 +5308,6 @@ export class BlockCustomComponentInstance extends BlockComponent {
5239
5308
  }
5240
5309
 
5241
5310
  /**
5242
- * @rc
5243
5311
  * Represents the dynamic properties of a block in the world.
5244
5312
  * Only available with block entities. Up to 1KB per content
5245
5313
  * pack, per block entity in their dynamic properties storage.
@@ -5342,6 +5410,181 @@ export class BlockDynamicPropertiesComponent extends BlockComponent {
5342
5410
  totalByteCount(): number;
5343
5411
  }
5344
5412
 
5413
+ /**
5414
+ * @beta
5415
+ * Represents storage for entities associated with a block
5416
+ * entity. This component is available on blocks whose behavior
5417
+ * pack definition enables entity storage with the
5418
+ * `minecraft:block_entity` component. Stored entities are
5419
+ * serialized and removed from the world until they are
5420
+ * released or transferred. A block can store up to four
5421
+ * entities. Entity storage is scoped to the content pack
5422
+ * accessing it.
5423
+ */
5424
+ // @ts-ignore Class inheritance allowed for native defined classes
5425
+ export class BlockEntityStorageComponent extends BlockComponent {
5426
+ private constructor();
5427
+ static readonly componentId = 'minecraft:entity_storage';
5428
+ /**
5429
+ * @remarks
5430
+ * Returns information about the entities stored in this
5431
+ * block's entity storage. The returned entities are not
5432
+ * present in the world while they are stored. Only entities
5433
+ * stored by the current content pack are included.
5434
+ *
5435
+ * @returns
5436
+ * An array of {@link BlockEntityStorageInfo} values containing
5437
+ * the unique ID and definition ID of each stored entity.
5438
+ * Returns an empty array when no entities are stored by the
5439
+ * current content pack.
5440
+ * @throws
5441
+ * Throws if the block entity is invalid or the block's
5442
+ * location is not loaded or is outside the world boundaries.
5443
+ *
5444
+ * {@link Error}
5445
+ *
5446
+ * {@link InvalidBlockComponentError}
5447
+ *
5448
+ * {@link LocationInUnloadedChunkError}
5449
+ *
5450
+ * {@link LocationOutOfWorldBoundariesError}
5451
+ */
5452
+ getEntities(): BlockEntityStorageInfo[];
5453
+ /**
5454
+ * @remarks
5455
+ * Releases a stored entity from this block's entity storage
5456
+ * and spawns it back into the world, at the same location it
5457
+ * was when stored.
5458
+ *
5459
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
5460
+ *
5461
+ * @param entityId
5462
+ * The unique ID of the stored entity. Use the value returned
5463
+ * by {@link BlockEntityStorageComponent.store} or the
5464
+ * `uniqueId` property from {@link BlockEntityStorageInfo}.
5465
+ * @returns
5466
+ * The released {@link Entity}. The released entity receives a
5467
+ * new runtime ID.
5468
+ * @throws
5469
+ * Throws if the entity ID is invalid or does not identify an
5470
+ * entity stored by the current content pack, if the stored
5471
+ * entity cannot be loaded or spawned, or if the block entity
5472
+ * is invalid.
5473
+ *
5474
+ * {@link Error}
5475
+ *
5476
+ * {@link InvalidBlockComponentError}
5477
+ *
5478
+ * {@link LocationInUnloadedChunkError}
5479
+ *
5480
+ * {@link LocationOutOfWorldBoundariesError}
5481
+ */
5482
+ release(entityId: string): Entity;
5483
+ /**
5484
+ * @remarks
5485
+ * Returns the number of entities stored in this block's entity
5486
+ * storage by the current content pack.
5487
+ *
5488
+ * @returns
5489
+ * The number of entities stored by the current content pack.
5490
+ * @throws
5491
+ * Throws if the block entity is invalid or the block's
5492
+ * location is not loaded or is outside the world boundaries.
5493
+ *
5494
+ * {@link Error}
5495
+ *
5496
+ * {@link InvalidBlockComponentError}
5497
+ *
5498
+ * {@link LocationInUnloadedChunkError}
5499
+ *
5500
+ * {@link LocationOutOfWorldBoundariesError}
5501
+ */
5502
+ size(): number;
5503
+ /**
5504
+ * @remarks
5505
+ * Serializes and stores an entity in this block's entity
5506
+ * storage. The entity is removed from the world after it is
5507
+ * stored. Only non-player mob entities can be stored. Entities
5508
+ * with passengers or that are passengers cannot be stored.
5509
+ *
5510
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
5511
+ *
5512
+ * @param entity
5513
+ * The {@link Entity} to store.
5514
+ * @returns
5515
+ * The unique ID assigned to the stored entity. Keep this ID to
5516
+ * release, transfer, or inspect the stored entity later.
5517
+ * @throws
5518
+ * Throws if the storage is full, the entity is already stored,
5519
+ * the entity cannot be serialized, or the block entity is
5520
+ * invalid.
5521
+ *
5522
+ * {@link Error}
5523
+ *
5524
+ * {@link InvalidBlockComponentError}
5525
+ *
5526
+ * {@link LocationInUnloadedChunkError}
5527
+ *
5528
+ * {@link LocationOutOfWorldBoundariesError}
5529
+ */
5530
+ store(entity: Entity): string;
5531
+ /**
5532
+ * @remarks
5533
+ * Moves a stored entity from this block's entity storage to
5534
+ * the target block's entity storage without releasing it into
5535
+ * the world.
5536
+ *
5537
+ * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
5538
+ *
5539
+ * @param entityId
5540
+ * The unique ID of the stored entity. Use the value returned
5541
+ * by {@link BlockEntityStorageComponent.store} or the
5542
+ * `uniqueId` property from {@link BlockEntityStorageInfo}.
5543
+ * @param targetBlock
5544
+ * The target {@link Block} with an entity storage component.
5545
+ * The target block must be in the same dimension as this
5546
+ * block.
5547
+ * @throws
5548
+ * Throws if the entity ID is invalid or not stored by the
5549
+ * current content pack, if the target block is invalid, in
5550
+ * another dimension, lacks entity storage, or is full, or if
5551
+ * the source and target blocks are the same.
5552
+ *
5553
+ * {@link Error}
5554
+ *
5555
+ * {@link InvalidBlockComponentError}
5556
+ *
5557
+ * {@link LocationInUnloadedChunkError}
5558
+ *
5559
+ * {@link LocationOutOfWorldBoundariesError}
5560
+ */
5561
+ transfer(entityId: string, targetBlock: Block): void;
5562
+ }
5563
+
5564
+ /**
5565
+ * @beta
5566
+ * Contains identifying information about an entity stored in a
5567
+ * {@link BlockEntityStorageComponent}. Stored entities are not
5568
+ * present in the world until they are released.
5569
+ */
5570
+ export class BlockEntityStorageInfo {
5571
+ private constructor();
5572
+ /**
5573
+ * @remarks
5574
+ * The entity's definition ID, such as `minecraft:pig`.
5575
+ *
5576
+ */
5577
+ readonly definitionId: string;
5578
+ /**
5579
+ * @remarks
5580
+ * The unique ID of the stored entity. Use this ID with
5581
+ * {@link BlockEntityStorageComponent.release} or
5582
+ * {@link BlockEntityStorageComponent.transfer}.
5583
+ *
5584
+ */
5585
+ readonly uniqueId: string;
5586
+ }
5587
+
5345
5588
  /**
5346
5589
  * Contains information regarding an event that impacts a
5347
5590
  * specific block.
@@ -5479,7 +5722,6 @@ export class BlockFluidContainerComponent extends BlockComponent {
5479
5722
  }
5480
5723
 
5481
5724
  /**
5482
- * @rc
5483
5725
  * Represents the instruments a block can have assigned to it's
5484
5726
  * up and down faces.
5485
5727
  */
@@ -6581,7 +6823,6 @@ export class BlockVolumeBase {
6581
6823
  */
6582
6824
  getCapacity(): number;
6583
6825
  /**
6584
- * @rc
6585
6826
  * @remarks
6586
6827
  * Returns a list of block positions within the volume that are
6587
6828
  * closest to a given location, sorted by distance (nearest
@@ -6597,7 +6838,6 @@ export class BlockVolumeBase {
6597
6838
  */
6598
6839
  getClosest(count: number, location: Vector3): Vector3[];
6599
6840
  /**
6600
- * @rc
6601
6841
  * @remarks
6602
6842
  * Returns a list of block positions within the volume that are
6603
6843
  * farthest from a given location, sorted by distance (farthest
@@ -6772,7 +7012,6 @@ export class Camera {
6772
7012
  */
6773
7013
  readonly isValid: boolean;
6774
7014
  /**
6775
- * @rc
6776
7015
  * @remarks
6777
7016
  * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
6778
7017
  *
@@ -6889,7 +7128,6 @@ export class Camera {
6889
7128
  */
6890
7129
  setFov(fovCameraOptions?: CameraFovOptions): void;
6891
7130
  /**
6892
- * @rc
6893
7131
  * @remarks
6894
7132
  * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
6895
7133
  *
@@ -8208,7 +8446,6 @@ export class Dimension {
8208
8446
  options?: BiomeSearchOptions,
8209
8447
  ): Vector3 | undefined;
8210
8448
  /**
8211
- * @rc
8212
8449
  * @remarks
8213
8450
  * Clones a region of blocks from one area of the dimension to
8214
8451
  * another.
@@ -8479,7 +8716,6 @@ export class Dimension {
8479
8716
  */
8480
8717
  getBlockFromRay(location: Vector3, direction: Vector3, options?: BlockRaycastOptions): BlockRaycastHit | undefined;
8481
8718
  /**
8482
- * @rc
8483
8719
  * @remarks
8484
8720
  * Gets all the blocks in a volume that satisfy the block query
8485
8721
  * options.
@@ -12197,7 +12433,7 @@ export class EntityIsStunnedComponent extends EntityComponent {
12197
12433
  export class EntityIsTamedComponent extends EntityComponent {
12198
12434
  private constructor();
12199
12435
  /**
12200
- * @beta
12436
+ * @rc
12201
12437
  * @remarks
12202
12438
  * Returns the player that has tamed the entity, or 'undefined'
12203
12439
  * if the entity has no player owner.
@@ -12208,7 +12444,7 @@ export class EntityIsTamedComponent extends EntityComponent {
12208
12444
  */
12209
12445
  readonly tamedToPlayer?: Player;
12210
12446
  /**
12211
- * @beta
12447
+ * @rc
12212
12448
  * @remarks
12213
12449
  * Returns the id of the player that has tamed the entity, or
12214
12450
  * 'undefined' if the entity has no player owner.
@@ -13665,7 +13901,6 @@ export class EntitySpawnAfterEventSignal {
13665
13901
  }
13666
13902
 
13667
13903
  /**
13668
- * @rc
13669
13904
  * Contains data related to an entity beginning to sneak.
13670
13905
  */
13671
13906
  export class EntityStartSneakingAfterEvent {
@@ -13679,7 +13914,6 @@ export class EntityStartSneakingAfterEvent {
13679
13914
  }
13680
13915
 
13681
13916
  /**
13682
- * @rc
13683
13917
  * Manages callbacks that are connected to when an entity
13684
13918
  * begins sneaking.
13685
13919
  */
@@ -13713,7 +13947,6 @@ export class EntityStartSneakingAfterEventSignal {
13713
13947
  }
13714
13948
 
13715
13949
  /**
13716
- * @rc
13717
13950
  * Contains data related to an entity stopping sneaking.
13718
13951
  */
13719
13952
  export class EntityStopSneakingAfterEvent {
@@ -13727,7 +13960,6 @@ export class EntityStopSneakingAfterEvent {
13727
13960
  }
13728
13961
 
13729
13962
  /**
13730
- * @rc
13731
13963
  * Manages callbacks that are connected to when an entity stops
13732
13964
  * sneaking.
13733
13965
  */
@@ -13848,7 +14080,6 @@ export class EntityTameableComponent extends EntityComponent {
13848
14080
  }
13849
14081
 
13850
14082
  /**
13851
- * @rc
13852
14083
  * Contains data related to an entity being tamed.
13853
14084
  */
13854
14085
  export class EntityTamedAfterEvent {
@@ -13858,7 +14089,6 @@ export class EntityTamedAfterEvent {
13858
14089
  }
13859
14090
 
13860
14091
  /**
13861
- * @rc
13862
14092
  * Manages callbacks that are connected to when an entity is
13863
14093
  * tamed.
13864
14094
  */
@@ -13886,7 +14116,6 @@ export class EntityTamedAfterEventSignal {
13886
14116
  }
13887
14117
 
13888
14118
  /**
13889
- * @rc
13890
14119
  * Contains information regarding an event before an entity is
13891
14120
  * tamed.
13892
14121
  */
@@ -13913,7 +14142,6 @@ export class EntityTamedBeforeEvent {
13913
14142
  }
13914
14143
 
13915
14144
  /**
13916
- * @rc
13917
14145
  * Manages callbacks that are connected to before an entity is
13918
14146
  * tamed.
13919
14147
  */
@@ -14464,7 +14692,6 @@ export class FluidContainer {
14464
14692
  }
14465
14693
 
14466
14694
  /**
14467
- * @rc
14468
14695
  * Provides access to the fog definitions stack of a player
14469
14696
  * entity, allowing scripts to push, pop, remove, and query
14470
14697
  * active fog definitions.
@@ -14946,7 +15173,6 @@ export class ISerializable {
14946
15173
  }
14947
15174
 
14948
15175
  /**
14949
- * @rc
14950
15176
  * Represents the dynamic properties of a block. Only available
14951
15177
  * from block entities. Up to 1KBytes of data can be stored per
14952
15178
  * content pack per block entity in their dynamic properties
@@ -18085,7 +18311,6 @@ export class Player extends Entity {
18085
18311
  */
18086
18312
  commandPermissionLevel: CommandPermissionLevel;
18087
18313
  /**
18088
- * @rc
18089
18314
  * @remarks
18090
18315
  * Contains methods for manipulating the render distance fog
18091
18316
  * settings of a Player.
@@ -20816,7 +21041,7 @@ export class PoiBlockType {
20816
21041
  * @returns
20817
21042
  * True if the POI conatains the tag; otherwise false.
20818
21043
  */
20819
- has(tag: string): boolean;
21044
+ hasTag(tag: string): boolean;
20820
21045
  }
20821
21046
 
20822
21047
  /**
@@ -21059,6 +21284,10 @@ export class PrimitiveShape {
21059
21284
  *
21060
21285
  */
21061
21286
  color: RGBA;
21287
+ /**
21288
+ * @beta
21289
+ */
21290
+ defaultVisibleToAll: boolean;
21062
21291
  /**
21063
21292
  * @remarks
21064
21293
  * The dimension the shape is visible within. If the dimension
@@ -21073,6 +21302,10 @@ export class PrimitiveShape {
21073
21302
  *
21074
21303
  */
21075
21304
  readonly hasDuration: boolean;
21305
+ /**
21306
+ * @beta
21307
+ */
21308
+ hiddenFrom: Player[];
21076
21309
  /**
21077
21310
  * @remarks
21078
21311
  * The location of the shape.
@@ -21168,7 +21401,6 @@ export class PrimitiveShapesManager {
21168
21401
  */
21169
21402
  addText(text: TextPrimitive, dimension?: Dimension): void;
21170
21403
  /**
21171
- * @rc
21172
21404
  * @remarks
21173
21405
  * Fetches and queries all primitive shapes stored in the
21174
21406
  * manager and returns the results as an array of shape
@@ -22561,7 +22793,6 @@ export class SmeltItemFunction extends LootItemFunction {
22561
22793
  }
22562
22794
 
22563
22795
  /**
22564
- * @rc
22565
22796
  * Contains information about a sound thats declared duration
22566
22797
  * elapsed.
22567
22798
  */
@@ -22578,7 +22809,6 @@ export class SoundCompletedAfterEvent {
22578
22809
  }
22579
22810
 
22580
22811
  /**
22581
- * @rc
22582
22812
  * Manages callbacks that are invoked when a tracked sound's
22583
22813
  * declared duration elapses.
22584
22814
  */
@@ -22615,7 +22845,6 @@ export class SoundCompletedAfterEventSignal {
22615
22845
  export class SoundDefinition {
22616
22846
  private constructor();
22617
22847
  /**
22618
- * @rc
22619
22848
  * @remarks
22620
22849
  * Duration metadata declared for this sound. Undefined when
22621
22850
  * the sound definition does not specify a duration.
@@ -22623,7 +22852,6 @@ export class SoundDefinition {
22623
22852
  */
22624
22853
  readonly durationInfo?: SoundDefinitionDurationInfo;
22625
22854
  /**
22626
- * @rc
22627
22855
  * @remarks
22628
22856
  * Music metadata declared for this sound. Undefined when the
22629
22857
  * sound definition does not specify a music_info block.
@@ -22631,7 +22859,6 @@ export class SoundDefinition {
22631
22859
  */
22632
22860
  readonly musicInfo?: SoundDefinitionMusicInfo;
22633
22861
  /**
22634
- * @rc
22635
22862
  * @remarks
22636
22863
  * Identifier of the sound event this definition declares, in
22637
22864
  * the form 'namespace:name'.
@@ -22639,7 +22866,6 @@ export class SoundDefinition {
22639
22866
  */
22640
22867
  readonly soundEventId: string;
22641
22868
  /**
22642
- * @rc
22643
22869
  * @remarks
22644
22870
  * Tag metadata declared for this sound, as a record mapping
22645
22871
  * each tag name to its declared values. A tag declared with a
@@ -22652,7 +22878,6 @@ export class SoundDefinition {
22652
22878
  }
22653
22879
 
22654
22880
  /**
22655
- * @rc
22656
22881
  * Provides read-only access to the sound definitions loaded
22657
22882
  * for the current world.
22658
22883
  */
@@ -22679,7 +22904,6 @@ export class SoundDefinitionRegistry {
22679
22904
  }
22680
22905
 
22681
22906
  /**
22682
- * @rc
22683
22907
  * Provides duration and playback information for a sound whose
22684
22908
  * definition declares a duration.
22685
22909
  */
@@ -22723,28 +22947,24 @@ export class SoundDurationInfo {
22723
22947
  export class SoundInstance {
22724
22948
  private constructor();
22725
22949
  /**
22726
- * @rc
22727
22950
  * @remarks
22728
22951
  * Gets duration and playback information for this sound.
22729
22952
  *
22730
22953
  */
22731
22954
  readonly durationInfo?: SoundDurationInfo;
22732
22955
  /**
22733
- * @rc
22734
22956
  * @remarks
22735
22957
  * Unique identifier of this sound instance.
22736
22958
  *
22737
22959
  */
22738
22960
  readonly id: string;
22739
22961
  /**
22740
- * @rc
22741
22962
  * @remarks
22742
22963
  * Gets the player this sound was played for.
22743
22964
  *
22744
22965
  */
22745
22966
  readonly recipient?: Player;
22746
22967
  /**
22747
- * @rc
22748
22968
  * @remarks
22749
22969
  * Gets the identifier of the sound event this instance was
22750
22970
  * started with.
@@ -22752,12 +22972,13 @@ export class SoundInstance {
22752
22972
  */
22753
22973
  readonly soundEventId: string;
22754
22974
  /**
22755
- * @beta
22975
+ * @rc
22756
22976
  * @remarks
22757
- * Fades this sound instance from its current volume to the
22758
- * target volume over the specified duration. To fade in from
22759
- * silence, call `setVolume(0.0)` first; to fade out, pass a
22760
- * target volume of `0.0`.
22977
+ * Fades this sound instance from its current volume multiplier
22978
+ * to the target multiplier over the specified duration. Volume
22979
+ * multipliers are relative to the selected sound variant's
22980
+ * volume. To fade in from silence, call `setVolume(0.0)`
22981
+ * first; to fade out, pass a target volume of `0.0`.
22761
22982
  *
22762
22983
  * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
22763
22984
  *
@@ -22765,12 +22986,13 @@ export class SoundInstance {
22765
22986
  * Duration of the fade in seconds. Must be non-negative.
22766
22987
  * Minimum value: 0
22767
22988
  * @param targetVolume
22768
- * Volume to fade to. Must be non-negative.
22989
+ * Volume multiplier to fade to, relative to the selected sound
22990
+ * variant's volume. Must be non-negative.
22769
22991
  * Minimum value: 0
22770
22992
  */
22771
22993
  fade(duration: number, targetVolume: number): void;
22772
22994
  /**
22773
- * @beta
22995
+ * @rc
22774
22996
  * @remarks
22775
22997
  * Pauses this sound.
22776
22998
  *
@@ -22779,7 +23001,7 @@ export class SoundInstance {
22779
23001
  */
22780
23002
  pause(): void;
22781
23003
  /**
22782
- * @beta
23004
+ * @rc
22783
23005
  * @remarks
22784
23006
  * Resumes this sound after a pause.
22785
23007
  *
@@ -22788,7 +23010,7 @@ export class SoundInstance {
22788
23010
  */
22789
23011
  resume(): void;
22790
23012
  /**
22791
- * @beta
23013
+ * @rc
22792
23014
  * @remarks
22793
23015
  * Sets the playback position of this sound instance.
22794
23016
  *
@@ -22805,7 +23027,7 @@ export class SoundInstance {
22805
23027
  */
22806
23028
  seekTo(seconds: number): void;
22807
23029
  /**
22808
- * @beta
23030
+ * @rc
22809
23031
  * @remarks
22810
23032
  * Sets the pitch of this sound instance.
22811
23033
  *
@@ -22818,14 +23040,16 @@ export class SoundInstance {
22818
23040
  */
22819
23041
  setPitch(pitch: number): void;
22820
23042
  /**
22821
- * @beta
23043
+ * @rc
22822
23044
  * @remarks
22823
- * Sets the volume of this sound instance.
23045
+ * Sets the volume multiplier of this sound instance relative
23046
+ * to the volume of the selected sound variant.
22824
23047
  *
22825
23048
  * @privilege no-restricted-execution - This function can't be called in restricted-execution mode.
22826
23049
  *
22827
23050
  * @param volume
22828
- * Volume level between 0.0 and 10.0.
23051
+ * Volume multiplier between 0.0 and 10.0. A value of 1.0 uses
23052
+ * the selected sound variant's volume.
22829
23053
  * Bounds: [0, 10]
22830
23054
  */
22831
23055
  setVolume(volume: number): void;
@@ -24359,7 +24583,6 @@ export class World {
24359
24583
  */
24360
24584
  readonly seed: string;
24361
24585
  /**
24362
- * @rc
24363
24586
  * @remarks
24364
24587
  * Provides read-only access to the sound definitions loaded
24365
24588
  * for this world.
@@ -25033,7 +25256,6 @@ export class WorldAfterEvents {
25033
25256
  */
25034
25257
  readonly entitySpawn: EntitySpawnAfterEventSignal;
25035
25258
  /**
25036
- * @rc
25037
25259
  * @remarks
25038
25260
  * This event fires when an entity starts sneaking.
25039
25261
  *
@@ -25042,7 +25264,6 @@ export class WorldAfterEvents {
25042
25264
  */
25043
25265
  readonly entityStartSneaking: EntityStartSneakingAfterEventSignal;
25044
25266
  /**
25045
- * @rc
25046
25267
  * @remarks
25047
25268
  * This event fires when an entity stops sneaking.
25048
25269
  *
@@ -25051,7 +25272,6 @@ export class WorldAfterEvents {
25051
25272
  */
25052
25273
  readonly entityStopSneaking: EntityStopSneakingAfterEventSignal;
25053
25274
  /**
25054
- * @rc
25055
25275
  * @remarks
25056
25276
  * This event fires when an entity is tamed.
25057
25277
  *
@@ -25379,7 +25599,6 @@ export class WorldAfterEvents {
25379
25599
  */
25380
25600
  readonly projectileHitEntity: ProjectileHitEntityAfterEventSignal;
25381
25601
  /**
25382
- * @rc
25383
25602
  * @remarks
25384
25603
  * A tracked sound's declared duration elapsed.
25385
25604
  *
@@ -25546,7 +25765,6 @@ export class WorldBeforeEvents {
25546
25765
  */
25547
25766
  readonly entityRemove: EntityRemoveBeforeEventSignal;
25548
25767
  /**
25549
- * @rc
25550
25768
  * @remarks
25551
25769
  * Fires before an entity is tamed.
25552
25770
  *
@@ -26246,6 +26464,10 @@ export interface BlockCustomComponent {
26246
26464
  *
26247
26465
  */
26248
26466
  onEntityFallOn?: (arg0: BlockComponentEntityFallOnEvent, arg1: CustomComponentParameters) => void;
26467
+ /**
26468
+ * @beta
26469
+ */
26470
+ onNamedTick?: (arg0: BlockComponentNamedTickEvent, arg1: CustomComponentParameters) => void;
26249
26471
  /**
26250
26472
  * @remarks
26251
26473
  * This function will be called when the block that this custom
@@ -26419,7 +26641,6 @@ export interface BlockHitInformation {
26419
26641
  }
26420
26642
 
26421
26643
  /**
26422
- * @rc
26423
26644
  * Options for querying blocks in a volume. Extends BlockFilter
26424
26645
  * with additional sorting and limiting options based on
26425
26646
  * distance from a location.
@@ -26623,7 +26844,6 @@ export interface CameraSetRotOptions {
26623
26844
  }
26624
26845
 
26625
26846
  /**
26626
- * @rc
26627
26847
  * Options for applying a camera shake effect to a player's
26628
26848
  * camera via `Camera.addShake`. Each call to `addShake` queues
26629
26849
  * a new independent shake event for the specified `type`;
@@ -27685,7 +27905,6 @@ export interface EntityRaycastOptions extends EntityFilter {
27685
27905
  }
27686
27906
 
27687
27907
  /**
27688
- * @rc
27689
27908
  * Options used to filter entity start sneaking and stop
27690
27909
  * sneaking events.
27691
27910
  */
@@ -27694,7 +27913,6 @@ export interface EntitySneakingChangedEventOptions {
27694
27913
  }
27695
27914
 
27696
27915
  /**
27697
- * @rc
27698
27916
  * Contains options for filtering entity tamed events.
27699
27917
  */
27700
27918
  export interface EntityTamedEventOptions {
@@ -28272,7 +28490,7 @@ export interface PlayerSoundOptions {
28272
28490
  */
28273
28491
  location?: Vector3;
28274
28492
  /**
28275
- * @beta
28493
+ * @rc
28276
28494
  * @remarks
28277
28495
  * Number of additional times to repeat the sound after the
28278
28496
  * initial play. `0` (the default) plays the sound once, `-1`
@@ -28406,7 +28624,6 @@ export interface PoiTagFilter {
28406
28624
  }
28407
28625
 
28408
28626
  /**
28409
- * @rc
28410
28627
  * Contains optional filters that control which primitive
28411
28628
  * shapes are returned from a primitive shapes query.
28412
28629
  */
@@ -28764,7 +28981,6 @@ export interface ScriptEventMessageFilterOptions {
28764
28981
  }
28765
28982
 
28766
28983
  /**
28767
- * @rc
28768
28984
  * Duration metadata declared in a sound definition.
28769
28985
  */
28770
28986
  export interface SoundDefinitionDurationInfo {
@@ -28778,7 +28994,6 @@ export interface SoundDefinitionDurationInfo {
28778
28994
  }
28779
28995
 
28780
28996
  /**
28781
- * @rc
28782
28997
  * Criteria used to narrow a set of sound definitions. Each
28783
28998
  * field is optional and applies its constraint only when
28784
28999
  * defined; a definition must satisfy every defined field to
@@ -28857,7 +29072,6 @@ export interface SoundDefinitionFilter {
28857
29072
  }
28858
29073
 
28859
29074
  /**
28860
- * @rc
28861
29075
  * Music metadata declared on a sound definition. Each field is
28862
29076
  * optional and is undefined when the sound definition does not
28863
29077
  * declare a value for it.
@@ -29407,12 +29621,9 @@ export interface WorldClockTimeMarkerEventOptions {
29407
29621
  * Contains additional options for a playSound occurrence.
29408
29622
  */
29409
29623
  export interface WorldSoundOptions {
29410
- /**
29411
- * @rc
29412
- */
29413
29624
  isBroadcast?: boolean;
29414
29625
  /**
29415
- * @beta
29626
+ * @rc
29416
29627
  * @remarks
29417
29628
  * Number of additional times to repeat the sound after the
29418
29629
  * initial play. `0` (the default) plays the sound once, `-1`
@@ -29614,7 +29825,6 @@ export class EntitySpawnError extends Error {
29614
29825
  }
29615
29826
 
29616
29827
  /**
29617
- * @rc
29618
29828
  * Error thrown by {@link FogSettings} operations when the fog
29619
29829
  * stack limit is exceeded or an invalid fog identifier is
29620
29830
  * provided.
package/package.json CHANGED
@@ -1,20 +1,20 @@
1
- {
2
- "name": "@minecraft/server",
3
- "version": "2.12.0-beta.1.26.60-preview.23",
4
- "description": "",
5
- "contributors": [
6
- {
7
- "name": "Jake Shirley",
8
- "email": "jake@xbox.com"
9
- },
10
- {
11
- "name": "Mike Ammerlaan",
12
- "email": "mikeam@microsoft.com"
13
- }
14
- ],
15
- "peerDependencies": {
16
- "@minecraft/common": "^1.2.0",
17
- "@minecraft/vanilla-data": ">=1.20.70 || 1.26.60-preview.23"
18
- },
19
- "license": "MIT"
1
+ {
2
+ "name": "@minecraft/server",
3
+ "version": "2.12.0-beta.1.26.60-preview.28",
4
+ "description": "",
5
+ "contributors": [
6
+ {
7
+ "name": "Jake Shirley",
8
+ "email": "jake@xbox.com"
9
+ },
10
+ {
11
+ "name": "Mike Ammerlaan",
12
+ "email": "mikeam@microsoft.com"
13
+ }
14
+ ],
15
+ "peerDependencies": {
16
+ "@minecraft/common": "^1.2.0",
17
+ "@minecraft/vanilla-data": ">=1.20.70 || 1.26.60-preview.28"
18
+ },
19
+ "license": "MIT"
20
20
  }