@minecraft/server 1.1.0-beta.1.19.60-preview.23 → 1.1.0-beta.1.19.60-preview.25

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 +389 -21
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -7,6 +7,7 @@
7
7
  Copyright (c) Microsoft Corporation.
8
8
  ***************************************************************************** */
9
9
  /**
10
+ * @beta
10
11
  * @packageDocumentation
11
12
  * Contains many types related to manipulating a Minecraft
12
13
  * world, including entities, blocks, dimensions, and more.
@@ -15,63 +16,74 @@
15
16
  * ```json
16
17
  * {
17
18
  * "module_name": "@minecraft/server",
18
- * "version": "1.1.0-internal.1.19.60-preview.23"
19
+ * "version": "1.1.0-internal.1.19.60-preview.25"
19
20
  * }
20
21
  * ```
21
22
  *
22
23
  */
23
24
  /**
25
+ * @beta
24
26
  * Represents a direction for expressing relative position or
25
27
  * facing.
26
28
  */
27
29
  export enum Direction {
28
30
  /**
31
+ * @beta
29
32
  * Represents an object located or facing in the down (z - 1)
30
33
  * direction.
31
34
  */
32
35
  down = 'down',
33
36
  /**
37
+ * @beta
34
38
  * Represents an object located or facing in the east (x + 1)
35
39
  * direction.
36
40
  */
37
41
  east = 'east',
38
42
  /**
43
+ * @beta
39
44
  * Represents an object located or facing in the north (z - 1)
40
45
  * direction.
41
46
  */
42
47
  north = 'north',
43
48
  /**
49
+ * @beta
44
50
  * Represents an object located or facing in the south (z + 1)
45
51
  * direction.
46
52
  */
47
53
  south = 'south',
48
54
  /**
55
+ * @beta
49
56
  * Represents an object located or facing in the up (z + 1)
50
57
  * direction.
51
58
  */
52
59
  up = 'up',
53
60
  /**
61
+ * @beta
54
62
  * Represents an object located or facing in the west (x - 1)
55
63
  * direction.
56
64
  */
57
65
  west = 'west',
58
66
  }
59
67
  /**
68
+ * @beta
60
69
  * An enumeration for the locations where scoreboard objectives
61
70
  * can be displayed.
62
71
  */
63
72
  export enum DisplaySlotId {
64
73
  /**
74
+ * @beta
65
75
  * Score for an objective is displayed below a player's
66
76
  * nametag.
67
77
  */
68
78
  belowname = 'belowname',
69
79
  /**
80
+ * @beta
70
81
  * This objective and respective list of players is shown on
71
82
  * the Pause menu.
72
83
  */
73
84
  list = 'list',
74
85
  /**
86
+ * @beta
75
87
  * The objective is shown on the right-hand side of the screen.
76
88
  */
77
89
  sidebar = 'sidebar',
@@ -110,37 +122,45 @@ export enum EntityDamageCause {
110
122
  wither = 'wither',
111
123
  }
112
124
  /**
125
+ * @beta
113
126
  * Represents the type of fluid for use within a fluid
114
127
  * containing block, like a cauldron.
115
128
  */
116
129
  export enum FluidType {
117
130
  /**
131
+ * @beta
118
132
  * Represents lava as a type of fluid.
119
133
  */
120
134
  lava = 'lava',
121
135
  /**
136
+ * @beta
122
137
  * Represents a potion as a type of fluid.
123
138
  */
124
139
  potion = 'potion',
125
140
  /**
141
+ * @beta
126
142
  * Represents powder snow as a type of fluid.
127
143
  */
128
144
  powderSnow = 'powderSnow',
129
145
  /**
146
+ * @beta
130
147
  * Represents water as a type of fluida.
131
148
  */
132
149
  water = 'water',
133
150
  }
134
151
  /**
152
+ * @beta
135
153
  * Represents a game mode for the current world experience.
136
154
  */
137
155
  export enum GameMode {
138
156
  /**
157
+ * @beta
139
158
  * World is in a more locked-down experience, where blocks may
140
159
  * not be manipulated.
141
160
  */
142
161
  adventure = 'adventure',
143
162
  /**
163
+ * @beta
144
164
  * World is in a full creative mode. In creative mode, the
145
165
  * player has all the resources available in the item selection
146
166
  * tabs and the survival selection tab. They can also destroy
@@ -152,6 +172,7 @@ export enum GameMode {
152
172
  creative = 'creative',
153
173
  spectator = 'spectator',
154
174
  /**
175
+ * @beta
155
176
  * World is in a survival mode, where players can take damage
156
177
  * and entities may not be peaceful. Survival mode is where the
157
178
  * player must collect resources, build structures while
@@ -169,36 +190,43 @@ export enum MessageSourceType {
169
190
  serverScript = 'serverScript',
170
191
  }
171
192
  /**
193
+ * @beta
172
194
  * Used for specifying a sort order for how to display an
173
195
  * objective and its list of participants.
174
196
  */
175
197
  export enum ObjectiveSortOrder {
176
198
  /**
199
+ * @beta
177
200
  * Objective participant list is displayed in ascending (e.g.,
178
201
  * A-Z) order.
179
202
  */
180
203
  ascending = 0,
181
204
  /**
205
+ * @beta
182
206
  * Objective participant list is displayed in descending (e.g.,
183
207
  * Z-A) order.
184
208
  */
185
209
  descending = 1,
186
210
  }
187
211
  /**
212
+ * @beta
188
213
  * Contains objectives and participants for the scoreboard.
189
214
  */
190
215
  export enum ScoreboardIdentityType {
191
216
  /**
217
+ * @beta
192
218
  * This scoreboard participant is tied to an entity.
193
219
  */
194
220
  entity = 'entity',
195
221
  /**
222
+ * @beta
196
223
  * This scoreboard participant is tied to a pseudo player
197
224
  * entity - typically this is used to store scores as data or
198
225
  * as abstract progress.
199
226
  */
200
227
  fakePlayer = 'fakePlayer',
201
228
  /**
229
+ * @beta
202
230
  * This scoreboard participant is tied to a player.
203
231
  */
204
232
  player = 'player',
@@ -212,16 +240,19 @@ export enum TimeOfDay {
212
240
  Sunrise = 23000,
213
241
  }
214
242
  /**
243
+ * @beta
215
244
  * An enumeration with the reason that a watchdog is deciding
216
245
  * to terminate execution of a behavior packs' script.
217
246
  */
218
247
  export enum WatchdogTerminateReason {
219
248
  /**
249
+ * @beta
220
250
  * Script runtime for a behavior pack is terminated due to
221
251
  * non-responsiveness from script (a hang or infinite loop).
222
252
  */
223
253
  hang = 'hang',
224
254
  /**
255
+ * @beta
225
256
  * Script runtime for a behavior pack is terminated due to a
226
257
  * stack overflow (a long, and potentially infinite) chain of
227
258
  * function calls.
@@ -229,6 +260,7 @@ export enum WatchdogTerminateReason {
229
260
  stackOverflow = 'stackOverflow',
230
261
  }
231
262
  /**
263
+ * @beta
232
264
  * An event that fires as players enter chat messages.
233
265
  */
234
266
  export class BeforeChatEvent {
@@ -259,6 +291,7 @@ export class BeforeChatEvent {
259
291
  targets: Player[];
260
292
  }
261
293
  /**
294
+ * @beta
262
295
  * Manages callbacks that are connected to an event that fires
263
296
  * before chat messages are sent.
264
297
  */
@@ -281,6 +314,7 @@ export class BeforeChatEventSignal {
281
314
  unsubscribe(callback: (arg: BeforeChatEvent) => void): void;
282
315
  }
283
316
  /**
317
+ * @beta
284
318
  * Contains information related to firing of a data driven
285
319
  * entity event - for example, the minecraft:ageable_grow_up
286
320
  * event on a chicken.
@@ -306,6 +340,7 @@ export class BeforeDataDrivenEntityTriggerEvent {
306
340
  modifiers: DefinitionModifier[];
307
341
  }
308
342
  /**
343
+ * @beta
309
344
  * Contains information related to firing of a data driven
310
345
  * entity event - for example, the minecraft:ageable_grow_up
311
346
  * event on a chicken.
@@ -333,6 +368,7 @@ export class BeforeDataDrivenEntityTriggerEventSignal {
333
368
  unsubscribe(callback: (arg: BeforeDataDrivenEntityTriggerEvent) => void): void;
334
369
  }
335
370
  /**
371
+ * @beta
336
372
  * Contains information regarding an explosion that has
337
373
  * happened.
338
374
  */
@@ -358,6 +394,7 @@ export class BeforeExplosionEvent {
358
394
  readonly source: Entity;
359
395
  }
360
396
  /**
397
+ * @beta
361
398
  * Manages callbacks that are connected to before an explosion
362
399
  * occurs.
363
400
  */
@@ -381,6 +418,7 @@ export class BeforeExplosionEventSignal {
381
418
  unsubscribe(callback: (arg: BeforeExplosionEvent) => void): void;
382
419
  }
383
420
  /**
421
+ * @beta
384
422
  * Manages callbacks that are connected to an item's definition
385
423
  * and components changing.
386
424
  */
@@ -405,6 +443,7 @@ export class BeforeItemDefinitionEventSignal {
405
443
  unsubscribe(callback: (arg: BeforeItemDefinitionTriggeredEvent) => void): void;
406
444
  }
407
445
  /**
446
+ * @beta
408
447
  * Contains information related to a triggering of a custom
409
448
  * item definition change.
410
449
  */
@@ -430,6 +469,7 @@ export class BeforeItemDefinitionTriggeredEvent {
430
469
  readonly source: Entity;
431
470
  }
432
471
  /**
472
+ * @beta
433
473
  * Contains information related to an item being used.
434
474
  */
435
475
  export class BeforeItemUseEvent {
@@ -448,6 +488,7 @@ export class BeforeItemUseEvent {
448
488
  readonly source: Entity;
449
489
  }
450
490
  /**
491
+ * @beta
451
492
  * Manages callbacks that fire before an item is used.
452
493
  */
453
494
  export class BeforeItemUseEventSignal {
@@ -467,6 +508,7 @@ export class BeforeItemUseEventSignal {
467
508
  unsubscribe(callback: (arg: BeforeItemUseEvent) => void): void;
468
509
  }
469
510
  /**
511
+ * @beta
470
512
  * Contains information related to an item being used on a
471
513
  * block.
472
514
  */
@@ -504,6 +546,7 @@ export class BeforeItemUseOnEvent {
504
546
  readonly source: Entity;
505
547
  }
506
548
  /**
549
+ * @beta
507
550
  * Manages callbacks that fire before an item being used on a
508
551
  * block event.
509
552
  */
@@ -526,6 +569,7 @@ export class BeforeItemUseOnEventSignal {
526
569
  unsubscribe(callback: (arg: BeforeItemUseOnEvent) => void): void;
527
570
  }
528
571
  /**
572
+ * @beta
529
573
  * Contains information related to changes before a piston
530
574
  * expands or retracts.
531
575
  */
@@ -555,6 +599,7 @@ export class BeforePistonActivateEvent extends BlockEvent {
555
599
  readonly piston: BlockPistonComponent;
556
600
  }
557
601
  /**
602
+ * @beta
558
603
  * Manages callbacks that are connected to an event that fires
559
604
  * before a piston is activated.
560
605
  */
@@ -577,6 +622,7 @@ export class BeforePistonActivateEventSignal {
577
622
  unsubscribe(callback: (arg: BeforePistonActivateEvent) => void): void;
578
623
  }
579
624
  /**
625
+ * @beta
580
626
  * Contains information related to a script watchdog
581
627
  * termination.
582
628
  */
@@ -596,6 +642,7 @@ export class BeforeWatchdogTerminateEvent {
596
642
  readonly terminateReason: WatchdogTerminateReason;
597
643
  }
598
644
  /**
645
+ * @beta
599
646
  * Manages callbacks that are connected to a callback that will
600
647
  * be called when a script runtime is being terminated due to a
601
648
  * violation of the performance watchdog system.
@@ -621,6 +668,7 @@ export class BeforeWatchdogTerminateEventSignal {
621
668
  unsubscribe(callback: (arg: BeforeWatchdogTerminateEvent) => void): void;
622
669
  }
623
670
  /**
671
+ * @beta
624
672
  * Represents a block in a dimension. A block represents a
625
673
  * unique X, Y, and Z within a dimension and get/sets the state
626
674
  * of the block at that location. This type was significantly
@@ -706,7 +754,7 @@ export class Block {
706
754
  * this block.
707
755
  * @throws This function can throw errors.
708
756
  */
709
- getRedstonePower(): number;
757
+ getRedstonePower(): number | undefined;
710
758
  /**
711
759
  * @remarks
712
760
  * Returns a set of tags for a block.
@@ -773,6 +821,7 @@ export class Block {
773
821
  trySetPermutation(permutation: BlockPermutation): boolean;
774
822
  }
775
823
  /**
824
+ * @beta
776
825
  * Holds information for expressing the net size of a volume of
777
826
  * blocks.
778
827
  */
@@ -806,6 +855,7 @@ export class BlockAreaSize {
806
855
  equals(other: BlockAreaSize): boolean;
807
856
  }
808
857
  /**
858
+ * @beta
809
859
  * Contains information regarding an event where a player
810
860
  * breaks a block.
811
861
  */
@@ -835,6 +885,7 @@ export class BlockBreakEvent extends BlockEvent {
835
885
  readonly player: Player;
836
886
  }
837
887
  /**
888
+ * @beta
838
889
  * Manages callbacks that are connected to when a block is
839
890
  * broken.
840
891
  */
@@ -857,6 +908,7 @@ export class BlockBreakEventSignal {
857
908
  unsubscribe(callback: (arg: BlockBreakEvent) => void): void;
858
909
  }
859
910
  /**
911
+ * @beta
860
912
  * Base type for components associated with blocks.
861
913
  */
862
914
  // tslint:disable-next-line:no-unnecessary-class
@@ -864,6 +916,7 @@ export class BlockComponent {
864
916
  protected constructor();
865
917
  }
866
918
  /**
919
+ * @beta
867
920
  * Contains information regarding an event that impacts a
868
921
  * specific block.
869
922
  */
@@ -880,6 +933,7 @@ export class BlockEvent {
880
933
  readonly dimension: Dimension;
881
934
  }
882
935
  /**
936
+ * @beta
883
937
  * Contains information regarding an explosion that has
884
938
  * occurred for a specific block.
885
939
  */
@@ -900,6 +954,7 @@ export class BlockExplodeEvent extends BlockEvent {
900
954
  readonly source: Entity;
901
955
  }
902
956
  /**
957
+ * @beta
903
958
  * Manages callbacks that are connected to when an explosion
904
959
  * occurs, as it impacts individual blocks.
905
960
  */
@@ -922,6 +977,7 @@ export class BlockExplodeEventSignal {
922
977
  unsubscribe(callback: (arg: BlockExplodeEvent) => void): void;
923
978
  }
924
979
  /**
980
+ * @beta
925
981
  * Contains more information for events where a block is hit.
926
982
  */
927
983
  export class BlockHitInformation {
@@ -944,6 +1000,7 @@ export class BlockHitInformation {
944
1000
  readonly faceLocationY: number;
945
1001
  }
946
1002
  /**
1003
+ * @beta
947
1004
  * Represents the inventory of a block in the world. Used with
948
1005
  * blocks like chests.
949
1006
  */
@@ -970,6 +1027,7 @@ export class BlockInventoryComponent extends BlockComponent {
970
1027
  static readonly componentId = 'minecraft:inventory';
971
1028
  }
972
1029
  /**
1030
+ * @beta
973
1031
  * Represents the inventory of a {@link Block} in the world.
974
1032
  * Used with blocks like chests.
975
1033
  */
@@ -1082,6 +1140,7 @@ export class BlockInventoryComponentContainer extends Container {
1082
1140
  transferItem(fromSlot: number, toSlot: number, toContainer: Container): boolean;
1083
1141
  }
1084
1142
  /**
1143
+ * @beta
1085
1144
  * Represents a fluid container block that currently contains
1086
1145
  * lava.
1087
1146
  */
@@ -1109,6 +1168,7 @@ export class BlockLavaContainerComponent extends BlockComponent {
1109
1168
  static readonly componentId = 'minecraft:lavaContainer';
1110
1169
  }
1111
1170
  /**
1171
+ * @beta
1112
1172
  * Contains the integer X, Y, Z coordinates for a block. For
1113
1173
  * decimal locations useful for entities, items, and more, see
1114
1174
  * {@link Location}.
@@ -1187,6 +1247,7 @@ export class BlockLocation {
1187
1247
  offset(x: number, y: number, z: number): BlockLocation;
1188
1248
  }
1189
1249
  /**
1250
+ * @beta
1190
1251
  * Contains the combination of type {@link BlockType} and
1191
1252
  * properties (also sometimes called block state) which
1192
1253
  * describe a block (but does not belong to a specific {@link
@@ -1250,6 +1311,7 @@ export class BlockPermutation {
1250
1311
  hasTag(tag: string): boolean;
1251
1312
  }
1252
1313
  /**
1314
+ * @beta
1253
1315
  * When present, this block has piston-like behavior. Contains
1254
1316
  * additional properties for discovering block piston state.
1255
1317
  */
@@ -1301,6 +1363,7 @@ export class BlockPistonComponent extends BlockComponent {
1301
1363
  static readonly componentId = 'minecraft:piston';
1302
1364
  }
1303
1365
  /**
1366
+ * @beta
1304
1367
  * Contains information regarding an event where a player
1305
1368
  * places a block.
1306
1369
  */
@@ -1321,6 +1384,7 @@ export class BlockPlaceEvent extends BlockEvent {
1321
1384
  readonly player: Player;
1322
1385
  }
1323
1386
  /**
1387
+ * @beta
1324
1388
  * Manages callbacks that are connected to when a block is
1325
1389
  * placed.
1326
1390
  */
@@ -1343,6 +1407,7 @@ export class BlockPlaceEventSignal {
1343
1407
  unsubscribe(callback: (arg: BlockPlaceEvent) => void): void;
1344
1408
  }
1345
1409
  /**
1410
+ * @beta
1346
1411
  * Represents a fluid container block that currently contains a
1347
1412
  * potion.
1348
1413
  */
@@ -1379,6 +1444,7 @@ export class BlockPotionContainerComponent extends BlockComponent {
1379
1444
  setPotionType(item: ItemStack): void;
1380
1445
  }
1381
1446
  /**
1447
+ * @beta
1382
1448
  * Returns an enumeration of available block properties.
1383
1449
  */
1384
1450
  // tslint:disable-next-line:no-unnecessary-class
@@ -1983,6 +2049,7 @@ export class BlockProperties {
1983
2049
  static readonly woodType = 'wood_type';
1984
2050
  }
1985
2051
  /**
2052
+ * @beta
1986
2053
  * Represents a block that can play a record.
1987
2054
  */
1988
2055
  export class BlockRecordPlayerComponent extends BlockComponent {
@@ -2024,6 +2091,7 @@ export class BlockRecordPlayerComponent extends BlockComponent {
2024
2091
  setRecord(recordItemType: ItemType): void;
2025
2092
  }
2026
2093
  /**
2094
+ * @beta
2027
2095
  * Represents a block that can display text on it.
2028
2096
  */
2029
2097
  export class BlockSignComponent extends BlockComponent {
@@ -2049,6 +2117,7 @@ export class BlockSignComponent extends BlockComponent {
2049
2117
  static readonly componentId = 'minecraft:sign';
2050
2118
  }
2051
2119
  /**
2120
+ * @beta
2052
2121
  * Represents a fluid container block that currently contains
2053
2122
  * snow.
2054
2123
  */
@@ -2076,6 +2145,7 @@ export class BlockSnowContainerComponent extends BlockComponent {
2076
2145
  static readonly componentId = 'minecraft:snowContainer';
2077
2146
  }
2078
2147
  /**
2148
+ * @beta
2079
2149
  * The type (or template) of a block. Does not contain
2080
2150
  * permutation data (state) other than the type of block it
2081
2151
  * represents. This type was introduced as of version
@@ -2102,6 +2172,7 @@ export class BlockType {
2102
2172
  createDefaultBlockPermutation(): BlockPermutation;
2103
2173
  }
2104
2174
  /**
2175
+ * @beta
2105
2176
  * Represents a fluid container block that currently contains
2106
2177
  * water.
2107
2178
  */
@@ -2140,6 +2211,7 @@ export class BlockWaterContainerComponent extends BlockComponent {
2140
2211
  addDye(itemType: ItemType): void;
2141
2212
  }
2142
2213
  /**
2214
+ * @beta
2143
2215
  * Contains the state of a boolean-based property for a {@link
2144
2216
  * BlockPermutation}.
2145
2217
  */
@@ -2163,6 +2235,7 @@ export class BoolBlockProperty extends IBlockProperty {
2163
2235
  value: boolean;
2164
2236
  }
2165
2237
  /**
2238
+ * @beta
2166
2239
  * Contains information related to changes to a button push.
2167
2240
  */
2168
2241
  export class ButtonPushEvent extends BlockEvent {
@@ -2182,6 +2255,7 @@ export class ButtonPushEvent extends BlockEvent {
2182
2255
  readonly source: Entity;
2183
2256
  }
2184
2257
  /**
2258
+ * @beta
2185
2259
  * Manages callbacks that are connected to when a button is
2186
2260
  * pushed.
2187
2261
  */
@@ -2203,6 +2277,7 @@ export class ButtonPushEventSignal {
2203
2277
  unsubscribe(callback: (arg: ButtonPushEvent) => void): void;
2204
2278
  }
2205
2279
  /**
2280
+ * @beta
2206
2281
  * An event that fires as players enter chat messages.
2207
2282
  */
2208
2283
  export class ChatEvent {
@@ -2228,6 +2303,7 @@ export class ChatEvent {
2228
2303
  targets: Player[];
2229
2304
  }
2230
2305
  /**
2306
+ * @beta
2231
2307
  * Manages callbacks that are connected to chat messages being
2232
2308
  * sent.
2233
2309
  */
@@ -2263,6 +2339,7 @@ export class ChatEventSignal {
2263
2339
  unsubscribe(callback: (arg: ChatEvent) => void): void;
2264
2340
  }
2265
2341
  /**
2342
+ * @beta
2266
2343
  * Represents a fully customizable color within Minecraft.
2267
2344
  */
2268
2345
  export class Color {
@@ -2309,6 +2386,7 @@ export class CommandResult {
2309
2386
  readonly successCount: number;
2310
2387
  }
2311
2388
  /**
2389
+ * @beta
2312
2390
  * Represents a container that can hold sets of items. Used
2313
2391
  * with entities such as Players, Chest Minecarts, Llamas, and
2314
2392
  * more.
@@ -2426,6 +2504,7 @@ export class Container {
2426
2504
  transferItem(fromSlot: number, toSlot: number, toContainer: Container): boolean;
2427
2505
  }
2428
2506
  /**
2507
+ * @beta
2429
2508
  * Represents a slot within a broader container (e.g., entity
2430
2509
  * inventory.)
2431
2510
  */
@@ -2473,7 +2552,7 @@ export class ContainerSlot {
2473
2552
  * container slot.
2474
2553
  * @throws This function can throw errors.
2475
2554
  */
2476
- getLore(): string[];
2555
+ getLore(): string[] | undefined;
2477
2556
  /**
2478
2557
  * @remarks
2479
2558
  * Sets the item within the slot to a new value.
@@ -2492,6 +2571,7 @@ export class ContainerSlot {
2492
2571
  setLore(loreList: string[]): void;
2493
2572
  }
2494
2573
  /**
2574
+ * @beta
2495
2575
  * Contains information related to firing of a data driven
2496
2576
  * entity event - for example, the minecraft:ageable_grow_up
2497
2577
  * event on a chicken.
@@ -2513,6 +2593,7 @@ export class DataDrivenEntityTriggerEvent {
2513
2593
  readonly modifiers: DefinitionModifier[];
2514
2594
  }
2515
2595
  /**
2596
+ * @beta
2516
2597
  * Contains event registration related to firing of a data
2517
2598
  * driven entity event - for example, the
2518
2599
  * minecraft:ageable_grow_up event on a chicken.
@@ -2540,6 +2621,7 @@ export class DataDrivenEntityTriggerEventSignal {
2540
2621
  unsubscribe(callback: (arg: DataDrivenEntityTriggerEvent) => void): void;
2541
2622
  }
2542
2623
  /**
2624
+ * @beta
2543
2625
  * Contains a set of updates to the component definition state
2544
2626
  * of an entity.
2545
2627
  */
@@ -2572,6 +2654,7 @@ export class Dimension {
2572
2654
  */
2573
2655
  readonly id: string;
2574
2656
  /**
2657
+ * @beta
2575
2658
  * @remarks
2576
2659
  * Creates an explosion at the specified location.
2577
2660
  * @param location
@@ -2621,7 +2704,14 @@ export class Dimension {
2621
2704
  * ```
2622
2705
  */
2623
2706
  createExplosion(location: Location, radius: number, explosionOptions?: ExplosionOptions): void;
2707
+ fillBlocks(
2708
+ begin: BlockLocation,
2709
+ end: BlockLocation,
2710
+ block: BlockPermutation | BlockType,
2711
+ options?: BlockFillOptions,
2712
+ ): number;
2624
2713
  /**
2714
+ * @beta
2625
2715
  * @remarks
2626
2716
  * Returns a block instance at the given location. This method
2627
2717
  * was introduced as of version 1.17.10.21.
@@ -2633,6 +2723,7 @@ export class Dimension {
2633
2723
  */
2634
2724
  getBlock(location: BlockLocation): Block;
2635
2725
  /**
2726
+ * @beta
2636
2727
  * @remarks
2637
2728
  * Gets the first block that intersects with a vector emanating
2638
2729
  * from a location.
@@ -2644,6 +2735,7 @@ export class Dimension {
2644
2735
  */
2645
2736
  getBlockFromRay(location: Location, direction: Vector, options?: BlockRaycastOptions): Block;
2646
2737
  /**
2738
+ * @beta
2647
2739
  * @remarks
2648
2740
  * Returns a set of entities based on a set of conditions
2649
2741
  * defined via the EntityQueryOptions set of filter criteria.
@@ -2674,6 +2766,7 @@ export class Dimension {
2674
2766
  */
2675
2767
  getEntities(getEntities?: EntityQueryOptions): EntityIterator;
2676
2768
  /**
2769
+ * @beta
2677
2770
  * @remarks
2678
2771
  * Returns a set of entities at a particular location.
2679
2772
  * @param location
@@ -2683,6 +2776,7 @@ export class Dimension {
2683
2776
  */
2684
2777
  getEntitiesAtBlockLocation(location: BlockLocation): Entity[];
2685
2778
  /**
2779
+ * @beta
2686
2780
  * @remarks
2687
2781
  * Gets entities that intersect with a specified vector
2688
2782
  * emanating from a location.
@@ -2694,6 +2788,7 @@ export class Dimension {
2694
2788
  */
2695
2789
  getEntitiesFromRay(location: Location, direction: Vector, options?: EntityRaycastOptions): Entity[];
2696
2790
  /**
2791
+ * @beta
2697
2792
  * @remarks
2698
2793
  * Returns a set of players based on a set of conditions
2699
2794
  * defined via the EntityQueryOptions set of filter criteria.
@@ -2720,6 +2815,7 @@ export class Dimension {
2720
2815
  */
2721
2816
  runCommandAsync(commandString: string): Promise<CommandResult>;
2722
2817
  /**
2818
+ * @beta
2723
2819
  * @remarks
2724
2820
  * Creates a new entity (e.g., a mob) at the specified
2725
2821
  * location.
@@ -2769,6 +2865,7 @@ export class Dimension {
2769
2865
  */
2770
2866
  spawnEntity(identifier: string, location: BlockLocation | Location): Entity;
2771
2867
  /**
2868
+ * @beta
2772
2869
  * @remarks
2773
2870
  * Creates a new item stack as an entity at the specified
2774
2871
  * location.
@@ -2802,6 +2899,7 @@ export class Dimension {
2802
2899
  */
2803
2900
  spawnItem(item: ItemStack, location: BlockLocation | Location): Entity;
2804
2901
  /**
2902
+ * @beta
2805
2903
  * @remarks
2806
2904
  * Creates a new particle emitter at a specified location in
2807
2905
  * the world.
@@ -2818,6 +2916,7 @@ export class Dimension {
2818
2916
  spawnParticle(effectName: string, location: Location, molangVariables: MolangVariableMap): void;
2819
2917
  }
2820
2918
  /**
2919
+ * @beta
2821
2920
  * For block properties that take a direction, provides a
2822
2921
  * structured way to specify the direction of a block property.
2823
2922
  */
@@ -2838,6 +2937,7 @@ export class DirectionBlockProperty extends IBlockProperty {
2838
2937
  value: Direction;
2839
2938
  }
2840
2939
  /**
2940
+ * @beta
2841
2941
  * Class used in conjunction with {@link PropertyRegistry} to
2842
2942
  * define dynamic properties that can be used on entities of a
2843
2943
  * specified type or at the global World- level.
@@ -2867,6 +2967,7 @@ export class DynamicPropertiesDefinition {
2867
2967
  defineString(identifier: string, maxLength: number): void;
2868
2968
  }
2869
2969
  /**
2970
+ * @beta
2870
2971
  * Represents an effect - like poison - that has been added to
2871
2972
  * an Entity.
2872
2973
  */
@@ -2876,19 +2977,23 @@ export class Effect {
2876
2977
  * Gets an amplifier that may have been applied to this effect.
2877
2978
  * Sample values range typically from 0 to 4. Example: The
2878
2979
  * effect 'Jump Boost II' will have an amplifier value of 1.
2980
+ * @throws This property can throw when used.
2879
2981
  */
2880
2982
  readonly amplifier: number;
2881
2983
  /**
2882
2984
  * Gets the player-friendly name of this effect.
2985
+ * @throws This property can throw when used.
2883
2986
  */
2884
2987
  readonly displayName: string;
2885
2988
  /**
2886
2989
  * Gets the entire specified duration, in ticks, of this
2887
2990
  * effect.
2991
+ * @throws This property can throw when used.
2888
2992
  */
2889
2993
  readonly duration: number;
2890
2994
  }
2891
2995
  /**
2996
+ * @beta
2892
2997
  * Contains information related to changes to an effect - like
2893
2998
  * poison - being added to an entity.
2894
2999
  */
@@ -2908,6 +3013,7 @@ export class EffectAddEvent {
2908
3013
  entity: Entity;
2909
3014
  }
2910
3015
  /**
3016
+ * @beta
2911
3017
  * Manages callbacks that are connected to when an effect is
2912
3018
  * added to an entity.
2913
3019
  */
@@ -2931,6 +3037,7 @@ export class EffectAddEventSignal {
2931
3037
  unsubscribe(callback: (arg: EffectAddEvent) => void): void;
2932
3038
  }
2933
3039
  /**
3040
+ * @beta
2934
3041
  * Represents a type of effect - like poison - that can be
2935
3042
  * applied to an entity.
2936
3043
  */
@@ -2945,6 +3052,7 @@ export class EffectType {
2945
3052
  getName(): string;
2946
3053
  }
2947
3054
  /**
3055
+ * @beta
2948
3056
  * This class represents a specific leveled enchantment that is
2949
3057
  * applied to an item.
2950
3058
  */
@@ -2968,6 +3076,7 @@ export class Enchantment {
2968
3076
  constructor(enchantmentType: EnchantmentType, level?: number);
2969
3077
  }
2970
3078
  /**
3079
+ * @beta
2971
3080
  * This class represents a collection of enchantments that can
2972
3081
  * be applied to an item.
2973
3082
  */
@@ -3016,6 +3125,7 @@ export class EnchantmentList implements Iterable<Enchantment> {
3016
3125
  removeEnchantment(enchantmentType: EnchantmentType): void;
3017
3126
  }
3018
3127
  /**
3128
+ * @beta
3019
3129
  * This enum represents the item slot or type that an
3020
3130
  * enchantment can be applied to.
3021
3131
  */
@@ -3048,6 +3158,7 @@ export class EnchantmentSlot {
3048
3158
  static readonly sword = 16;
3049
3159
  }
3050
3160
  /**
3161
+ * @beta
3051
3162
  * Contains information on a type of enchantment.
3052
3163
  */
3053
3164
  export class EnchantmentType {
@@ -3068,11 +3179,13 @@ export class EnchantmentType {
3068
3179
  export class Entity {
3069
3180
  protected constructor();
3070
3181
  /**
3182
+ * @beta
3071
3183
  * Dimension that the entity is currently within.
3072
3184
  * @throws This property can throw when used.
3073
3185
  */
3074
3186
  readonly dimension: Dimension;
3075
3187
  /**
3188
+ * @beta
3076
3189
  * Location of the center of the head component of the entity.
3077
3190
  * @throws This property can throw when used.
3078
3191
  */
@@ -3086,30 +3199,36 @@ export class Entity {
3086
3199
  */
3087
3200
  readonly id: string;
3088
3201
  /**
3202
+ * @beta
3089
3203
  * Whether the entity is sneaking - that is, moving more slowly
3090
3204
  * and more quietly.
3091
3205
  */
3092
3206
  isSneaking: boolean;
3093
3207
  /**
3208
+ * @beta
3094
3209
  * Current location of the entity.
3095
3210
  * @throws This property can throw when used.
3096
3211
  */
3097
3212
  readonly location: Vector3;
3098
3213
  /**
3214
+ * @beta
3099
3215
  * Given name of the entity.
3100
3216
  */
3101
3217
  nameTag: string;
3102
3218
  /**
3219
+ * @beta
3103
3220
  * Main rotation of the entity.
3104
3221
  * @throws This property can throw when used.
3105
3222
  */
3106
3223
  readonly rotation: XYRotation;
3107
3224
  /**
3225
+ * @beta
3108
3226
  * Returns a scoreboard identity that represents this entity.
3109
3227
  * @throws This property can throw when used.
3110
3228
  */
3111
3229
  readonly scoreboard: ScoreboardIdentity;
3112
3230
  /**
3231
+ * @beta
3113
3232
  * Retrieves or sets an entity that is used as the target of
3114
3233
  * AI-related behaviors, like attacking.
3115
3234
  * @throws This property can throw when used.
@@ -3122,16 +3241,19 @@ export class Entity {
3122
3241
  */
3123
3242
  readonly typeId: string;
3124
3243
  /**
3244
+ * @beta
3125
3245
  * Velocity of the entity.
3126
3246
  * @throws This property can throw when used.
3127
3247
  */
3128
3248
  readonly velocity: Vector;
3129
3249
  /**
3250
+ * @beta
3130
3251
  * Direction that this entity is looking out from.
3131
3252
  * @throws This property can throw when used.
3132
3253
  */
3133
3254
  readonly viewDirection: Vector3;
3134
3255
  /**
3256
+ * @beta
3135
3257
  * @remarks
3136
3258
  * Adds an effect, like poison, to the entity.
3137
3259
  * @param effectType
@@ -3172,6 +3294,7 @@ export class Entity {
3172
3294
  */
3173
3295
  addEffect(effectType: EffectType, duration: number, amplifier?: number, showParticles?: boolean): void;
3174
3296
  /**
3297
+ * @beta
3175
3298
  * @remarks
3176
3299
  * Adds a specified tag to an entity.
3177
3300
  * @param tag
@@ -3179,8 +3302,10 @@ export class Entity {
3179
3302
  * @throws This function can throw errors.
3180
3303
  */
3181
3304
  addTag(tag: string): boolean;
3305
+ applyDamage(amount: number, source?: EntityDamageSource): boolean;
3182
3306
  extinguishFire(useEffects?: boolean): boolean;
3183
3307
  /**
3308
+ * @beta
3184
3309
  * @remarks
3185
3310
  * Returns the first intersecting block from the direction that
3186
3311
  * this entity is looking at.
@@ -3189,6 +3314,7 @@ export class Entity {
3189
3314
  */
3190
3315
  getBlockFromViewDirection(options?: BlockRaycastOptions): Block;
3191
3316
  /**
3317
+ * @beta
3192
3318
  * @remarks
3193
3319
  * Gets a component (that represents additional capabilities)
3194
3320
  * for an entity.
@@ -3200,12 +3326,14 @@ export class Entity {
3200
3326
  */
3201
3327
  getComponent(componentId: string): IEntityComponent;
3202
3328
  /**
3329
+ * @beta
3203
3330
  * @remarks
3204
3331
  * Returns all components that are both present on this entity
3205
3332
  * and supported by the API.
3206
3333
  */
3207
3334
  getComponents(): IEntityComponent[];
3208
3335
  /**
3336
+ * @beta
3209
3337
  * @remarks
3210
3338
  * Returns a property value.
3211
3339
  * @param identifier
@@ -3214,8 +3342,9 @@ export class Entity {
3214
3342
  * property has not been set.
3215
3343
  * @throws This function can throw errors.
3216
3344
  */
3217
- getDynamicProperty(identifier: string): boolean | number | string;
3345
+ getDynamicProperty(identifier: string): boolean | number | string | undefined;
3218
3346
  /**
3347
+ * @beta
3219
3348
  * @remarks
3220
3349
  * Returns the effect for the specified EffectType on the
3221
3350
  * entity, or undefined if the effect is not present.
@@ -3226,7 +3355,9 @@ export class Entity {
3226
3355
  * @throws This function can throw errors.
3227
3356
  */
3228
3357
  getEffect(effectType: EffectType): Effect;
3358
+ getEffects(): Effect[];
3229
3359
  /**
3360
+ * @beta
3230
3361
  * @remarks
3231
3362
  * Returns a potential set of entities from the direction that
3232
3363
  * this entity is looking at.
@@ -3235,12 +3366,14 @@ export class Entity {
3235
3366
  */
3236
3367
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): Entity[];
3237
3368
  /**
3369
+ * @beta
3238
3370
  * @remarks
3239
3371
  * Returns all tags associated with an entity.
3240
3372
  * @throws This function can throw errors.
3241
3373
  */
3242
3374
  getTags(): string[];
3243
3375
  /**
3376
+ * @beta
3244
3377
  * @remarks
3245
3378
  * Returns true if the specified component is present on this
3246
3379
  * entity.
@@ -3251,6 +3384,7 @@ export class Entity {
3251
3384
  */
3252
3385
  hasComponent(componentId: string): boolean;
3253
3386
  /**
3387
+ * @beta
3254
3388
  * @remarks
3255
3389
  * Tests whether an entity has a particular tag.
3256
3390
  * @param tag
@@ -3259,12 +3393,14 @@ export class Entity {
3259
3393
  */
3260
3394
  hasTag(tag: string): boolean;
3261
3395
  /**
3396
+ * @beta
3262
3397
  * @remarks
3263
3398
  * Kills this entity. The entity will drop loot as normal.
3264
3399
  * @throws This function can throw errors.
3265
3400
  */
3266
3401
  kill(): void;
3267
3402
  /**
3403
+ * @beta
3268
3404
  * @remarks
3269
3405
  * Removes a specified property.
3270
3406
  * @param identifier
@@ -3272,6 +3408,7 @@ export class Entity {
3272
3408
  */
3273
3409
  removeDynamicProperty(identifier: string): boolean;
3274
3410
  /**
3411
+ * @beta
3275
3412
  * @remarks
3276
3413
  * Removes a specified tag from an entity.
3277
3414
  * @param tag
@@ -3294,6 +3431,7 @@ export class Entity {
3294
3431
  */
3295
3432
  runCommandAsync(commandString: string): Promise<CommandResult>;
3296
3433
  /**
3434
+ * @beta
3297
3435
  * @remarks
3298
3436
  * Sets a specified property to a value.
3299
3437
  * @param identifier
@@ -3304,6 +3442,7 @@ export class Entity {
3304
3442
  setDynamicProperty(identifier: string, value: boolean | number | string): void;
3305
3443
  setOnFire(seconds: number, useEffects?: boolean): boolean;
3306
3444
  /**
3445
+ * @beta
3307
3446
  * @remarks
3308
3447
  * Sets the main rotation of the entity.
3309
3448
  * @param degreesX
@@ -3312,6 +3451,7 @@ export class Entity {
3312
3451
  */
3313
3452
  setRotation(degreesX: number, degreesY: number): void;
3314
3453
  /**
3454
+ * @beta
3315
3455
  * @remarks
3316
3456
  * Sets a velocity for the entity to move with.
3317
3457
  * @param velocity
@@ -3320,6 +3460,7 @@ export class Entity {
3320
3460
  */
3321
3461
  setVelocity(velocity: Vector3): void;
3322
3462
  /**
3463
+ * @beta
3323
3464
  * @remarks
3324
3465
  * Teleports the selected entity to a new location
3325
3466
  * @param location
@@ -3341,6 +3482,7 @@ export class Entity {
3341
3482
  keepVelocity?: boolean,
3342
3483
  ): void;
3343
3484
  /**
3485
+ * @beta
3344
3486
  * @remarks
3345
3487
  * Teleports the selected entity to a new location, and will
3346
3488
  * have the entity facing a specified location.
@@ -3355,6 +3497,7 @@ export class Entity {
3355
3497
  */
3356
3498
  teleportFacing(location: Vector3, dimension: Dimension, facingLocation: Vector3, keepVelocity?: boolean): void;
3357
3499
  /**
3500
+ * @beta
3358
3501
  * @remarks
3359
3502
  * Triggers an entity type event. For every entity, a number of
3360
3503
  * events are defined in an entities' definition for key entity
@@ -3368,6 +3511,7 @@ export class Entity {
3368
3511
  triggerEvent(eventName: string): void;
3369
3512
  }
3370
3513
  /**
3514
+ * @beta
3371
3515
  * When added, this component makes the entity spawn with a
3372
3516
  * rider of the specified entityType.
3373
3517
  */
@@ -3397,6 +3541,7 @@ export class EntityAddRiderComponent extends IEntityComponent {
3397
3541
  static readonly componentId = 'minecraft:addrider';
3398
3542
  }
3399
3543
  /**
3544
+ * @beta
3400
3545
  * Adds a timer for the entity to grow up. It can be
3401
3546
  * accelerated by giving the entity the items it likes as
3402
3547
  * defined by feedItems.
@@ -3438,6 +3583,7 @@ export class EntityAgeableComponent extends IEntityComponent {
3438
3583
  static readonly componentId = 'minecraft:ageable';
3439
3584
  }
3440
3585
  /**
3586
+ * @beta
3441
3587
  * Defines what blocks this entity can breathe in and gives
3442
3588
  * them the ability to suffocate.
3443
3589
  */
@@ -3515,6 +3661,7 @@ export class EntityBreathableComponent extends IEntityComponent {
3515
3661
  setAirSupply(value: number): void;
3516
3662
  }
3517
3663
  /**
3664
+ * @beta
3518
3665
  * When added, this component signifies that the entity can
3519
3666
  * climb up ladders.
3520
3667
  */
@@ -3532,6 +3679,7 @@ export class EntityCanClimbComponent extends IEntityComponent {
3532
3679
  static readonly componentId = 'minecraft:can_climb';
3533
3680
  }
3534
3681
  /**
3682
+ * @beta
3535
3683
  * When added, this component signifies that the entity can
3536
3684
  * fly, and the pathfinder won't be restricted to paths where a
3537
3685
  * solid block is required underneath it.
@@ -3550,6 +3698,7 @@ export class EntityCanFlyComponent extends IEntityComponent {
3550
3698
  static readonly componentId = 'minecraft:can_fly';
3551
3699
  }
3552
3700
  /**
3701
+ * @beta
3553
3702
  * When added, this component signifies that the entity can
3554
3703
  * power jump like the horse does within Minecraft.
3555
3704
  */
@@ -3567,6 +3716,7 @@ export class EntityCanPowerJumpComponent extends IEntityComponent {
3567
3716
  static readonly componentId = 'minecraft:can_power_jump';
3568
3717
  }
3569
3718
  /**
3719
+ * @beta
3570
3720
  * Defines the entity's color. Only works on certain entities
3571
3721
  * that have predefined color values (sheep, llama, shulker).
3572
3722
  */
@@ -3588,6 +3738,7 @@ export class EntityColorComponent extends IEntityComponent {
3588
3738
  static readonly componentId = 'minecraft:color';
3589
3739
  }
3590
3740
  /**
3741
+ * @beta
3591
3742
  * As part of the Ageable component, represents a set of items
3592
3743
  * that can be fed to an entity and the rate at which that
3593
3744
  * causes them to grow.
@@ -3607,6 +3758,7 @@ export class EntityDefinitionFeedItem {
3607
3758
  readonly item: string;
3608
3759
  }
3609
3760
  /**
3761
+ * @beta
3610
3762
  * When added, this component signifies that this entity
3611
3763
  * doesn't take damage from fire.
3612
3764
  */
@@ -3624,6 +3776,7 @@ export class EntityFireImmuneComponent extends IEntityComponent {
3624
3776
  static readonly componentId = 'minecraft:fire_immune';
3625
3777
  }
3626
3778
  /**
3779
+ * @beta
3627
3780
  * When added, this component signifies that this entity can
3628
3781
  * float in liquid blocks.
3629
3782
  */
@@ -3641,6 +3794,7 @@ export class EntityFloatsInLiquidComponent extends IEntityComponent {
3641
3794
  static readonly componentId = 'minecraft:floats_in_liquid';
3642
3795
  }
3643
3796
  /**
3797
+ * @beta
3644
3798
  * Represents the flying speed of an entity.
3645
3799
  */
3646
3800
  export class EntityFlyingSpeedComponent extends IEntityComponent {
@@ -3661,6 +3815,7 @@ export class EntityFlyingSpeedComponent extends IEntityComponent {
3661
3815
  static readonly componentId = 'minecraft:flying_speed';
3662
3816
  }
3663
3817
  /**
3818
+ * @beta
3664
3819
  * Defines how much friction affects this entity.
3665
3820
  */
3666
3821
  export class EntityFrictionModifierComponent extends IEntityComponent {
@@ -3683,6 +3838,7 @@ export class EntityFrictionModifierComponent extends IEntityComponent {
3683
3838
  static readonly componentId = 'minecraft:friction_modifier';
3684
3839
  }
3685
3840
  /**
3841
+ * @beta
3686
3842
  * Sets the offset from the ground that the entity is actually
3687
3843
  * at.
3688
3844
  */
@@ -3705,6 +3861,7 @@ export class EntityGroundOffsetComponent extends IEntityComponent {
3705
3861
  static readonly componentId = 'minecraft:ground_offset';
3706
3862
  }
3707
3863
  /**
3864
+ * @beta
3708
3865
  * Defines the interactions with this entity for healing it.
3709
3866
  */
3710
3867
  export class EntityHealableComponent extends IEntityComponent {
@@ -3737,6 +3894,7 @@ export class EntityHealableComponent extends IEntityComponent {
3737
3894
  static readonly componentId = 'minecraft:healable';
3738
3895
  }
3739
3896
  /**
3897
+ * @beta
3740
3898
  * Defines the health properties of an entity.
3741
3899
  */
3742
3900
  export class EntityHealthComponent extends IEntityComponent {
@@ -3791,6 +3949,7 @@ export class EntityHealthComponent extends IEntityComponent {
3791
3949
  setCurrent(value: number): void;
3792
3950
  }
3793
3951
  /**
3952
+ * @beta
3794
3953
  * Contains information related to an entity hitting (melee
3795
3954
  * attacking) another entity.
3796
3955
  */
@@ -3816,6 +3975,7 @@ export class EntityHitEvent {
3816
3975
  readonly hitEntity?: Entity;
3817
3976
  }
3818
3977
  /**
3978
+ * @beta
3819
3979
  * Manages callbacks that are connected to when an entity makes
3820
3980
  * a melee attack on another entity.
3821
3981
  */
@@ -3839,6 +3999,7 @@ export class EntityHitEventSignal {
3839
3999
  unsubscribe(callback: (arg: EntityHitEvent) => void): void;
3840
4000
  }
3841
4001
  /**
4002
+ * @beta
3842
4003
  * Contains additional information about an entity that was
3843
4004
  * hit.
3844
4005
  */
@@ -3850,36 +4011,24 @@ export class EntityHitInformation {
3850
4011
  readonly entity: Entity;
3851
4012
  }
3852
4013
  /**
4014
+ * @beta
3853
4015
  * Contains information related to an entity getting hurt by
3854
4016
  * another entity.
3855
4017
  */
3856
4018
  export class EntityHurtEvent {
3857
4019
  protected constructor();
3858
- /**
3859
- * A summary of the reason that damage was caused.
3860
- */
3861
- readonly cause: EntityDamageCause;
3862
4020
  /**
3863
4021
  * Describes the amount of damage caused.
3864
4022
  */
3865
4023
  readonly damage: number;
3866
- /**
3867
- * Optional entity that caused the damaging attack, or
3868
- * undefined if the hurt reason was not because of another
3869
- * entity.
3870
- */
3871
- readonly damagingEntity: Entity;
4024
+ readonly damageSource: EntityDamageSource;
3872
4025
  /**
3873
4026
  * Entity that was hurt.
3874
4027
  */
3875
4028
  readonly hurtEntity: Entity;
3876
- /**
3877
- * Optional entity for a projectile that potentially hurt an
3878
- * entity.
3879
- */
3880
- readonly projectile: Entity;
3881
4029
  }
3882
4030
  /**
4031
+ * @beta
3883
4032
  * Manages callbacks that are connected to when an entity is
3884
4033
  * hurt.
3885
4034
  */
@@ -3901,6 +4050,7 @@ export class EntityHurtEventSignal {
3901
4050
  unsubscribe(callback: (arg: EntityHurtEvent) => void): void;
3902
4051
  }
3903
4052
  /**
4053
+ * @beta
3904
4054
  * Defines this entity's inventory properties.
3905
4055
  */
3906
4056
  export class EntityInventoryComponent extends IEntityComponent {
@@ -3955,6 +4105,7 @@ export class EntityInventoryComponent extends IEntityComponent {
3955
4105
  static readonly componentId = 'minecraft:inventory';
3956
4106
  }
3957
4107
  /**
4108
+ * @beta
3958
4109
  * When added, this component signifies that this entity is a
3959
4110
  * baby.
3960
4111
  */
@@ -3972,6 +4123,7 @@ export class EntityIsBabyComponent extends IEntityComponent {
3972
4123
  static readonly componentId = 'minecraft:is_baby';
3973
4124
  }
3974
4125
  /**
4126
+ * @beta
3975
4127
  * When added, this component signifies that this entity is
3976
4128
  * charged.
3977
4129
  */
@@ -3989,6 +4141,7 @@ export class EntityIsChargedComponent extends IEntityComponent {
3989
4141
  static readonly componentId = 'minecraft:is_charged';
3990
4142
  }
3991
4143
  /**
4144
+ * @beta
3992
4145
  * When added, this component signifies that this entity is
3993
4146
  * currently carrying a chest.
3994
4147
  */
@@ -4006,6 +4159,7 @@ export class EntityIsChestedComponent extends IEntityComponent {
4006
4159
  static readonly componentId = 'minecraft:is_chested';
4007
4160
  }
4008
4161
  /**
4162
+ * @beta
4009
4163
  * When added, this component signifies that dyes can be used
4010
4164
  * on this entity to change its color.
4011
4165
  */
@@ -4023,6 +4177,7 @@ export class EntityIsDyableComponent extends IEntityComponent {
4023
4177
  static readonly componentId = 'minecraft:is_dyeable';
4024
4178
  }
4025
4179
  /**
4180
+ * @beta
4026
4181
  * When added, this component signifies that this entity can
4027
4182
  * hide from hostile mobs while invisible.
4028
4183
  */
@@ -4040,6 +4195,7 @@ export class EntityIsHiddenWhenInvisibleComponent extends IEntityComponent {
4040
4195
  static readonly componentId = 'minecraft:is_hidden_when_invisible';
4041
4196
  }
4042
4197
  /**
4198
+ * @beta
4043
4199
  * When added, this component signifies that this entity this
4044
4200
  * currently on fire.
4045
4201
  */
@@ -4057,6 +4213,7 @@ export class EntityIsIgnitedComponent extends IEntityComponent {
4057
4213
  static readonly componentId = 'minecraft:is_ignited';
4058
4214
  }
4059
4215
  /**
4216
+ * @beta
4060
4217
  * When added, this component signifies that this entity is an
4061
4218
  * illager captain.
4062
4219
  */
@@ -4074,6 +4231,7 @@ export class EntityIsIllagerCaptainComponent extends IEntityComponent {
4074
4231
  static readonly componentId = 'minecraft:is_illager_captain';
4075
4232
  }
4076
4233
  /**
4234
+ * @beta
4077
4235
  * When added, this component signifies that this entity is
4078
4236
  * currently saddled.
4079
4237
  */
@@ -4091,6 +4249,7 @@ export class EntityIsSaddledComponent extends IEntityComponent {
4091
4249
  static readonly componentId = 'minecraft:is_saddled';
4092
4250
  }
4093
4251
  /**
4252
+ * @beta
4094
4253
  * When added, this component signifies that this entity is
4095
4254
  * currently shaking.
4096
4255
  */
@@ -4108,6 +4267,7 @@ export class EntityIsShakingComponent extends IEntityComponent {
4108
4267
  static readonly componentId = 'minecraft:is_shaking';
4109
4268
  }
4110
4269
  /**
4270
+ * @beta
4111
4271
  * When added, this component signifies that this entity is
4112
4272
  * currently sheared.
4113
4273
  */
@@ -4125,6 +4285,7 @@ export class EntityIsShearedComponent extends IEntityComponent {
4125
4285
  static readonly componentId = 'minecraft:is_sheared';
4126
4286
  }
4127
4287
  /**
4288
+ * @beta
4128
4289
  * When added, this component signifies that this entity can be
4129
4290
  * stacked.
4130
4291
  */
@@ -4142,6 +4303,7 @@ export class EntityIsStackableComponent extends IEntityComponent {
4142
4303
  static readonly componentId = 'minecraft:is_stackable';
4143
4304
  }
4144
4305
  /**
4306
+ * @beta
4145
4307
  * When added, this component signifies that this entity is
4146
4308
  * currently stunned.
4147
4309
  */
@@ -4159,6 +4321,7 @@ export class EntityIsStunnedComponent extends IEntityComponent {
4159
4321
  static readonly componentId = 'minecraft:is_stunned';
4160
4322
  }
4161
4323
  /**
4324
+ * @beta
4162
4325
  * When added, this component signifies that this entity is
4163
4326
  * currently tamed.
4164
4327
  */
@@ -4176,6 +4339,7 @@ export class EntityIsTamedComponent extends IEntityComponent {
4176
4339
  static readonly componentId = 'minecraft:is_tamed';
4177
4340
  }
4178
4341
  /**
4342
+ * @beta
4179
4343
  * If added onto the entity, this indicates that the entity
4180
4344
  * represents a free-floating item in the world. Lets you
4181
4345
  * retrieve the actual item stack contents via the itemStack
@@ -4198,6 +4362,7 @@ export class EntityItemComponent extends IEntityComponent {
4198
4362
  static readonly componentId = 'minecraft:item';
4199
4363
  }
4200
4364
  /**
4365
+ * @beta
4201
4366
  * This type is usable for iterating over a set of entities.
4202
4367
  * This means it can be used in statements like for...of
4203
4368
  * statements, Array.from(iterator), and more.
@@ -4214,6 +4379,7 @@ export class EntityIterator implements Iterable<Entity> {
4214
4379
  next(): IteratorResult<Entity>;
4215
4380
  }
4216
4381
  /**
4382
+ * @beta
4217
4383
  * Defines the base movement speed in lava of this entity.
4218
4384
  */
4219
4385
  export class EntityLavaMovementComponent extends IEntityComponent {
@@ -4271,6 +4437,7 @@ export class EntityLavaMovementComponent extends IEntityComponent {
4271
4437
  setCurrent(value: number): void;
4272
4438
  }
4273
4439
  /**
4440
+ * @beta
4274
4441
  * Allows this entity to be leashed and defines the conditions
4275
4442
  * and events for this entity when is leashed.
4276
4443
  */
@@ -4309,6 +4476,7 @@ export class EntityLeashableComponent extends IEntityComponent {
4309
4476
  unleash(): void;
4310
4477
  }
4311
4478
  /**
4479
+ * @beta
4312
4480
  * Additional variant value. Can be used to further
4313
4481
  * differentiate variants.
4314
4482
  */
@@ -4331,6 +4499,7 @@ export class EntityMarkVariantComponent extends IEntityComponent {
4331
4499
  static readonly componentId = 'minecraft:mark_variant';
4332
4500
  }
4333
4501
  /**
4502
+ * @beta
4334
4503
  * Contains options for taming a rideable entity based on the
4335
4504
  * entity that mounts it.
4336
4505
  */
@@ -4356,6 +4525,7 @@ export class EntityMountTamingComponent extends IEntityComponent {
4356
4525
  setTamed(showParticles: boolean): void;
4357
4526
  }
4358
4527
  /**
4528
+ * @beta
4359
4529
  * When added, this movement control allows the mob to swim in
4360
4530
  * water and walk on land.
4361
4531
  */
@@ -4378,6 +4548,7 @@ export class EntityMovementAmphibiousComponent extends IEntityComponent {
4378
4548
  static readonly componentId = 'minecraft:movement.amphibious';
4379
4549
  }
4380
4550
  /**
4551
+ * @beta
4381
4552
  * This component accents the movement of an entity.
4382
4553
  */
4383
4554
  export class EntityMovementBasicComponent extends IEntityComponent {
@@ -4399,6 +4570,7 @@ export class EntityMovementBasicComponent extends IEntityComponent {
4399
4570
  static readonly componentId = 'minecraft:movement.basic';
4400
4571
  }
4401
4572
  /**
4573
+ * @beta
4402
4574
  * Defines the general movement speed of this entity.
4403
4575
  */
4404
4576
  export class EntityMovementComponent extends IEntityComponent {
@@ -4455,6 +4627,7 @@ export class EntityMovementComponent extends IEntityComponent {
4455
4627
  setCurrent(value: number): void;
4456
4628
  }
4457
4629
  /**
4630
+ * @beta
4458
4631
  * When added, this move control causes the mob to fly.
4459
4632
  */
4460
4633
  export class EntityMovementFlyComponent extends IEntityComponent {
@@ -4476,6 +4649,7 @@ export class EntityMovementFlyComponent extends IEntityComponent {
4476
4649
  static readonly componentId = 'minecraft:movement.fly';
4477
4650
  }
4478
4651
  /**
4652
+ * @beta
4479
4653
  * When added, this move control allows a mob to fly, swim,
4480
4654
  * climb, etc.
4481
4655
  */
@@ -4498,6 +4672,7 @@ export class EntityMovementGenericComponent extends IEntityComponent {
4498
4672
  static readonly componentId = 'minecraft:movement.generic';
4499
4673
  }
4500
4674
  /**
4675
+ * @beta
4501
4676
  * When added, this movement control allows the mob to glide.
4502
4677
  */
4503
4678
  export class EntityMovementGlideComponent extends IEntityComponent {
@@ -4529,6 +4704,7 @@ export class EntityMovementGlideComponent extends IEntityComponent {
4529
4704
  static readonly componentId = 'minecraft:movement.glide';
4530
4705
  }
4531
4706
  /**
4707
+ * @beta
4532
4708
  * When added, this move control causes the mob to hover.
4533
4709
  */
4534
4710
  export class EntityMovementHoverComponent extends IEntityComponent {
@@ -4550,6 +4726,7 @@ export class EntityMovementHoverComponent extends IEntityComponent {
4550
4726
  static readonly componentId = 'minecraft:movement.hover';
4551
4727
  }
4552
4728
  /**
4729
+ * @beta
4553
4730
  * Move control that causes the mob to jump as it moves with a
4554
4731
  * specified delay between jumps.
4555
4732
  */
@@ -4572,6 +4749,7 @@ export class EntityMovementJumpComponent extends IEntityComponent {
4572
4749
  static readonly componentId = 'minecraft:movement.jump';
4573
4750
  }
4574
4751
  /**
4752
+ * @beta
4575
4753
  * When added, this move control causes the mob to hop as it
4576
4754
  * moves.
4577
4755
  */
@@ -4594,6 +4772,7 @@ export class EntityMovementSkipComponent extends IEntityComponent {
4594
4772
  static readonly componentId = 'minecraft:movement.skip';
4595
4773
  }
4596
4774
  /**
4775
+ * @beta
4597
4776
  * When added, this move control causes the mob to sway side to
4598
4777
  * side giving the impression it is swimming.
4599
4778
  */
@@ -4626,6 +4805,7 @@ export class EntityMovementSwayComponent extends IEntityComponent {
4626
4805
  static readonly componentId = 'minecraft:movement.sway';
4627
4806
  }
4628
4807
  /**
4808
+ * @beta
4629
4809
  * Allows this entity to generate paths that include vertical
4630
4810
  * walls (for example, like Minecraft spiders do.)
4631
4811
  */
@@ -4753,6 +4933,7 @@ export class EntityNavigationClimbComponent extends IEntityComponent {
4753
4933
  static readonly componentId = 'minecraft:navigation.climb';
4754
4934
  }
4755
4935
  /**
4936
+ * @beta
4756
4937
  * Allows this entity to generate paths by flying around the
4757
4938
  * air like the regular Ghast.
4758
4939
  */
@@ -4880,6 +5061,7 @@ export class EntityNavigationFloatComponent extends IEntityComponent {
4880
5061
  static readonly componentId = 'minecraft:navigation.float';
4881
5062
  }
4882
5063
  /**
5064
+ * @beta
4883
5065
  * Allows this entity to generate paths in the air (for
4884
5066
  * example, like Minecraft parrots do.)
4885
5067
  */
@@ -5007,6 +5189,7 @@ export class EntityNavigationFlyComponent extends IEntityComponent {
5007
5189
  static readonly componentId = 'minecraft:navigation.fly';
5008
5190
  }
5009
5191
  /**
5192
+ * @beta
5010
5193
  * Allows this entity to generate paths by walking, swimming,
5011
5194
  * flying and/or climbing around and jumping up and down a
5012
5195
  * block.
@@ -5135,6 +5318,7 @@ export class EntityNavigationGenericComponent extends IEntityComponent {
5135
5318
  static readonly componentId = 'minecraft:navigation.generic';
5136
5319
  }
5137
5320
  /**
5321
+ * @beta
5138
5322
  * Allows this entity to generate paths in the air (for
5139
5323
  * example, like the Minecraft Bees do.) Keeps them from
5140
5324
  * falling out of the skies and doing predictive movement.
@@ -5263,6 +5447,7 @@ export class EntityNavigationHoverComponent extends IEntityComponent {
5263
5447
  static readonly componentId = 'minecraft:navigation.hover';
5264
5448
  }
5265
5449
  /**
5450
+ * @beta
5266
5451
  * Allows this entity to generate paths by walking around and
5267
5452
  * jumping up and down a block like regular mobs.
5268
5453
  */
@@ -5396,6 +5581,7 @@ export class EntityOnFireComponent extends IEntityComponent {
5396
5581
  static readonly componentId = 'minecraft:onfire';
5397
5582
  }
5398
5583
  /**
5584
+ * @beta
5399
5585
  * Sets the distance through which the entity can push through.
5400
5586
  */
5401
5587
  export class EntityPushThroughComponent extends IEntityComponent {
@@ -5416,6 +5602,7 @@ export class EntityPushThroughComponent extends IEntityComponent {
5416
5602
  static readonly componentId = 'minecraft:push_through';
5417
5603
  }
5418
5604
  /**
5605
+ * @beta
5419
5606
  * When added, this component adds the capability that an
5420
5607
  * entity can be ridden by another entity.
5421
5608
  */
@@ -5505,6 +5692,7 @@ export class EntityRideableComponent extends IEntityComponent {
5505
5692
  ejectRiders(): void;
5506
5693
  }
5507
5694
  /**
5695
+ * @beta
5508
5696
  * Sets the entity's visual size.
5509
5697
  */
5510
5698
  export class EntityScaleComponent extends IEntityComponent {
@@ -5527,6 +5715,7 @@ export class EntityScaleComponent extends IEntityComponent {
5527
5715
  static readonly componentId = 'minecraft:scale';
5528
5716
  }
5529
5717
  /**
5718
+ * @beta
5530
5719
  * Skin Id value. Can be used to differentiate skins, such as
5531
5720
  * base skins for villagers.
5532
5721
  */
@@ -5549,6 +5738,7 @@ export class EntitySkinIdComponent extends IEntityComponent {
5549
5738
  static readonly componentId = 'minecraft:skin_id';
5550
5739
  }
5551
5740
  /**
5741
+ * @beta
5552
5742
  * Contains data related to an entity spawning within the
5553
5743
  * world.
5554
5744
  */
@@ -5560,6 +5750,7 @@ export class EntitySpawnEvent {
5560
5750
  entity: Entity;
5561
5751
  }
5562
5752
  /**
5753
+ * @beta
5563
5754
  * Registers a script-based event handler for handling what
5564
5755
  * happens when an entity spawns.
5565
5756
  */
@@ -5585,6 +5776,7 @@ export class EntitySpawnEventSignal {
5585
5776
  unsubscribe(callback: (arg: EntitySpawnEvent) => void): void;
5586
5777
  }
5587
5778
  /**
5779
+ * @beta
5588
5780
  * Defines the entity's strength to carry items.
5589
5781
  */
5590
5782
  export class EntityStrengthComponent extends IEntityComponent {
@@ -5613,6 +5805,7 @@ export class EntityStrengthComponent extends IEntityComponent {
5613
5805
  static readonly componentId = 'minecraft:strength';
5614
5806
  }
5615
5807
  /**
5808
+ * @beta
5616
5809
  * Defines the rules for a mob to be tamed by the player.
5617
5810
  */
5618
5811
  export class EntityTameableComponent extends IEntityComponent {
@@ -5653,6 +5846,7 @@ export class EntityTameableComponent extends IEntityComponent {
5653
5846
  tame(): boolean;
5654
5847
  }
5655
5848
  /**
5849
+ * @beta
5656
5850
  * Represents information about a type of entity.
5657
5851
  */
5658
5852
  export class EntityType {
@@ -5664,6 +5858,7 @@ export class EntityType {
5664
5858
  readonly id: string;
5665
5859
  }
5666
5860
  /**
5861
+ * @beta
5667
5862
  * An iterator that loops through available entity types.
5668
5863
  */
5669
5864
  export class EntityTypeIterator implements Iterable<EntityType> {
@@ -5672,6 +5867,7 @@ export class EntityTypeIterator implements Iterable<EntityType> {
5672
5867
  next(): IteratorResult<EntityType>;
5673
5868
  }
5674
5869
  /**
5870
+ * @beta
5675
5871
  * Used for accessing all entity types currently available for
5676
5872
  * use within the world.
5677
5873
  */
@@ -5691,6 +5887,7 @@ export class EntityTypes {
5691
5887
  static getAll(): EntityTypeIterator;
5692
5888
  }
5693
5889
  /**
5890
+ * @beta
5694
5891
  * Defines the general movement speed underwater of this
5695
5892
  * entity.
5696
5893
  */
@@ -5751,6 +5948,7 @@ export class EntityUnderwaterMovementComponent extends IEntityComponent {
5751
5948
  setCurrent(value: number): void;
5752
5949
  }
5753
5950
  /**
5951
+ * @beta
5754
5952
  * Used to differentiate the component group of a variant of an
5755
5953
  * entity from others. (e.g. ocelot, villager).
5756
5954
  */
@@ -5774,6 +5972,7 @@ export class EntityVariantComponent extends IEntityComponent {
5774
5972
  static readonly componentId = 'minecraft:variant';
5775
5973
  }
5776
5974
  /**
5975
+ * @beta
5777
5976
  * When added, this component signifies that this entity wants
5778
5977
  * to become a jockey.
5779
5978
  */
@@ -5791,6 +5990,7 @@ export class EntityWantsJockeyComponent extends IEntityComponent {
5791
5990
  static readonly componentId = 'minecraft:wants_jockey';
5792
5991
  }
5793
5992
  /**
5993
+ * @beta
5794
5994
  * Contains a set of events that are available across the scope
5795
5995
  * of the World.
5796
5996
  */
@@ -5979,6 +6179,7 @@ export class Events {
5979
6179
  readonly worldInitialize: WorldInitializeEventSignal;
5980
6180
  }
5981
6181
  /**
6182
+ * @beta
5982
6183
  * Contains information regarding an explosion that has
5983
6184
  * happened.
5984
6185
  */
@@ -5998,6 +6199,7 @@ export class ExplosionEvent {
5998
6199
  readonly source: Entity;
5999
6200
  }
6000
6201
  /**
6202
+ * @beta
6001
6203
  * Manages callbacks that are connected to when an explosion
6002
6204
  * occurs.
6003
6205
  */
@@ -6020,6 +6222,7 @@ export class ExplosionEventSignal {
6020
6222
  unsubscribe(callback: (arg: ExplosionEvent) => void): void;
6021
6223
  }
6022
6224
  /**
6225
+ * @beta
6023
6226
  * As part of the Healable component, represents a specific
6024
6227
  * item that can be fed to an entity to cause health effects.
6025
6228
  */
@@ -6044,6 +6247,7 @@ export class FeedItem {
6044
6247
  readonly item: string;
6045
6248
  }
6046
6249
  /**
6250
+ * @beta
6047
6251
  * Represents an effect that is applied as a result of a food
6048
6252
  * item being fed to an entity.
6049
6253
  */
@@ -6071,6 +6275,7 @@ export class FeedItemEffect {
6071
6275
  readonly name: string;
6072
6276
  }
6073
6277
  /**
6278
+ * @beta
6074
6279
  * Represents a set of filters for when an event should occur.
6075
6280
  */
6076
6281
  // tslint:disable-next-line:no-unnecessary-class
@@ -6078,6 +6283,7 @@ export class FilterGroup {
6078
6283
  protected constructor();
6079
6284
  }
6080
6285
  /**
6286
+ * @beta
6081
6287
  * Represents constants related to fluid containers.
6082
6288
  */
6083
6289
  // tslint:disable-next-line:no-unnecessary-class
@@ -6095,6 +6301,7 @@ export class FluidContainer {
6095
6301
  static readonly minFillLevel = 0;
6096
6302
  }
6097
6303
  /**
6304
+ * @beta
6098
6305
  * Contains an interface for defining the state of a property
6099
6306
  * for a {@link BlockPermutation}.
6100
6307
  */
@@ -6106,6 +6313,7 @@ export class IBlockProperty {
6106
6313
  readonly name: string;
6107
6314
  }
6108
6315
  /**
6316
+ * @beta
6109
6317
  * Base interface that defines components associated with an
6110
6318
  * entity.
6111
6319
  */
@@ -6117,6 +6325,7 @@ export class IEntityComponent {
6117
6325
  readonly typeId: string;
6118
6326
  }
6119
6327
  /**
6328
+ * @beta
6120
6329
  * Contains the state of an integer-based property for a {@link
6121
6330
  * BlockPermutation}.
6122
6331
  */
@@ -6140,6 +6349,7 @@ export class IntBlockProperty extends IBlockProperty {
6140
6349
  value: number;
6141
6350
  }
6142
6351
  /**
6352
+ * @beta
6143
6353
  * Represents a container that can hold stacks of items. Used
6144
6354
  * for entities like players, chest minecarts, llamas, and
6145
6355
  * more.
@@ -6254,6 +6464,7 @@ export class InventoryComponentContainer extends Container {
6254
6464
  transferItem(fromSlot: number, toSlot: number, toContainer: Container): boolean;
6255
6465
  }
6256
6466
  /**
6467
+ * @beta
6257
6468
  * Contains information related to a chargeable item completing
6258
6469
  * being charged.
6259
6470
  */
@@ -6274,6 +6485,7 @@ export class ItemCompleteChargeEvent {
6274
6485
  readonly useDuration: number;
6275
6486
  }
6276
6487
  /**
6488
+ * @beta
6277
6489
  * Manages callbacks that are connected to the completion of
6278
6490
  * charging for a chargeable item.
6279
6491
  */
@@ -6296,6 +6508,7 @@ export class ItemCompleteChargeEventSignal {
6296
6508
  unsubscribe(callback: (arg: ItemCompleteChargeEvent) => void): void;
6297
6509
  }
6298
6510
  /**
6511
+ * @beta
6299
6512
  * When present on an item, this item has a cooldown effect
6300
6513
  * when used by entities.
6301
6514
  */
@@ -6327,6 +6540,7 @@ export class ItemCooldownComponent {
6327
6540
  startCooldown(player: Player): void;
6328
6541
  }
6329
6542
  /**
6543
+ * @beta
6330
6544
  * Manages callbacks that are connected to an item's definition
6331
6545
  * and components changing.
6332
6546
  */
@@ -6349,6 +6563,7 @@ export class ItemDefinitionEventSignal {
6349
6563
  unsubscribe(callback: (arg: ItemDefinitionTriggeredEvent) => void): void;
6350
6564
  }
6351
6565
  /**
6566
+ * @beta
6352
6567
  * Contains information related to a custom item having a data
6353
6568
  * definition change being triggered.
6354
6569
  */
@@ -6369,6 +6584,7 @@ export class ItemDefinitionTriggeredEvent {
6369
6584
  readonly source: Entity;
6370
6585
  }
6371
6586
  /**
6587
+ * @beta
6372
6588
  * When present on an item, this item can take damage in the
6373
6589
  * process of being used. Note that this component only applies
6374
6590
  * to data-driven items.
@@ -6409,6 +6625,7 @@ export class ItemDurabilityComponent {
6409
6625
  getDamageChance(unbreaking?: number): number;
6410
6626
  }
6411
6627
  /**
6628
+ * @beta
6412
6629
  * When present on an item, this item has applied enchantment
6413
6630
  * effects. Note that this component only applies to
6414
6631
  * data-driven items.
@@ -6432,6 +6649,7 @@ export class ItemEnchantsComponent {
6432
6649
  removeAllEnchantments(): void;
6433
6650
  }
6434
6651
  /**
6652
+ * @beta
6435
6653
  * When present on an item, this item is consumable by
6436
6654
  * entities. Note that this component only applies to
6437
6655
  * data-driven items.
@@ -6470,6 +6688,7 @@ export class ItemFoodComponent {
6470
6688
  static readonly componentId = 'minecraft:food';
6471
6689
  }
6472
6690
  /**
6691
+ * @beta
6473
6692
  * Contains information related to a chargeable item when the
6474
6693
  * player has finished using the item and released the build
6475
6694
  * action.
@@ -6491,6 +6710,7 @@ export class ItemReleaseChargeEvent {
6491
6710
  readonly useDuration: number;
6492
6711
  }
6493
6712
  /**
6713
+ * @beta
6494
6714
  * Manages callbacks that are connected to the releasing of
6495
6715
  * charging for a chargeable item.
6496
6716
  */
@@ -6513,6 +6733,7 @@ export class ItemReleaseChargeEventSignal {
6513
6733
  unsubscribe(callback: (arg: ItemReleaseChargeEvent) => void): void;
6514
6734
  }
6515
6735
  /**
6736
+ * @beta
6516
6737
  * Represents a collection of all of the available item types
6517
6738
  * in Minecraft.
6518
6739
  */
@@ -6528,6 +6749,7 @@ export class Items {
6528
6749
  static get(itemId: string): ItemType;
6529
6750
  }
6530
6751
  /**
6752
+ * @beta
6531
6753
  * Defines a collection of items.
6532
6754
  */
6533
6755
  export class ItemStack {
@@ -6618,6 +6840,7 @@ export class ItemStack {
6618
6840
  triggerEvent(eventName: string): void;
6619
6841
  }
6620
6842
  /**
6843
+ * @beta
6621
6844
  * Contains information related to a chargeable item starting
6622
6845
  * to be charged.
6623
6846
  */
@@ -6638,6 +6861,7 @@ export class ItemStartChargeEvent {
6638
6861
  readonly useDuration: number;
6639
6862
  }
6640
6863
  /**
6864
+ * @beta
6641
6865
  * Manages callbacks that are connected to the start of
6642
6866
  * charging for a chargeable item.
6643
6867
  */
@@ -6660,6 +6884,7 @@ export class ItemStartChargeEventSignal {
6660
6884
  unsubscribe(callback: (arg: ItemStartChargeEvent) => void): void;
6661
6885
  }
6662
6886
  /**
6887
+ * @beta
6663
6888
  * Contains information related to an item being used on a
6664
6889
  * block.
6665
6890
  */
@@ -6688,6 +6913,7 @@ export class ItemStartUseOnEvent {
6688
6913
  readonly source: Entity;
6689
6914
  }
6690
6915
  /**
6916
+ * @beta
6691
6917
  * Manages callbacks that are connected to an item starting
6692
6918
  * being used on a block event.
6693
6919
  */
@@ -6710,6 +6936,7 @@ export class ItemStartUseOnEventSignal {
6710
6936
  unsubscribe(callback: (arg: ItemStartUseOnEvent) => void): void;
6711
6937
  }
6712
6938
  /**
6939
+ * @beta
6713
6940
  * Contains information related to a chargeable item has
6714
6941
  * finished an items use cycle, or when the player has released
6715
6942
  * the use action with the item.
@@ -6731,6 +6958,7 @@ export class ItemStopChargeEvent {
6731
6958
  readonly useDuration: number;
6732
6959
  }
6733
6960
  /**
6961
+ * @beta
6734
6962
  * Manages callbacks that are connected to the stopping of
6735
6963
  * charging for an item that has a registered
6736
6964
  * minecraft:chargeable component.
@@ -6754,6 +6982,7 @@ export class ItemStopChargeEventSignal {
6754
6982
  unsubscribe(callback: (arg: ItemStopChargeEvent) => void): void;
6755
6983
  }
6756
6984
  /**
6985
+ * @beta
6757
6986
  * Contains information related to an item that has stopped
6758
6987
  * being used on a block.
6759
6988
  */
@@ -6773,6 +7002,7 @@ export class ItemStopUseOnEvent {
6773
7002
  readonly source: Entity;
6774
7003
  }
6775
7004
  /**
7005
+ * @beta
6776
7006
  * Manages callbacks that are connected to an item stops used
6777
7007
  * on a block event.
6778
7008
  */
@@ -6795,6 +7025,7 @@ export class ItemStopUseOnEventSignal {
6795
7025
  unsubscribe(callback: (arg: ItemStopUseOnEvent) => void): void;
6796
7026
  }
6797
7027
  /**
7028
+ * @beta
6798
7029
  * Represents the type of an item - for example, Wool.
6799
7030
  */
6800
7031
  export class ItemType {
@@ -6806,6 +7037,7 @@ export class ItemType {
6806
7037
  readonly id: string;
6807
7038
  }
6808
7039
  /**
7040
+ * @beta
6809
7041
  * An iterator over a set of available item types.
6810
7042
  */
6811
7043
  export class ItemTypeIterator implements Iterable<ItemType> {
@@ -6814,6 +7046,7 @@ export class ItemTypeIterator implements Iterable<ItemType> {
6814
7046
  next(): IteratorResult<ItemType>;
6815
7047
  }
6816
7048
  /**
7049
+ * @beta
6817
7050
  * Returns the set of item types registered within Minecraft.
6818
7051
  */
6819
7052
  // tslint:disable-next-line:no-unnecessary-class
@@ -6833,6 +7066,7 @@ export class ItemTypes {
6833
7066
  static getAll(): ItemTypeIterator;
6834
7067
  }
6835
7068
  /**
7069
+ * @beta
6836
7070
  * Contains information related to an item being used.
6837
7071
  */
6838
7072
  export class ItemUseEvent {
@@ -6847,6 +7081,7 @@ export class ItemUseEvent {
6847
7081
  readonly source: Entity;
6848
7082
  }
6849
7083
  /**
7084
+ * @beta
6850
7085
  * Manages callbacks that are connected to an item use event.
6851
7086
  */
6852
7087
  export class ItemUseEventSignal {
@@ -6866,6 +7101,7 @@ export class ItemUseEventSignal {
6866
7101
  unsubscribe(callback: (arg: ItemUseEvent) => void): void;
6867
7102
  }
6868
7103
  /**
7104
+ * @beta
6869
7105
  * Contains information related to an item being used on a
6870
7106
  * block.
6871
7107
  */
@@ -6899,6 +7135,7 @@ export class ItemUseOnEvent {
6899
7135
  readonly source: Entity;
6900
7136
  }
6901
7137
  /**
7138
+ * @beta
6902
7139
  * Manages callbacks that are connected to an item being used
6903
7140
  * on a block event.
6904
7141
  */
@@ -6921,6 +7158,7 @@ export class ItemUseOnEventSignal {
6921
7158
  unsubscribe(callback: (arg: ItemUseOnEvent) => void): void;
6922
7159
  }
6923
7160
  /**
7161
+ * @beta
6924
7162
  * Contains information related to changes to a lever
6925
7163
  * activating or deactivating.
6926
7164
  */
@@ -6946,6 +7184,7 @@ export class LeverActionEvent extends BlockEvent {
6946
7184
  readonly player: Player;
6947
7185
  }
6948
7186
  /**
7187
+ * @beta
6949
7188
  * Manages callbacks that are connected to lever moves
6950
7189
  * (activates or deactivates).
6951
7190
  */
@@ -6968,6 +7207,7 @@ export class LeverActionEventSignal {
6968
7207
  unsubscribe(callback: (arg: LeverActionEvent) => void): void;
6969
7208
  }
6970
7209
  /**
7210
+ * @beta
6971
7211
  * Contains a location description that is useful for entities
6972
7212
  * and other items. X, Y, and Z can contain decimal fractions.
6973
7213
  * For integer-based locations useful for blocks, see {@link
@@ -7022,6 +7262,7 @@ export class Location {
7022
7262
  isNear(other: Location, epsilon: number): boolean;
7023
7263
  }
7024
7264
  /**
7265
+ * @beta
7025
7266
  * A specific currently-internal event used for passing
7026
7267
  * messages from client to server.
7027
7268
  */
@@ -7033,6 +7274,7 @@ export class MessageReceiveEvent {
7033
7274
  readonly sourceType: MessageSourceType;
7034
7275
  }
7035
7276
  /**
7277
+ * @beta
7036
7278
  * Contains definitions of standard Minecraft and Minecraft
7037
7279
  * Education Edition block types.
7038
7280
  */
@@ -10152,6 +10394,7 @@ export class MinecraftDimensionTypes {
10152
10394
  static readonly theEnd = 'minecraft:the_end';
10153
10395
  }
10154
10396
  /**
10397
+ * @beta
10155
10398
  * Returns available installed effect types within Minecraft.
10156
10399
  */
10157
10400
  // tslint:disable-next-line:no-unnecessary-class
@@ -10348,6 +10591,7 @@ export class MinecraftEntityTypes {
10348
10591
  static readonly zombieVillagerV2: EntityType;
10349
10592
  }
10350
10593
  /**
10594
+ * @beta
10351
10595
  * Contains definitions of standard Minecraft and Minecraft
10352
10596
  * Education Edition block types.
10353
10597
  */
@@ -12991,6 +13235,7 @@ export class MinecraftItemTypes {
12991
13235
  static readonly zombieVillagerSpawnEgg: ItemType;
12992
13236
  }
12993
13237
  /**
13238
+ * @beta
12994
13239
  * Contains a set of additional variable values for further
12995
13240
  * defining how rendering and animations function.
12996
13241
  */
@@ -13030,6 +13275,7 @@ export class MolangVariableMap {
13030
13275
  setVector3(variableName: string, vector: Vector): MolangVariableMap;
13031
13276
  }
13032
13277
  /**
13278
+ * @beta
13033
13279
  * Contains data resulting from a navigation operation,
13034
13280
  * including whether the navigation is possible and the path of
13035
13281
  * navigation.
@@ -13047,6 +13293,7 @@ export class NavigationResult {
13047
13293
  readonly path: BlockLocation[];
13048
13294
  }
13049
13295
  /**
13296
+ * @beta
13050
13297
  * Represents a min/max structure for expressing a potential
13051
13298
  * range of numbers.
13052
13299
  */
@@ -13068,6 +13315,7 @@ export class NumberRange {
13068
13315
  next(): number;
13069
13316
  }
13070
13317
  /**
13318
+ * @beta
13071
13319
  * Contains information related to changes to a piston
13072
13320
  * expanding or retracting.
13073
13321
  */
@@ -13092,6 +13340,7 @@ export class PistonActivateEvent extends BlockEvent {
13092
13340
  readonly piston: BlockPistonComponent;
13093
13341
  }
13094
13342
  /**
13343
+ * @beta
13095
13344
  * Manages callbacks that are connected to piston activations.
13096
13345
  */
13097
13346
  export class PistonActivateEventSignal {
@@ -13136,11 +13385,13 @@ export class PistonActivateEventSignal {
13136
13385
  export class Player extends Entity {
13137
13386
  protected constructor();
13138
13387
  /**
13388
+ * @beta
13139
13389
  * Dimension that the entity is currently within.
13140
13390
  * @throws This property can throw when used.
13141
13391
  */
13142
13392
  readonly dimension: Dimension;
13143
13393
  /**
13394
+ * @beta
13144
13395
  * Location of the center of the head component of the player.
13145
13396
  * @throws This property can throw when used.
13146
13397
  */
@@ -13154,10 +13405,13 @@ export class Player extends Entity {
13154
13405
  */
13155
13406
  readonly id: string;
13156
13407
  /**
13408
+ * @beta
13157
13409
  * True if the player is currently using a sneaking movement.
13158
13410
  */
13159
13411
  isSneaking: boolean;
13412
+ readonly level: number;
13160
13413
  /**
13414
+ * @beta
13161
13415
  * Current location of the player.
13162
13416
  * @throws This property can throw when used.
13163
13417
  */
@@ -13168,29 +13422,35 @@ export class Player extends Entity {
13168
13422
  */
13169
13423
  readonly name: string;
13170
13424
  /**
13425
+ * @beta
13171
13426
  * Optional name tag of the player.
13172
13427
  */
13173
13428
  nameTag: string;
13174
13429
  /**
13430
+ * @beta
13175
13431
  * Contains methods for manipulating the on-screen display of a
13176
13432
  * Player.
13177
13433
  */
13178
13434
  readonly onScreenDisplay: ScreenDisplay;
13179
13435
  /**
13436
+ * @beta
13180
13437
  * Main rotation of the entity.
13181
13438
  * @throws This property can throw when used.
13182
13439
  */
13183
13440
  readonly rotation: XYRotation;
13184
13441
  /**
13442
+ * @beta
13185
13443
  * Returns a scoreboard identity that represents this entity.
13186
13444
  * @throws This property can throw when used.
13187
13445
  */
13188
13446
  readonly scoreboard: ScoreboardIdentity;
13189
13447
  /**
13448
+ * @beta
13190
13449
  * Manages the selected slot in the player's hotbar.
13191
13450
  */
13192
13451
  selectedSlot: number;
13193
13452
  /**
13453
+ * @beta
13194
13454
  * Retrieves or sets an entity that is used as the target of
13195
13455
  * AI-related behaviors, like attacking. For players, which
13196
13456
  * don't use any AI semantics, this property does not do
@@ -13198,6 +13458,7 @@ export class Player extends Entity {
13198
13458
  * @throws This property can throw when used.
13199
13459
  */
13200
13460
  readonly target: Entity;
13461
+ readonly totalXpNeededForNextLevel: number;
13201
13462
  /**
13202
13463
  * Unique identifier of the type of the entity - for example,
13203
13464
  * 'minecraft:player'.
@@ -13205,16 +13466,20 @@ export class Player extends Entity {
13205
13466
  */
13206
13467
  readonly typeId: string;
13207
13468
  /**
13469
+ * @beta
13208
13470
  * Current speed of the player across X, Y, and Z dimensions.
13209
13471
  * @throws This property can throw when used.
13210
13472
  */
13211
13473
  readonly velocity: Vector;
13212
13474
  /**
13475
+ * @beta
13213
13476
  * Direction that the player is looking, from their head.
13214
13477
  * @throws This property can throw when used.
13215
13478
  */
13216
13479
  readonly viewDirection: Vector3;
13480
+ readonly xpEarnedAtCurrentLevel: number;
13217
13481
  /**
13482
+ * @beta
13218
13483
  * @remarks
13219
13484
  * Adds an effect, like poison, to the entity.
13220
13485
  * @param effectType
@@ -13227,7 +13492,10 @@ export class Player extends Entity {
13227
13492
  * @throws This function can throw errors.
13228
13493
  */
13229
13494
  addEffect(effectType: EffectType, duration: number, amplifier?: number, showParticles?: boolean): void;
13495
+ addExperience(amount: number): number;
13496
+ addLevels(amount: number): number;
13230
13497
  /**
13498
+ * @beta
13231
13499
  * @remarks
13232
13500
  * Adds a specified tag to an entity.
13233
13501
  * @param tag
@@ -13235,8 +13503,10 @@ export class Player extends Entity {
13235
13503
  * @throws This function can throw errors.
13236
13504
  */
13237
13505
  addTag(tag: string): boolean;
13506
+ applyDamage(amount: number, source?: EntityDamageSource): boolean;
13238
13507
  extinguishFire(useEffects?: boolean): boolean;
13239
13508
  /**
13509
+ * @beta
13240
13510
  * @remarks
13241
13511
  * Returns the first intersecting block from the direction that
13242
13512
  * this player is looking at.
@@ -13245,6 +13515,7 @@ export class Player extends Entity {
13245
13515
  */
13246
13516
  getBlockFromViewDirection(options?: BlockRaycastOptions): Block;
13247
13517
  /**
13518
+ * @beta
13248
13519
  * @remarks
13249
13520
  * Gets a component (that represents additional capabilities)
13250
13521
  * for an entity.
@@ -13256,12 +13527,14 @@ export class Player extends Entity {
13256
13527
  */
13257
13528
  getComponent(componentId: string): IEntityComponent;
13258
13529
  /**
13530
+ * @beta
13259
13531
  * @remarks
13260
13532
  * Returns all components that are both present on this entity
13261
13533
  * and supported by the API.
13262
13534
  */
13263
13535
  getComponents(): IEntityComponent[];
13264
13536
  /**
13537
+ * @beta
13265
13538
  * @remarks
13266
13539
  * Returns a property value.
13267
13540
  * @param identifier
@@ -13270,8 +13543,9 @@ export class Player extends Entity {
13270
13543
  * property has not been set.
13271
13544
  * @throws This function can throw errors.
13272
13545
  */
13273
- getDynamicProperty(identifier: string): boolean | number | string;
13546
+ getDynamicProperty(identifier: string): boolean | number | string | undefined;
13274
13547
  /**
13548
+ * @beta
13275
13549
  * @remarks
13276
13550
  * Returns the effect for the specified EffectType on the
13277
13551
  * entity, or undefined if the effect is not present.
@@ -13282,7 +13556,9 @@ export class Player extends Entity {
13282
13556
  * @throws This function can throw errors.
13283
13557
  */
13284
13558
  getEffect(effectType: EffectType): Effect;
13559
+ getEffects(): Effect[];
13285
13560
  /**
13561
+ * @beta
13286
13562
  * @remarks
13287
13563
  * Returns a potential set of entities from the direction that
13288
13564
  * this player is looking at.
@@ -13291,6 +13567,7 @@ export class Player extends Entity {
13291
13567
  */
13292
13568
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): Entity[];
13293
13569
  /**
13570
+ * @beta
13294
13571
  * @remarks
13295
13572
  * Gets the current item cooldown time for a particular
13296
13573
  * cooldown category.
@@ -13301,12 +13578,15 @@ export class Player extends Entity {
13301
13578
  */
13302
13579
  getItemCooldown(itemCategory: string): number;
13303
13580
  /**
13581
+ * @beta
13304
13582
  * @remarks
13305
13583
  * Returns all tags associated with an entity.
13306
13584
  * @throws This function can throw errors.
13307
13585
  */
13308
13586
  getTags(): string[];
13587
+ getTotalXp(): number;
13309
13588
  /**
13589
+ * @beta
13310
13590
  * @remarks
13311
13591
  * Returns true if the specified component is present on this
13312
13592
  * entity.
@@ -13317,6 +13597,7 @@ export class Player extends Entity {
13317
13597
  */
13318
13598
  hasComponent(componentId: string): boolean;
13319
13599
  /**
13600
+ * @beta
13320
13601
  * @remarks
13321
13602
  * Tests whether an entity has a particular tag.
13322
13603
  * @param tag
@@ -13325,18 +13606,21 @@ export class Player extends Entity {
13325
13606
  */
13326
13607
  hasTag(tag: string): boolean;
13327
13608
  /**
13609
+ * @beta
13328
13610
  * @remarks
13329
13611
  * Returns true if this player has operator-level permissions.
13330
13612
  * @throws This function can throw errors.
13331
13613
  */
13332
13614
  isOp(): boolean;
13333
13615
  /**
13616
+ * @beta
13334
13617
  * @remarks
13335
13618
  * Kills this entity. The entity will drop loot as normal.
13336
13619
  * @throws This function can throw errors.
13337
13620
  */
13338
13621
  kill(): void;
13339
13622
  /**
13623
+ * @beta
13340
13624
  * @remarks
13341
13625
  * Plays a sound that only this particular player can hear.
13342
13626
  * @param soundID
@@ -13347,6 +13631,7 @@ export class Player extends Entity {
13347
13631
  */
13348
13632
  playSound(soundID: string, soundOptions?: SoundOptions): void;
13349
13633
  /**
13634
+ * @beta
13350
13635
  * @remarks
13351
13636
  * This is an internal-facing method for posting a system
13352
13637
  * message to downstream clients.
@@ -13356,6 +13641,7 @@ export class Player extends Entity {
13356
13641
  */
13357
13642
  postClientMessage(id: string, value: string): void;
13358
13643
  /**
13644
+ * @beta
13359
13645
  * @remarks
13360
13646
  * Removes a specified property.
13361
13647
  * @param identifier
@@ -13363,6 +13649,7 @@ export class Player extends Entity {
13363
13649
  */
13364
13650
  removeDynamicProperty(identifier: string): boolean;
13365
13651
  /**
13652
+ * @beta
13366
13653
  * @remarks
13367
13654
  * Removes a specified tag from an entity.
13368
13655
  * @param tag
@@ -13370,6 +13657,7 @@ export class Player extends Entity {
13370
13657
  * @throws This function can throw errors.
13371
13658
  */
13372
13659
  removeTag(tag: string): boolean;
13660
+ resetLevel(): void;
13373
13661
  /**
13374
13662
  * @remarks
13375
13663
  * Runs a particular command asynchronously from the context of
@@ -13385,6 +13673,7 @@ export class Player extends Entity {
13385
13673
  */
13386
13674
  runCommandAsync(commandString: string): Promise<CommandResult>;
13387
13675
  /**
13676
+ * @beta
13388
13677
  * @remarks
13389
13678
  * Sets a specified property to a value.
13390
13679
  * @param identifier
@@ -13395,6 +13684,7 @@ export class Player extends Entity {
13395
13684
  setDynamicProperty(identifier: string, value: boolean | number | string): void;
13396
13685
  setOnFire(seconds: number, useEffects?: boolean): boolean;
13397
13686
  /**
13687
+ * @beta
13398
13688
  * @remarks
13399
13689
  * Will change the specified players permissions, and whether
13400
13690
  * they are operator or not.
@@ -13403,6 +13693,7 @@ export class Player extends Entity {
13403
13693
  */
13404
13694
  setOp(isOp: boolean): void;
13405
13695
  /**
13696
+ * @beta
13406
13697
  * @remarks
13407
13698
  * Sets the main rotation of the entity.
13408
13699
  * @param degreesX
@@ -13411,6 +13702,7 @@ export class Player extends Entity {
13411
13702
  */
13412
13703
  setRotation(degreesX: number, degreesY: number): void;
13413
13704
  /**
13705
+ * @beta
13414
13706
  * @remarks
13415
13707
  * Sets a velocity for the entity to move with.
13416
13708
  * @param velocity
@@ -13419,6 +13711,7 @@ export class Player extends Entity {
13419
13711
  */
13420
13712
  setVelocity(velocity: Vector3): void;
13421
13713
  /**
13714
+ * @beta
13422
13715
  * @remarks
13423
13716
  * Sets the item cooldown time for a particular cooldown
13424
13717
  * category.
@@ -13431,6 +13724,7 @@ export class Player extends Entity {
13431
13724
  */
13432
13725
  startItemCooldown(itemCategory: string, tickDuration: number): void;
13433
13726
  /**
13727
+ * @beta
13434
13728
  * @remarks
13435
13729
  * Teleports the selected player to a new location
13436
13730
  * @param location
@@ -13452,6 +13746,7 @@ export class Player extends Entity {
13452
13746
  keepVelocity?: boolean,
13453
13747
  ): void;
13454
13748
  /**
13749
+ * @beta
13455
13750
  * @remarks
13456
13751
  * Teleports the selected player to a new location, and will
13457
13752
  * have the player facing a specified location.
@@ -13466,6 +13761,7 @@ export class Player extends Entity {
13466
13761
  */
13467
13762
  teleportFacing(location: Vector3, dimension: Dimension, facingLocation: Vector3, keepVelocity?: boolean): void;
13468
13763
  /**
13764
+ * @beta
13469
13765
  * @remarks
13470
13766
  * Sends a message that is displayed on the connected client
13471
13767
  * for this player.
@@ -13474,6 +13770,7 @@ export class Player extends Entity {
13474
13770
  */
13475
13771
  tell(message: RawMessage | string): void;
13476
13772
  /**
13773
+ * @beta
13477
13774
  * @remarks
13478
13775
  * Triggers an entity type event. For every entity, a number of
13479
13776
  * events are defined in an entities' definition for key entity
@@ -13487,6 +13784,7 @@ export class Player extends Entity {
13487
13784
  triggerEvent(eventName: string): void;
13488
13785
  }
13489
13786
  /**
13787
+ * @beta
13490
13788
  * Represents the inventory of a {@link Player} in the world.
13491
13789
  */
13492
13790
  export class PlayerInventoryComponentContainer extends InventoryComponentContainer {
@@ -13582,6 +13880,7 @@ export class PlayerInventoryComponentContainer extends InventoryComponentContain
13582
13880
  transferItem(fromSlot: number, toSlot: number, toContainer: Container): boolean;
13583
13881
  }
13584
13882
  /**
13883
+ * @beta
13585
13884
  * This type is usable for iterating over a set of players.
13586
13885
  * This means it can be used in statements like for...of
13587
13886
  * statements, Array.from(iterator), and more.
@@ -13598,6 +13897,7 @@ export class PlayerIterator implements Iterable<Player> {
13598
13897
  next(): IteratorResult<Player>;
13599
13898
  }
13600
13899
  /**
13900
+ * @beta
13601
13901
  * Contains information regarding a player that has joined.
13602
13902
  * See the playerSpawn event for more detailed information that
13603
13903
  * could be returned after the first time a player has spawned
@@ -13615,6 +13915,7 @@ export class PlayerJoinEvent {
13615
13915
  readonly playerName: string;
13616
13916
  }
13617
13917
  /**
13918
+ * @beta
13618
13919
  * Manages callbacks that are connected to a player joining the
13619
13920
  * world.
13620
13921
  */
@@ -13637,6 +13938,7 @@ export class PlayerJoinEventSignal {
13637
13938
  unsubscribe(callback: (arg: PlayerJoinEvent) => void): void;
13638
13939
  }
13639
13940
  /**
13941
+ * @beta
13640
13942
  * Contains information regarding a player that has left the
13641
13943
  * world.
13642
13944
  */
@@ -13653,6 +13955,7 @@ export class PlayerLeaveEvent {
13653
13955
  readonly playerName: string;
13654
13956
  }
13655
13957
  /**
13958
+ * @beta
13656
13959
  * Manages callbacks that are connected to a player leaving the
13657
13960
  * world.
13658
13961
  */
@@ -13675,6 +13978,7 @@ export class PlayerLeaveEventSignal {
13675
13978
  unsubscribe(callback: (arg: PlayerLeaveEvent) => void): void;
13676
13979
  }
13677
13980
  /**
13981
+ * @beta
13678
13982
  * An event that contains more information about a player
13679
13983
  * spawning.
13680
13984
  */
@@ -13691,6 +13995,7 @@ export class PlayerSpawnEvent {
13691
13995
  player: Player;
13692
13996
  }
13693
13997
  /**
13998
+ * @beta
13694
13999
  * Registers an event when a player is spawned (or re-spawned
13695
14000
  * after death) and fully ready within the world.
13696
14001
  */
@@ -13712,6 +14017,7 @@ export class PlayerSpawnEventSignal {
13712
14017
  unsubscribe(callback: (arg: PlayerSpawnEvent) => void): void;
13713
14018
  }
13714
14019
  /**
14020
+ * @beta
13715
14021
  * Contains information related to a projectile hitting an
13716
14022
  * entity or block.
13717
14023
  */
@@ -13749,6 +14055,7 @@ export class ProjectileHitEvent {
13749
14055
  readonly source: Entity;
13750
14056
  }
13751
14057
  /**
14058
+ * @beta
13752
14059
  * Manages callbacks that are connected to when a projectile
13753
14060
  * hits an entity or block.
13754
14061
  */
@@ -13771,6 +14078,7 @@ export class ProjectileHitEventSignal {
13771
14078
  unsubscribe(callback: (arg: ProjectileHitEvent) => void): void;
13772
14079
  }
13773
14080
  /**
14081
+ * @beta
13774
14082
  * Provides methods that should be used within the World
13775
14083
  * Initialize event to register dynamic properties that can be
13776
14084
  * used and stored within Minecraft.
@@ -13798,6 +14106,7 @@ export class PropertyRegistry {
13798
14106
  registerWorldDynamicProperties(propertiesDefinition: DynamicPropertiesDefinition): void;
13799
14107
  }
13800
14108
  /**
14109
+ * @beta
13801
14110
  * Contains objectives and participants for the scoreboard.
13802
14111
  */
13803
14112
  export class Scoreboard {
@@ -13865,6 +14174,7 @@ export class Scoreboard {
13865
14174
  ): ScoreboardObjective;
13866
14175
  }
13867
14176
  /**
14177
+ * @beta
13868
14178
  * Contains an identity of the scoreboard item.
13869
14179
  */
13870
14180
  export class ScoreboardIdentity {
@@ -13890,6 +14200,7 @@ export class ScoreboardIdentity {
13890
14200
  getEntity(): Entity;
13891
14201
  }
13892
14202
  /**
14203
+ * @beta
13893
14204
  * Contains objectives and participants for the scoreboard.
13894
14205
  */
13895
14206
  export class ScoreboardObjective {
@@ -13927,6 +14238,7 @@ export class ScoreboardObjective {
13927
14238
  getScores(): ScoreboardScoreInfo[];
13928
14239
  }
13929
14240
  /**
14241
+ * @beta
13930
14242
  * Contains a pair of a scoreboard participant and its
13931
14243
  * respective score.
13932
14244
  */
@@ -13942,6 +14254,7 @@ export class ScoreboardScoreInfo {
13942
14254
  readonly score: number;
13943
14255
  }
13944
14256
  /**
14257
+ * @beta
13945
14258
  * Contains information about user interface elements that are
13946
14259
  * showing up on the screen.
13947
14260
  */
@@ -13990,6 +14303,7 @@ export class ScriptEventCommandMessageEvent {
13990
14303
  readonly sourceType: MessageSourceType;
13991
14304
  }
13992
14305
  /**
14306
+ * @beta
13993
14307
  * Allows for registering an event handler that responds to
13994
14308
  * inbound /scriptevent commands.
13995
14309
  */
@@ -14014,6 +14328,7 @@ export class ScriptEventCommandMessageSignal {
14014
14328
  unsubscribe(callback: (arg: ScriptEventCommandMessageEvent) => void): void;
14015
14329
  }
14016
14330
  /**
14331
+ * @beta
14017
14332
  * Describes a particular seating position on this rideable
14018
14333
  * entity.
14019
14334
  */
@@ -14040,6 +14355,7 @@ export class Seat {
14040
14355
  readonly position: Location;
14041
14356
  }
14042
14357
  /**
14358
+ * @beta
14043
14359
  * Manages callbacks that are message passing to a server. This
14044
14360
  * event is not currently fully implemented, and should not be
14045
14361
  * used.
@@ -14063,6 +14379,7 @@ export class ServerMessageSignal {
14063
14379
  unsubscribe(callback: (arg: MessageReceiveEvent) => void): void;
14064
14380
  }
14065
14381
  /**
14382
+ * @beta
14066
14383
  * Contains the state of a string-based property for a {@link
14067
14384
  * BlockPermutation}.
14068
14385
  */
@@ -14091,15 +14408,18 @@ export class StringBlockProperty extends IBlockProperty {
14091
14408
  export class System {
14092
14409
  protected constructor();
14093
14410
  /**
14411
+ * @beta
14094
14412
  * Represents the current world tick of the server.
14095
14413
  */
14096
14414
  readonly currentTick: number;
14097
14415
  /**
14416
+ * @beta
14098
14417
  * Contains a set of events that are applicable for the
14099
14418
  * lifecycle of items in the Minecraft system.
14100
14419
  */
14101
14420
  readonly events: SystemEvents;
14102
14421
  /**
14422
+ * @beta
14103
14423
  * @remarks
14104
14424
  * Cancels the execution of a function run that was previously
14105
14425
  * scheduled via the `run` function.
@@ -14107,6 +14427,7 @@ export class System {
14107
14427
  */
14108
14428
  clearRun(runId: number): void;
14109
14429
  /**
14430
+ * @beta
14110
14431
  * @remarks
14111
14432
  * Cancels the execution of a scheduled function run that was
14112
14433
  * previously scheduled via the `runSchedule` function.
@@ -14127,6 +14448,7 @@ export class System {
14127
14448
  */
14128
14449
  run(callback: () => void): number;
14129
14450
  /**
14451
+ * @beta
14130
14452
  * @remarks
14131
14453
  * Runs a specified function at a scheduled interval. This is
14132
14454
  * frequently used to implement delayed behaviors and game
@@ -14144,6 +14466,7 @@ export class System {
14144
14466
  runSchedule(callback: () => void, tickInterval?: number): number;
14145
14467
  }
14146
14468
  /**
14469
+ * @beta
14147
14470
  * Contains a set of events that are available across the scope
14148
14471
  * of the Minecraft add-on system.
14149
14472
  */
@@ -14165,6 +14488,7 @@ export class SystemEvents {
14165
14488
  readonly scriptEventReceive: ScriptEventCommandMessageSignal;
14166
14489
  }
14167
14490
  /**
14491
+ * @beta
14168
14492
  * An event for handling updates, that fires 20 times every
14169
14493
  * second.
14170
14494
  */
@@ -14180,6 +14504,7 @@ export class TickEvent {
14180
14504
  readonly deltaTime: number;
14181
14505
  }
14182
14506
  /**
14507
+ * @beta
14183
14508
  * Manages callbacks that are connected to a tick event.
14184
14509
  */
14185
14510
  export class TickEventSignal {
@@ -14199,6 +14524,7 @@ export class TickEventSignal {
14199
14524
  unsubscribe(callback: (arg: TickEvent) => void): void;
14200
14525
  }
14201
14526
  /**
14527
+ * @beta
14202
14528
  * Represents a trigger for firing an event.
14203
14529
  */
14204
14530
  export class Trigger {
@@ -14209,6 +14535,7 @@ export class Trigger {
14209
14535
  constructor(eventName: string);
14210
14536
  }
14211
14537
  /**
14538
+ * @beta
14212
14539
  * Contains a description of a vector.
14213
14540
  */
14214
14541
  export class Vector {
@@ -14369,6 +14696,7 @@ export class Vector {
14369
14696
  static subtract(a: Vector3, b: Vector3): Vector;
14370
14697
  }
14371
14698
  /**
14699
+ * @beta
14372
14700
  * Contains information related to changes in weather in the
14373
14701
  * environment.
14374
14702
  */
@@ -14388,6 +14716,7 @@ export class WeatherChangeEvent {
14388
14716
  readonly raining: boolean;
14389
14717
  }
14390
14718
  /**
14719
+ * @beta
14391
14720
  * Manages callbacks that are connected to weather changing.
14392
14721
  */
14393
14722
  export class WeatherChangeEventSignal {
@@ -14413,16 +14742,19 @@ export class WeatherChangeEventSignal {
14413
14742
  export class World {
14414
14743
  protected constructor();
14415
14744
  /**
14745
+ * @beta
14416
14746
  * Contains a set of events that are applicable to the entirety
14417
14747
  * of the world.
14418
14748
  */
14419
14749
  readonly events: Events;
14420
14750
  /**
14751
+ * @beta
14421
14752
  * Returns the general global scoreboard that applies to the
14422
14753
  * world.
14423
14754
  */
14424
14755
  readonly scoreboard: Scoreboard;
14425
14756
  /**
14757
+ * @beta
14426
14758
  * @remarks
14427
14759
  * A method that is internal-only, used for broadcasting
14428
14760
  * specific messages between client and server.
@@ -14431,6 +14763,7 @@ export class World {
14431
14763
  */
14432
14764
  broadcastClientMessage(id: string, value: string): void;
14433
14765
  /**
14766
+ * @beta
14434
14767
  * @remarks
14435
14768
  * Returns the absolute time since the start of the world.
14436
14769
  */
@@ -14452,6 +14785,7 @@ export class World {
14452
14785
  */
14453
14786
  getDimension(dimensionId: string): Dimension;
14454
14787
  /**
14788
+ * @beta
14455
14789
  * @remarks
14456
14790
  * Returns a property value.
14457
14791
  * @param identifier
@@ -14460,8 +14794,9 @@ export class World {
14460
14794
  * property has not been set.
14461
14795
  * @throws This function can throw errors.
14462
14796
  */
14463
- getDynamicProperty(identifier: string): boolean | number | string;
14797
+ getDynamicProperty(identifier: string): boolean | number | string | undefined;
14464
14798
  /**
14799
+ * @beta
14465
14800
  * @remarks
14466
14801
  * Returns all players currently in the world.
14467
14802
  * @param options
@@ -14471,11 +14806,13 @@ export class World {
14471
14806
  */
14472
14807
  getPlayers(options?: EntityQueryOptions): PlayerIterator;
14473
14808
  /**
14809
+ * @beta
14474
14810
  * @remarks
14475
14811
  * Sets the current game time of the day.
14476
14812
  */
14477
14813
  getTime(): number;
14478
14814
  /**
14815
+ * @beta
14479
14816
  * @remarks
14480
14817
  * Plays a particular music track for all players.
14481
14818
  * @param trackID
@@ -14483,6 +14820,7 @@ export class World {
14483
14820
  */
14484
14821
  playMusic(trackID: string, musicOptions?: MusicOptions): void;
14485
14822
  /**
14823
+ * @beta
14486
14824
  * @remarks
14487
14825
  * Plays a sound for all players.
14488
14826
  * @param soundID
@@ -14490,6 +14828,7 @@ export class World {
14490
14828
  */
14491
14829
  playSound(soundID: string, soundOptions?: SoundOptions): void;
14492
14830
  /**
14831
+ * @beta
14493
14832
  * @remarks
14494
14833
  * Queues an additional music track for players. If a track is
14495
14834
  * not playing, a music track will play.
@@ -14498,6 +14837,7 @@ export class World {
14498
14837
  */
14499
14838
  queueMusic(trackID: string, musicOptions?: MusicOptions): void;
14500
14839
  /**
14840
+ * @beta
14501
14841
  * @remarks
14502
14842
  * Removes a specified property.
14503
14843
  * @param identifier
@@ -14505,6 +14845,7 @@ export class World {
14505
14845
  */
14506
14846
  removeDynamicProperty(identifier: string): boolean;
14507
14847
  /**
14848
+ * @beta
14508
14849
  * @remarks
14509
14850
  * Broadcasts a message that is displayed on all connected
14510
14851
  * clients.
@@ -14513,6 +14854,7 @@ export class World {
14513
14854
  */
14514
14855
  say(message: RawMessage | string): void;
14515
14856
  /**
14857
+ * @beta
14516
14858
  * @remarks
14517
14859
  * Sets a specified property to a value.
14518
14860
  * @param identifier
@@ -14522,18 +14864,21 @@ export class World {
14522
14864
  */
14523
14865
  setDynamicProperty(identifier: string, value: boolean | number | string): void;
14524
14866
  /**
14867
+ * @beta
14525
14868
  * @remarks
14526
14869
  * Returns the current game time of the day.
14527
14870
  * @param timeOfDay
14528
14871
  */
14529
14872
  setTime(timeOfDay: number): void;
14530
14873
  /**
14874
+ * @beta
14531
14875
  * @remarks
14532
14876
  * Stops any music tracks from playing.
14533
14877
  */
14534
14878
  stopMusic(): void;
14535
14879
  }
14536
14880
  /**
14881
+ * @beta
14537
14882
  * Contains information and methods that can be used at the
14538
14883
  * initialization of the scripting environment for a World.
14539
14884
  * Also, use the supplied propertyRegistry object to register
@@ -14564,6 +14909,7 @@ export class WorldInitializeEvent {
14564
14909
  readonly propertyRegistry: PropertyRegistry;
14565
14910
  }
14566
14911
  /**
14912
+ * @beta
14567
14913
  * Manages callbacks that are run at the initialization of the
14568
14914
  * scripting environment for a World. Do note that this event
14569
14915
  * may run multiple times within a session in the case that the
@@ -14588,6 +14934,7 @@ export class WorldInitializeEventSignal {
14588
14934
  unsubscribe(callback: (arg: WorldInitializeEvent) => void): void;
14589
14935
  }
14590
14936
  /**
14937
+ * @beta
14591
14938
  * Represents a rotation structure with pitch and yaw
14592
14939
  * components.
14593
14940
  */
@@ -14602,7 +14949,11 @@ export class XYRotation {
14602
14949
  */
14603
14950
  y: number;
14604
14951
  }
14952
+ export interface BlockFillOptions {
14953
+ matchingBlock?: BlockPermutation;
14954
+ }
14605
14955
  /**
14956
+ * @beta
14606
14957
  * Contains additional options for configuring a block raycast
14607
14958
  * query.
14608
14959
  */
@@ -14622,7 +14973,13 @@ export interface BlockRaycastOptions {
14622
14973
  */
14623
14974
  maxDistance?: number;
14624
14975
  }
14976
+ export interface EntityDamageSource {
14977
+ cause: EntityDamageCause;
14978
+ damagingEntity?: Entity;
14979
+ damagingProjectile?: Entity;
14980
+ }
14625
14981
  /**
14982
+ * @beta
14626
14983
  * Specifies additional filters that are used in registering a
14627
14984
  * data driven trigger event for entities.
14628
14985
  */
@@ -14645,6 +15002,7 @@ export interface EntityDataDrivenTriggerEventOptions {
14645
15002
  eventTypes?: string[];
14646
15003
  }
14647
15004
  /**
15005
+ * @beta
14648
15006
  * Contains optional parameters for registering an entity
14649
15007
  * event.
14650
15008
  */
@@ -14661,6 +15019,7 @@ export interface EntityEventOptions {
14661
15019
  entityTypes?: string[];
14662
15020
  }
14663
15021
  /**
15022
+ * @beta
14664
15023
  * Contains options for selecting entities within an area.
14665
15024
  */
14666
15025
  export interface EntityQueryOptions {
@@ -14783,6 +15142,7 @@ export interface EntityQueryOptions {
14783
15142
  volume?: BlockAreaSize;
14784
15143
  }
14785
15144
  /**
15145
+ * @beta
14786
15146
  * Contains additional options for filtering players based on
14787
15147
  * their score for an objective.
14788
15148
  */
@@ -14808,6 +15168,7 @@ export interface EntityQueryScoreOptions {
14808
15168
  objective?: string;
14809
15169
  }
14810
15170
  /**
15171
+ * @beta
14811
15172
  * Contains additional options for an entity raycast operation.
14812
15173
  */
14813
15174
  export interface EntityRaycastOptions {
@@ -14817,6 +15178,7 @@ export interface EntityRaycastOptions {
14817
15178
  maxDistance?: number;
14818
15179
  }
14819
15180
  /**
15181
+ * @beta
14820
15182
  * Additional configuration options for the {@link
14821
15183
  * Dimension.createExplosion} method.
14822
15184
  */
@@ -14841,6 +15203,7 @@ export interface ExplosionOptions {
14841
15203
  source?: Entity;
14842
15204
  }
14843
15205
  /**
15206
+ * @beta
14844
15207
  * Additional configuration options for {@link
14845
15208
  * World.playMusic}/{@link World.queueMusic} methods.
14846
15209
  */
@@ -14865,6 +15228,7 @@ export interface RawMessage {
14865
15228
  with?: (RawMessage | string)[];
14866
15229
  }
14867
15230
  /**
15231
+ * @beta
14868
15232
  * Contains additional options for how a scoreboard should be
14869
15233
  * displayed within its display slot.
14870
15234
  */
@@ -14882,6 +15246,7 @@ export interface ScriptEventMessageFilterOptions {
14882
15246
  namespaces: string[];
14883
15247
  }
14884
15248
  /**
15249
+ * @beta
14885
15250
  * Additional configuration options for the {@link
14886
15251
  * Player.playSound}/{@link World.playSound} method.
14887
15252
  */
@@ -14900,6 +15265,7 @@ export interface SoundOptions {
14900
15265
  volume?: number;
14901
15266
  }
14902
15267
  /**
15268
+ * @beta
14903
15269
  * Contains additional options for displaying a title and
14904
15270
  * optional subtitle.
14905
15271
  */
@@ -14922,6 +15288,7 @@ export interface TitleDisplayOptions {
14922
15288
  subtitle?: string;
14923
15289
  }
14924
15290
  /**
15291
+ * @beta
14925
15292
  * Contains a description of a vector.
14926
15293
  */
14927
15294
  export interface Vector3 {
@@ -14940,6 +15307,7 @@ export interface Vector3 {
14940
15307
  }
14941
15308
  export const TicksPerDay = 24000;
14942
15309
  /**
15310
+ * @beta
14943
15311
  * How many times the server ticks per second of real time.
14944
15312
  */
14945
15313
  export const TicksPerSecond = 20;