@minecraft/server 1.1.0-beta.1.19.60-preview.24 → 1.1.0-beta.1.19.60-preview.26

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 +401 -28
  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.24"
19
+ * "version": "1.1.0-internal.1.19.60-preview.26"
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.
@@ -3228,6 +3357,7 @@ export class Entity {
3228
3357
  getEffect(effectType: EffectType): Effect;
3229
3358
  getEffects(): Effect[];
3230
3359
  /**
3360
+ * @beta
3231
3361
  * @remarks
3232
3362
  * Returns a potential set of entities from the direction that
3233
3363
  * this entity is looking at.
@@ -3236,12 +3366,14 @@ export class Entity {
3236
3366
  */
3237
3367
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): Entity[];
3238
3368
  /**
3369
+ * @beta
3239
3370
  * @remarks
3240
3371
  * Returns all tags associated with an entity.
3241
3372
  * @throws This function can throw errors.
3242
3373
  */
3243
3374
  getTags(): string[];
3244
3375
  /**
3376
+ * @beta
3245
3377
  * @remarks
3246
3378
  * Returns true if the specified component is present on this
3247
3379
  * entity.
@@ -3252,6 +3384,7 @@ export class Entity {
3252
3384
  */
3253
3385
  hasComponent(componentId: string): boolean;
3254
3386
  /**
3387
+ * @beta
3255
3388
  * @remarks
3256
3389
  * Tests whether an entity has a particular tag.
3257
3390
  * @param tag
@@ -3260,12 +3393,14 @@ export class Entity {
3260
3393
  */
3261
3394
  hasTag(tag: string): boolean;
3262
3395
  /**
3396
+ * @beta
3263
3397
  * @remarks
3264
3398
  * Kills this entity. The entity will drop loot as normal.
3265
3399
  * @throws This function can throw errors.
3266
3400
  */
3267
3401
  kill(): void;
3268
3402
  /**
3403
+ * @beta
3269
3404
  * @remarks
3270
3405
  * Removes a specified property.
3271
3406
  * @param identifier
@@ -3273,6 +3408,7 @@ export class Entity {
3273
3408
  */
3274
3409
  removeDynamicProperty(identifier: string): boolean;
3275
3410
  /**
3411
+ * @beta
3276
3412
  * @remarks
3277
3413
  * Removes a specified tag from an entity.
3278
3414
  * @param tag
@@ -3295,6 +3431,7 @@ export class Entity {
3295
3431
  */
3296
3432
  runCommandAsync(commandString: string): Promise<CommandResult>;
3297
3433
  /**
3434
+ * @beta
3298
3435
  * @remarks
3299
3436
  * Sets a specified property to a value.
3300
3437
  * @param identifier
@@ -3305,6 +3442,7 @@ export class Entity {
3305
3442
  setDynamicProperty(identifier: string, value: boolean | number | string): void;
3306
3443
  setOnFire(seconds: number, useEffects?: boolean): boolean;
3307
3444
  /**
3445
+ * @beta
3308
3446
  * @remarks
3309
3447
  * Sets the main rotation of the entity.
3310
3448
  * @param degreesX
@@ -3313,6 +3451,7 @@ export class Entity {
3313
3451
  */
3314
3452
  setRotation(degreesX: number, degreesY: number): void;
3315
3453
  /**
3454
+ * @beta
3316
3455
  * @remarks
3317
3456
  * Sets a velocity for the entity to move with.
3318
3457
  * @param velocity
@@ -3321,6 +3460,7 @@ export class Entity {
3321
3460
  */
3322
3461
  setVelocity(velocity: Vector3): void;
3323
3462
  /**
3463
+ * @beta
3324
3464
  * @remarks
3325
3465
  * Teleports the selected entity to a new location
3326
3466
  * @param location
@@ -3342,6 +3482,7 @@ export class Entity {
3342
3482
  keepVelocity?: boolean,
3343
3483
  ): void;
3344
3484
  /**
3485
+ * @beta
3345
3486
  * @remarks
3346
3487
  * Teleports the selected entity to a new location, and will
3347
3488
  * have the entity facing a specified location.
@@ -3356,6 +3497,7 @@ export class Entity {
3356
3497
  */
3357
3498
  teleportFacing(location: Vector3, dimension: Dimension, facingLocation: Vector3, keepVelocity?: boolean): void;
3358
3499
  /**
3500
+ * @beta
3359
3501
  * @remarks
3360
3502
  * Triggers an entity type event. For every entity, a number of
3361
3503
  * events are defined in an entities' definition for key entity
@@ -3369,6 +3511,7 @@ export class Entity {
3369
3511
  triggerEvent(eventName: string): void;
3370
3512
  }
3371
3513
  /**
3514
+ * @beta
3372
3515
  * When added, this component makes the entity spawn with a
3373
3516
  * rider of the specified entityType.
3374
3517
  */
@@ -3398,6 +3541,7 @@ export class EntityAddRiderComponent extends IEntityComponent {
3398
3541
  static readonly componentId = 'minecraft:addrider';
3399
3542
  }
3400
3543
  /**
3544
+ * @beta
3401
3545
  * Adds a timer for the entity to grow up. It can be
3402
3546
  * accelerated by giving the entity the items it likes as
3403
3547
  * defined by feedItems.
@@ -3439,6 +3583,7 @@ export class EntityAgeableComponent extends IEntityComponent {
3439
3583
  static readonly componentId = 'minecraft:ageable';
3440
3584
  }
3441
3585
  /**
3586
+ * @beta
3442
3587
  * Defines what blocks this entity can breathe in and gives
3443
3588
  * them the ability to suffocate.
3444
3589
  */
@@ -3516,6 +3661,7 @@ export class EntityBreathableComponent extends IEntityComponent {
3516
3661
  setAirSupply(value: number): void;
3517
3662
  }
3518
3663
  /**
3664
+ * @beta
3519
3665
  * When added, this component signifies that the entity can
3520
3666
  * climb up ladders.
3521
3667
  */
@@ -3533,6 +3679,7 @@ export class EntityCanClimbComponent extends IEntityComponent {
3533
3679
  static readonly componentId = 'minecraft:can_climb';
3534
3680
  }
3535
3681
  /**
3682
+ * @beta
3536
3683
  * When added, this component signifies that the entity can
3537
3684
  * fly, and the pathfinder won't be restricted to paths where a
3538
3685
  * solid block is required underneath it.
@@ -3551,6 +3698,7 @@ export class EntityCanFlyComponent extends IEntityComponent {
3551
3698
  static readonly componentId = 'minecraft:can_fly';
3552
3699
  }
3553
3700
  /**
3701
+ * @beta
3554
3702
  * When added, this component signifies that the entity can
3555
3703
  * power jump like the horse does within Minecraft.
3556
3704
  */
@@ -3568,6 +3716,7 @@ export class EntityCanPowerJumpComponent extends IEntityComponent {
3568
3716
  static readonly componentId = 'minecraft:can_power_jump';
3569
3717
  }
3570
3718
  /**
3719
+ * @beta
3571
3720
  * Defines the entity's color. Only works on certain entities
3572
3721
  * that have predefined color values (sheep, llama, shulker).
3573
3722
  */
@@ -3589,6 +3738,7 @@ export class EntityColorComponent extends IEntityComponent {
3589
3738
  static readonly componentId = 'minecraft:color';
3590
3739
  }
3591
3740
  /**
3741
+ * @beta
3592
3742
  * As part of the Ageable component, represents a set of items
3593
3743
  * that can be fed to an entity and the rate at which that
3594
3744
  * causes them to grow.
@@ -3608,6 +3758,7 @@ export class EntityDefinitionFeedItem {
3608
3758
  readonly item: string;
3609
3759
  }
3610
3760
  /**
3761
+ * @beta
3611
3762
  * When added, this component signifies that this entity
3612
3763
  * doesn't take damage from fire.
3613
3764
  */
@@ -3625,6 +3776,7 @@ export class EntityFireImmuneComponent extends IEntityComponent {
3625
3776
  static readonly componentId = 'minecraft:fire_immune';
3626
3777
  }
3627
3778
  /**
3779
+ * @beta
3628
3780
  * When added, this component signifies that this entity can
3629
3781
  * float in liquid blocks.
3630
3782
  */
@@ -3642,6 +3794,7 @@ export class EntityFloatsInLiquidComponent extends IEntityComponent {
3642
3794
  static readonly componentId = 'minecraft:floats_in_liquid';
3643
3795
  }
3644
3796
  /**
3797
+ * @beta
3645
3798
  * Represents the flying speed of an entity.
3646
3799
  */
3647
3800
  export class EntityFlyingSpeedComponent extends IEntityComponent {
@@ -3662,6 +3815,7 @@ export class EntityFlyingSpeedComponent extends IEntityComponent {
3662
3815
  static readonly componentId = 'minecraft:flying_speed';
3663
3816
  }
3664
3817
  /**
3818
+ * @beta
3665
3819
  * Defines how much friction affects this entity.
3666
3820
  */
3667
3821
  export class EntityFrictionModifierComponent extends IEntityComponent {
@@ -3684,6 +3838,7 @@ export class EntityFrictionModifierComponent extends IEntityComponent {
3684
3838
  static readonly componentId = 'minecraft:friction_modifier';
3685
3839
  }
3686
3840
  /**
3841
+ * @beta
3687
3842
  * Sets the offset from the ground that the entity is actually
3688
3843
  * at.
3689
3844
  */
@@ -3706,6 +3861,7 @@ export class EntityGroundOffsetComponent extends IEntityComponent {
3706
3861
  static readonly componentId = 'minecraft:ground_offset';
3707
3862
  }
3708
3863
  /**
3864
+ * @beta
3709
3865
  * Defines the interactions with this entity for healing it.
3710
3866
  */
3711
3867
  export class EntityHealableComponent extends IEntityComponent {
@@ -3738,6 +3894,7 @@ export class EntityHealableComponent extends IEntityComponent {
3738
3894
  static readonly componentId = 'minecraft:healable';
3739
3895
  }
3740
3896
  /**
3897
+ * @beta
3741
3898
  * Defines the health properties of an entity.
3742
3899
  */
3743
3900
  export class EntityHealthComponent extends IEntityComponent {
@@ -3789,9 +3946,10 @@ export class EntityHealthComponent extends IEntityComponent {
3789
3946
  * @param value
3790
3947
  * @throws This function can throw errors.
3791
3948
  */
3792
- setCurrent(value: number): void;
3949
+ setCurrent(value: number): boolean;
3793
3950
  }
3794
3951
  /**
3952
+ * @beta
3795
3953
  * Contains information related to an entity hitting (melee
3796
3954
  * attacking) another entity.
3797
3955
  */
@@ -3817,6 +3975,7 @@ export class EntityHitEvent {
3817
3975
  readonly hitEntity?: Entity;
3818
3976
  }
3819
3977
  /**
3978
+ * @beta
3820
3979
  * Manages callbacks that are connected to when an entity makes
3821
3980
  * a melee attack on another entity.
3822
3981
  */
@@ -3840,6 +3999,7 @@ export class EntityHitEventSignal {
3840
3999
  unsubscribe(callback: (arg: EntityHitEvent) => void): void;
3841
4000
  }
3842
4001
  /**
4002
+ * @beta
3843
4003
  * Contains additional information about an entity that was
3844
4004
  * hit.
3845
4005
  */
@@ -3851,36 +4011,24 @@ export class EntityHitInformation {
3851
4011
  readonly entity: Entity;
3852
4012
  }
3853
4013
  /**
4014
+ * @beta
3854
4015
  * Contains information related to an entity getting hurt by
3855
4016
  * another entity.
3856
4017
  */
3857
4018
  export class EntityHurtEvent {
3858
4019
  protected constructor();
3859
- /**
3860
- * A summary of the reason that damage was caused.
3861
- */
3862
- readonly cause: EntityDamageCause;
3863
4020
  /**
3864
4021
  * Describes the amount of damage caused.
3865
4022
  */
3866
4023
  readonly damage: number;
3867
- /**
3868
- * Optional entity that caused the damaging attack, or
3869
- * undefined if the hurt reason was not because of another
3870
- * entity.
3871
- */
3872
- readonly damagingEntity: Entity;
4024
+ readonly damageSource: EntityDamageSource;
3873
4025
  /**
3874
4026
  * Entity that was hurt.
3875
4027
  */
3876
4028
  readonly hurtEntity: Entity;
3877
- /**
3878
- * Optional entity for a projectile that potentially hurt an
3879
- * entity.
3880
- */
3881
- readonly projectile: Entity;
3882
4029
  }
3883
4030
  /**
4031
+ * @beta
3884
4032
  * Manages callbacks that are connected to when an entity is
3885
4033
  * hurt.
3886
4034
  */
@@ -3902,6 +4050,7 @@ export class EntityHurtEventSignal {
3902
4050
  unsubscribe(callback: (arg: EntityHurtEvent) => void): void;
3903
4051
  }
3904
4052
  /**
4053
+ * @beta
3905
4054
  * Defines this entity's inventory properties.
3906
4055
  */
3907
4056
  export class EntityInventoryComponent extends IEntityComponent {
@@ -3956,6 +4105,7 @@ export class EntityInventoryComponent extends IEntityComponent {
3956
4105
  static readonly componentId = 'minecraft:inventory';
3957
4106
  }
3958
4107
  /**
4108
+ * @beta
3959
4109
  * When added, this component signifies that this entity is a
3960
4110
  * baby.
3961
4111
  */
@@ -3973,6 +4123,7 @@ export class EntityIsBabyComponent extends IEntityComponent {
3973
4123
  static readonly componentId = 'minecraft:is_baby';
3974
4124
  }
3975
4125
  /**
4126
+ * @beta
3976
4127
  * When added, this component signifies that this entity is
3977
4128
  * charged.
3978
4129
  */
@@ -3990,6 +4141,7 @@ export class EntityIsChargedComponent extends IEntityComponent {
3990
4141
  static readonly componentId = 'minecraft:is_charged';
3991
4142
  }
3992
4143
  /**
4144
+ * @beta
3993
4145
  * When added, this component signifies that this entity is
3994
4146
  * currently carrying a chest.
3995
4147
  */
@@ -4007,6 +4159,7 @@ export class EntityIsChestedComponent extends IEntityComponent {
4007
4159
  static readonly componentId = 'minecraft:is_chested';
4008
4160
  }
4009
4161
  /**
4162
+ * @beta
4010
4163
  * When added, this component signifies that dyes can be used
4011
4164
  * on this entity to change its color.
4012
4165
  */
@@ -4024,6 +4177,7 @@ export class EntityIsDyableComponent extends IEntityComponent {
4024
4177
  static readonly componentId = 'minecraft:is_dyeable';
4025
4178
  }
4026
4179
  /**
4180
+ * @beta
4027
4181
  * When added, this component signifies that this entity can
4028
4182
  * hide from hostile mobs while invisible.
4029
4183
  */
@@ -4041,6 +4195,7 @@ export class EntityIsHiddenWhenInvisibleComponent extends IEntityComponent {
4041
4195
  static readonly componentId = 'minecraft:is_hidden_when_invisible';
4042
4196
  }
4043
4197
  /**
4198
+ * @beta
4044
4199
  * When added, this component signifies that this entity this
4045
4200
  * currently on fire.
4046
4201
  */
@@ -4058,6 +4213,7 @@ export class EntityIsIgnitedComponent extends IEntityComponent {
4058
4213
  static readonly componentId = 'minecraft:is_ignited';
4059
4214
  }
4060
4215
  /**
4216
+ * @beta
4061
4217
  * When added, this component signifies that this entity is an
4062
4218
  * illager captain.
4063
4219
  */
@@ -4075,6 +4231,7 @@ export class EntityIsIllagerCaptainComponent extends IEntityComponent {
4075
4231
  static readonly componentId = 'minecraft:is_illager_captain';
4076
4232
  }
4077
4233
  /**
4234
+ * @beta
4078
4235
  * When added, this component signifies that this entity is
4079
4236
  * currently saddled.
4080
4237
  */
@@ -4092,6 +4249,7 @@ export class EntityIsSaddledComponent extends IEntityComponent {
4092
4249
  static readonly componentId = 'minecraft:is_saddled';
4093
4250
  }
4094
4251
  /**
4252
+ * @beta
4095
4253
  * When added, this component signifies that this entity is
4096
4254
  * currently shaking.
4097
4255
  */
@@ -4109,6 +4267,7 @@ export class EntityIsShakingComponent extends IEntityComponent {
4109
4267
  static readonly componentId = 'minecraft:is_shaking';
4110
4268
  }
4111
4269
  /**
4270
+ * @beta
4112
4271
  * When added, this component signifies that this entity is
4113
4272
  * currently sheared.
4114
4273
  */
@@ -4126,6 +4285,7 @@ export class EntityIsShearedComponent extends IEntityComponent {
4126
4285
  static readonly componentId = 'minecraft:is_sheared';
4127
4286
  }
4128
4287
  /**
4288
+ * @beta
4129
4289
  * When added, this component signifies that this entity can be
4130
4290
  * stacked.
4131
4291
  */
@@ -4143,6 +4303,7 @@ export class EntityIsStackableComponent extends IEntityComponent {
4143
4303
  static readonly componentId = 'minecraft:is_stackable';
4144
4304
  }
4145
4305
  /**
4306
+ * @beta
4146
4307
  * When added, this component signifies that this entity is
4147
4308
  * currently stunned.
4148
4309
  */
@@ -4160,6 +4321,7 @@ export class EntityIsStunnedComponent extends IEntityComponent {
4160
4321
  static readonly componentId = 'minecraft:is_stunned';
4161
4322
  }
4162
4323
  /**
4324
+ * @beta
4163
4325
  * When added, this component signifies that this entity is
4164
4326
  * currently tamed.
4165
4327
  */
@@ -4177,6 +4339,7 @@ export class EntityIsTamedComponent extends IEntityComponent {
4177
4339
  static readonly componentId = 'minecraft:is_tamed';
4178
4340
  }
4179
4341
  /**
4342
+ * @beta
4180
4343
  * If added onto the entity, this indicates that the entity
4181
4344
  * represents a free-floating item in the world. Lets you
4182
4345
  * retrieve the actual item stack contents via the itemStack
@@ -4199,6 +4362,7 @@ export class EntityItemComponent extends IEntityComponent {
4199
4362
  static readonly componentId = 'minecraft:item';
4200
4363
  }
4201
4364
  /**
4365
+ * @beta
4202
4366
  * This type is usable for iterating over a set of entities.
4203
4367
  * This means it can be used in statements like for...of
4204
4368
  * statements, Array.from(iterator), and more.
@@ -4215,6 +4379,7 @@ export class EntityIterator implements Iterable<Entity> {
4215
4379
  next(): IteratorResult<Entity>;
4216
4380
  }
4217
4381
  /**
4382
+ * @beta
4218
4383
  * Defines the base movement speed in lava of this entity.
4219
4384
  */
4220
4385
  export class EntityLavaMovementComponent extends IEntityComponent {
@@ -4269,9 +4434,10 @@ export class EntityLavaMovementComponent extends IEntityComponent {
4269
4434
  * @param value
4270
4435
  * @throws This function can throw errors.
4271
4436
  */
4272
- setCurrent(value: number): void;
4437
+ setCurrent(value: number): boolean;
4273
4438
  }
4274
4439
  /**
4440
+ * @beta
4275
4441
  * Allows this entity to be leashed and defines the conditions
4276
4442
  * and events for this entity when is leashed.
4277
4443
  */
@@ -4310,6 +4476,7 @@ export class EntityLeashableComponent extends IEntityComponent {
4310
4476
  unleash(): void;
4311
4477
  }
4312
4478
  /**
4479
+ * @beta
4313
4480
  * Additional variant value. Can be used to further
4314
4481
  * differentiate variants.
4315
4482
  */
@@ -4332,6 +4499,7 @@ export class EntityMarkVariantComponent extends IEntityComponent {
4332
4499
  static readonly componentId = 'minecraft:mark_variant';
4333
4500
  }
4334
4501
  /**
4502
+ * @beta
4335
4503
  * Contains options for taming a rideable entity based on the
4336
4504
  * entity that mounts it.
4337
4505
  */
@@ -4357,6 +4525,7 @@ export class EntityMountTamingComponent extends IEntityComponent {
4357
4525
  setTamed(showParticles: boolean): void;
4358
4526
  }
4359
4527
  /**
4528
+ * @beta
4360
4529
  * When added, this movement control allows the mob to swim in
4361
4530
  * water and walk on land.
4362
4531
  */
@@ -4379,6 +4548,7 @@ export class EntityMovementAmphibiousComponent extends IEntityComponent {
4379
4548
  static readonly componentId = 'minecraft:movement.amphibious';
4380
4549
  }
4381
4550
  /**
4551
+ * @beta
4382
4552
  * This component accents the movement of an entity.
4383
4553
  */
4384
4554
  export class EntityMovementBasicComponent extends IEntityComponent {
@@ -4400,6 +4570,7 @@ export class EntityMovementBasicComponent extends IEntityComponent {
4400
4570
  static readonly componentId = 'minecraft:movement.basic';
4401
4571
  }
4402
4572
  /**
4573
+ * @beta
4403
4574
  * Defines the general movement speed of this entity.
4404
4575
  */
4405
4576
  export class EntityMovementComponent extends IEntityComponent {
@@ -4453,9 +4624,10 @@ export class EntityMovementComponent extends IEntityComponent {
4453
4624
  * @param value
4454
4625
  * @throws This function can throw errors.
4455
4626
  */
4456
- setCurrent(value: number): void;
4627
+ setCurrent(value: number): boolean;
4457
4628
  }
4458
4629
  /**
4630
+ * @beta
4459
4631
  * When added, this move control causes the mob to fly.
4460
4632
  */
4461
4633
  export class EntityMovementFlyComponent extends IEntityComponent {
@@ -4477,6 +4649,7 @@ export class EntityMovementFlyComponent extends IEntityComponent {
4477
4649
  static readonly componentId = 'minecraft:movement.fly';
4478
4650
  }
4479
4651
  /**
4652
+ * @beta
4480
4653
  * When added, this move control allows a mob to fly, swim,
4481
4654
  * climb, etc.
4482
4655
  */
@@ -4499,6 +4672,7 @@ export class EntityMovementGenericComponent extends IEntityComponent {
4499
4672
  static readonly componentId = 'minecraft:movement.generic';
4500
4673
  }
4501
4674
  /**
4675
+ * @beta
4502
4676
  * When added, this movement control allows the mob to glide.
4503
4677
  */
4504
4678
  export class EntityMovementGlideComponent extends IEntityComponent {
@@ -4530,6 +4704,7 @@ export class EntityMovementGlideComponent extends IEntityComponent {
4530
4704
  static readonly componentId = 'minecraft:movement.glide';
4531
4705
  }
4532
4706
  /**
4707
+ * @beta
4533
4708
  * When added, this move control causes the mob to hover.
4534
4709
  */
4535
4710
  export class EntityMovementHoverComponent extends IEntityComponent {
@@ -4551,6 +4726,7 @@ export class EntityMovementHoverComponent extends IEntityComponent {
4551
4726
  static readonly componentId = 'minecraft:movement.hover';
4552
4727
  }
4553
4728
  /**
4729
+ * @beta
4554
4730
  * Move control that causes the mob to jump as it moves with a
4555
4731
  * specified delay between jumps.
4556
4732
  */
@@ -4573,6 +4749,7 @@ export class EntityMovementJumpComponent extends IEntityComponent {
4573
4749
  static readonly componentId = 'minecraft:movement.jump';
4574
4750
  }
4575
4751
  /**
4752
+ * @beta
4576
4753
  * When added, this move control causes the mob to hop as it
4577
4754
  * moves.
4578
4755
  */
@@ -4595,6 +4772,7 @@ export class EntityMovementSkipComponent extends IEntityComponent {
4595
4772
  static readonly componentId = 'minecraft:movement.skip';
4596
4773
  }
4597
4774
  /**
4775
+ * @beta
4598
4776
  * When added, this move control causes the mob to sway side to
4599
4777
  * side giving the impression it is swimming.
4600
4778
  */
@@ -4627,6 +4805,7 @@ export class EntityMovementSwayComponent extends IEntityComponent {
4627
4805
  static readonly componentId = 'minecraft:movement.sway';
4628
4806
  }
4629
4807
  /**
4808
+ * @beta
4630
4809
  * Allows this entity to generate paths that include vertical
4631
4810
  * walls (for example, like Minecraft spiders do.)
4632
4811
  */
@@ -4754,6 +4933,7 @@ export class EntityNavigationClimbComponent extends IEntityComponent {
4754
4933
  static readonly componentId = 'minecraft:navigation.climb';
4755
4934
  }
4756
4935
  /**
4936
+ * @beta
4757
4937
  * Allows this entity to generate paths by flying around the
4758
4938
  * air like the regular Ghast.
4759
4939
  */
@@ -4881,6 +5061,7 @@ export class EntityNavigationFloatComponent extends IEntityComponent {
4881
5061
  static readonly componentId = 'minecraft:navigation.float';
4882
5062
  }
4883
5063
  /**
5064
+ * @beta
4884
5065
  * Allows this entity to generate paths in the air (for
4885
5066
  * example, like Minecraft parrots do.)
4886
5067
  */
@@ -5008,6 +5189,7 @@ export class EntityNavigationFlyComponent extends IEntityComponent {
5008
5189
  static readonly componentId = 'minecraft:navigation.fly';
5009
5190
  }
5010
5191
  /**
5192
+ * @beta
5011
5193
  * Allows this entity to generate paths by walking, swimming,
5012
5194
  * flying and/or climbing around and jumping up and down a
5013
5195
  * block.
@@ -5136,6 +5318,7 @@ export class EntityNavigationGenericComponent extends IEntityComponent {
5136
5318
  static readonly componentId = 'minecraft:navigation.generic';
5137
5319
  }
5138
5320
  /**
5321
+ * @beta
5139
5322
  * Allows this entity to generate paths in the air (for
5140
5323
  * example, like the Minecraft Bees do.) Keeps them from
5141
5324
  * falling out of the skies and doing predictive movement.
@@ -5264,6 +5447,7 @@ export class EntityNavigationHoverComponent extends IEntityComponent {
5264
5447
  static readonly componentId = 'minecraft:navigation.hover';
5265
5448
  }
5266
5449
  /**
5450
+ * @beta
5267
5451
  * Allows this entity to generate paths by walking around and
5268
5452
  * jumping up and down a block like regular mobs.
5269
5453
  */
@@ -5397,6 +5581,7 @@ export class EntityOnFireComponent extends IEntityComponent {
5397
5581
  static readonly componentId = 'minecraft:onfire';
5398
5582
  }
5399
5583
  /**
5584
+ * @beta
5400
5585
  * Sets the distance through which the entity can push through.
5401
5586
  */
5402
5587
  export class EntityPushThroughComponent extends IEntityComponent {
@@ -5417,6 +5602,7 @@ export class EntityPushThroughComponent extends IEntityComponent {
5417
5602
  static readonly componentId = 'minecraft:push_through';
5418
5603
  }
5419
5604
  /**
5605
+ * @beta
5420
5606
  * When added, this component adds the capability that an
5421
5607
  * entity can be ridden by another entity.
5422
5608
  */
@@ -5506,6 +5692,7 @@ export class EntityRideableComponent extends IEntityComponent {
5506
5692
  ejectRiders(): void;
5507
5693
  }
5508
5694
  /**
5695
+ * @beta
5509
5696
  * Sets the entity's visual size.
5510
5697
  */
5511
5698
  export class EntityScaleComponent extends IEntityComponent {
@@ -5528,6 +5715,7 @@ export class EntityScaleComponent extends IEntityComponent {
5528
5715
  static readonly componentId = 'minecraft:scale';
5529
5716
  }
5530
5717
  /**
5718
+ * @beta
5531
5719
  * Skin Id value. Can be used to differentiate skins, such as
5532
5720
  * base skins for villagers.
5533
5721
  */
@@ -5550,6 +5738,7 @@ export class EntitySkinIdComponent extends IEntityComponent {
5550
5738
  static readonly componentId = 'minecraft:skin_id';
5551
5739
  }
5552
5740
  /**
5741
+ * @beta
5553
5742
  * Contains data related to an entity spawning within the
5554
5743
  * world.
5555
5744
  */
@@ -5561,6 +5750,7 @@ export class EntitySpawnEvent {
5561
5750
  entity: Entity;
5562
5751
  }
5563
5752
  /**
5753
+ * @beta
5564
5754
  * Registers a script-based event handler for handling what
5565
5755
  * happens when an entity spawns.
5566
5756
  */
@@ -5586,6 +5776,7 @@ export class EntitySpawnEventSignal {
5586
5776
  unsubscribe(callback: (arg: EntitySpawnEvent) => void): void;
5587
5777
  }
5588
5778
  /**
5779
+ * @beta
5589
5780
  * Defines the entity's strength to carry items.
5590
5781
  */
5591
5782
  export class EntityStrengthComponent extends IEntityComponent {
@@ -5614,6 +5805,7 @@ export class EntityStrengthComponent extends IEntityComponent {
5614
5805
  static readonly componentId = 'minecraft:strength';
5615
5806
  }
5616
5807
  /**
5808
+ * @beta
5617
5809
  * Defines the rules for a mob to be tamed by the player.
5618
5810
  */
5619
5811
  export class EntityTameableComponent extends IEntityComponent {
@@ -5654,6 +5846,7 @@ export class EntityTameableComponent extends IEntityComponent {
5654
5846
  tame(): boolean;
5655
5847
  }
5656
5848
  /**
5849
+ * @beta
5657
5850
  * Represents information about a type of entity.
5658
5851
  */
5659
5852
  export class EntityType {
@@ -5665,6 +5858,7 @@ export class EntityType {
5665
5858
  readonly id: string;
5666
5859
  }
5667
5860
  /**
5861
+ * @beta
5668
5862
  * An iterator that loops through available entity types.
5669
5863
  */
5670
5864
  export class EntityTypeIterator implements Iterable<EntityType> {
@@ -5673,6 +5867,7 @@ export class EntityTypeIterator implements Iterable<EntityType> {
5673
5867
  next(): IteratorResult<EntityType>;
5674
5868
  }
5675
5869
  /**
5870
+ * @beta
5676
5871
  * Used for accessing all entity types currently available for
5677
5872
  * use within the world.
5678
5873
  */
@@ -5692,6 +5887,7 @@ export class EntityTypes {
5692
5887
  static getAll(): EntityTypeIterator;
5693
5888
  }
5694
5889
  /**
5890
+ * @beta
5695
5891
  * Defines the general movement speed underwater of this
5696
5892
  * entity.
5697
5893
  */
@@ -5749,9 +5945,10 @@ export class EntityUnderwaterMovementComponent extends IEntityComponent {
5749
5945
  * @param value
5750
5946
  * @throws This function can throw errors.
5751
5947
  */
5752
- setCurrent(value: number): void;
5948
+ setCurrent(value: number): boolean;
5753
5949
  }
5754
5950
  /**
5951
+ * @beta
5755
5952
  * Used to differentiate the component group of a variant of an
5756
5953
  * entity from others. (e.g. ocelot, villager).
5757
5954
  */
@@ -5775,6 +5972,7 @@ export class EntityVariantComponent extends IEntityComponent {
5775
5972
  static readonly componentId = 'minecraft:variant';
5776
5973
  }
5777
5974
  /**
5975
+ * @beta
5778
5976
  * When added, this component signifies that this entity wants
5779
5977
  * to become a jockey.
5780
5978
  */
@@ -5792,6 +5990,7 @@ export class EntityWantsJockeyComponent extends IEntityComponent {
5792
5990
  static readonly componentId = 'minecraft:wants_jockey';
5793
5991
  }
5794
5992
  /**
5993
+ * @beta
5795
5994
  * Contains a set of events that are available across the scope
5796
5995
  * of the World.
5797
5996
  */
@@ -5980,6 +6179,7 @@ export class Events {
5980
6179
  readonly worldInitialize: WorldInitializeEventSignal;
5981
6180
  }
5982
6181
  /**
6182
+ * @beta
5983
6183
  * Contains information regarding an explosion that has
5984
6184
  * happened.
5985
6185
  */
@@ -5999,6 +6199,7 @@ export class ExplosionEvent {
5999
6199
  readonly source: Entity;
6000
6200
  }
6001
6201
  /**
6202
+ * @beta
6002
6203
  * Manages callbacks that are connected to when an explosion
6003
6204
  * occurs.
6004
6205
  */
@@ -6021,6 +6222,7 @@ export class ExplosionEventSignal {
6021
6222
  unsubscribe(callback: (arg: ExplosionEvent) => void): void;
6022
6223
  }
6023
6224
  /**
6225
+ * @beta
6024
6226
  * As part of the Healable component, represents a specific
6025
6227
  * item that can be fed to an entity to cause health effects.
6026
6228
  */
@@ -6045,6 +6247,7 @@ export class FeedItem {
6045
6247
  readonly item: string;
6046
6248
  }
6047
6249
  /**
6250
+ * @beta
6048
6251
  * Represents an effect that is applied as a result of a food
6049
6252
  * item being fed to an entity.
6050
6253
  */
@@ -6072,6 +6275,7 @@ export class FeedItemEffect {
6072
6275
  readonly name: string;
6073
6276
  }
6074
6277
  /**
6278
+ * @beta
6075
6279
  * Represents a set of filters for when an event should occur.
6076
6280
  */
6077
6281
  // tslint:disable-next-line:no-unnecessary-class
@@ -6079,6 +6283,7 @@ export class FilterGroup {
6079
6283
  protected constructor();
6080
6284
  }
6081
6285
  /**
6286
+ * @beta
6082
6287
  * Represents constants related to fluid containers.
6083
6288
  */
6084
6289
  // tslint:disable-next-line:no-unnecessary-class
@@ -6096,6 +6301,7 @@ export class FluidContainer {
6096
6301
  static readonly minFillLevel = 0;
6097
6302
  }
6098
6303
  /**
6304
+ * @beta
6099
6305
  * Contains an interface for defining the state of a property
6100
6306
  * for a {@link BlockPermutation}.
6101
6307
  */
@@ -6107,6 +6313,7 @@ export class IBlockProperty {
6107
6313
  readonly name: string;
6108
6314
  }
6109
6315
  /**
6316
+ * @beta
6110
6317
  * Base interface that defines components associated with an
6111
6318
  * entity.
6112
6319
  */
@@ -6118,6 +6325,7 @@ export class IEntityComponent {
6118
6325
  readonly typeId: string;
6119
6326
  }
6120
6327
  /**
6328
+ * @beta
6121
6329
  * Contains the state of an integer-based property for a {@link
6122
6330
  * BlockPermutation}.
6123
6331
  */
@@ -6141,6 +6349,7 @@ export class IntBlockProperty extends IBlockProperty {
6141
6349
  value: number;
6142
6350
  }
6143
6351
  /**
6352
+ * @beta
6144
6353
  * Represents a container that can hold stacks of items. Used
6145
6354
  * for entities like players, chest minecarts, llamas, and
6146
6355
  * more.
@@ -6255,6 +6464,7 @@ export class InventoryComponentContainer extends Container {
6255
6464
  transferItem(fromSlot: number, toSlot: number, toContainer: Container): boolean;
6256
6465
  }
6257
6466
  /**
6467
+ * @beta
6258
6468
  * Contains information related to a chargeable item completing
6259
6469
  * being charged.
6260
6470
  */
@@ -6275,6 +6485,7 @@ export class ItemCompleteChargeEvent {
6275
6485
  readonly useDuration: number;
6276
6486
  }
6277
6487
  /**
6488
+ * @beta
6278
6489
  * Manages callbacks that are connected to the completion of
6279
6490
  * charging for a chargeable item.
6280
6491
  */
@@ -6297,6 +6508,7 @@ export class ItemCompleteChargeEventSignal {
6297
6508
  unsubscribe(callback: (arg: ItemCompleteChargeEvent) => void): void;
6298
6509
  }
6299
6510
  /**
6511
+ * @beta
6300
6512
  * When present on an item, this item has a cooldown effect
6301
6513
  * when used by entities.
6302
6514
  */
@@ -6328,6 +6540,7 @@ export class ItemCooldownComponent {
6328
6540
  startCooldown(player: Player): void;
6329
6541
  }
6330
6542
  /**
6543
+ * @beta
6331
6544
  * Manages callbacks that are connected to an item's definition
6332
6545
  * and components changing.
6333
6546
  */
@@ -6350,6 +6563,7 @@ export class ItemDefinitionEventSignal {
6350
6563
  unsubscribe(callback: (arg: ItemDefinitionTriggeredEvent) => void): void;
6351
6564
  }
6352
6565
  /**
6566
+ * @beta
6353
6567
  * Contains information related to a custom item having a data
6354
6568
  * definition change being triggered.
6355
6569
  */
@@ -6370,6 +6584,7 @@ export class ItemDefinitionTriggeredEvent {
6370
6584
  readonly source: Entity;
6371
6585
  }
6372
6586
  /**
6587
+ * @beta
6373
6588
  * When present on an item, this item can take damage in the
6374
6589
  * process of being used. Note that this component only applies
6375
6590
  * to data-driven items.
@@ -6410,6 +6625,7 @@ export class ItemDurabilityComponent {
6410
6625
  getDamageChance(unbreaking?: number): number;
6411
6626
  }
6412
6627
  /**
6628
+ * @beta
6413
6629
  * When present on an item, this item has applied enchantment
6414
6630
  * effects. Note that this component only applies to
6415
6631
  * data-driven items.
@@ -6433,6 +6649,7 @@ export class ItemEnchantsComponent {
6433
6649
  removeAllEnchantments(): void;
6434
6650
  }
6435
6651
  /**
6652
+ * @beta
6436
6653
  * When present on an item, this item is consumable by
6437
6654
  * entities. Note that this component only applies to
6438
6655
  * data-driven items.
@@ -6471,6 +6688,7 @@ export class ItemFoodComponent {
6471
6688
  static readonly componentId = 'minecraft:food';
6472
6689
  }
6473
6690
  /**
6691
+ * @beta
6474
6692
  * Contains information related to a chargeable item when the
6475
6693
  * player has finished using the item and released the build
6476
6694
  * action.
@@ -6492,6 +6710,7 @@ export class ItemReleaseChargeEvent {
6492
6710
  readonly useDuration: number;
6493
6711
  }
6494
6712
  /**
6713
+ * @beta
6495
6714
  * Manages callbacks that are connected to the releasing of
6496
6715
  * charging for a chargeable item.
6497
6716
  */
@@ -6514,6 +6733,7 @@ export class ItemReleaseChargeEventSignal {
6514
6733
  unsubscribe(callback: (arg: ItemReleaseChargeEvent) => void): void;
6515
6734
  }
6516
6735
  /**
6736
+ * @beta
6517
6737
  * Represents a collection of all of the available item types
6518
6738
  * in Minecraft.
6519
6739
  */
@@ -6529,6 +6749,7 @@ export class Items {
6529
6749
  static get(itemId: string): ItemType;
6530
6750
  }
6531
6751
  /**
6752
+ * @beta
6532
6753
  * Defines a collection of items.
6533
6754
  */
6534
6755
  export class ItemStack {
@@ -6619,6 +6840,7 @@ export class ItemStack {
6619
6840
  triggerEvent(eventName: string): void;
6620
6841
  }
6621
6842
  /**
6843
+ * @beta
6622
6844
  * Contains information related to a chargeable item starting
6623
6845
  * to be charged.
6624
6846
  */
@@ -6639,6 +6861,7 @@ export class ItemStartChargeEvent {
6639
6861
  readonly useDuration: number;
6640
6862
  }
6641
6863
  /**
6864
+ * @beta
6642
6865
  * Manages callbacks that are connected to the start of
6643
6866
  * charging for a chargeable item.
6644
6867
  */
@@ -6661,6 +6884,7 @@ export class ItemStartChargeEventSignal {
6661
6884
  unsubscribe(callback: (arg: ItemStartChargeEvent) => void): void;
6662
6885
  }
6663
6886
  /**
6887
+ * @beta
6664
6888
  * Contains information related to an item being used on a
6665
6889
  * block.
6666
6890
  */
@@ -6689,6 +6913,7 @@ export class ItemStartUseOnEvent {
6689
6913
  readonly source: Entity;
6690
6914
  }
6691
6915
  /**
6916
+ * @beta
6692
6917
  * Manages callbacks that are connected to an item starting
6693
6918
  * being used on a block event.
6694
6919
  */
@@ -6711,6 +6936,7 @@ export class ItemStartUseOnEventSignal {
6711
6936
  unsubscribe(callback: (arg: ItemStartUseOnEvent) => void): void;
6712
6937
  }
6713
6938
  /**
6939
+ * @beta
6714
6940
  * Contains information related to a chargeable item has
6715
6941
  * finished an items use cycle, or when the player has released
6716
6942
  * the use action with the item.
@@ -6732,6 +6958,7 @@ export class ItemStopChargeEvent {
6732
6958
  readonly useDuration: number;
6733
6959
  }
6734
6960
  /**
6961
+ * @beta
6735
6962
  * Manages callbacks that are connected to the stopping of
6736
6963
  * charging for an item that has a registered
6737
6964
  * minecraft:chargeable component.
@@ -6755,6 +6982,7 @@ export class ItemStopChargeEventSignal {
6755
6982
  unsubscribe(callback: (arg: ItemStopChargeEvent) => void): void;
6756
6983
  }
6757
6984
  /**
6985
+ * @beta
6758
6986
  * Contains information related to an item that has stopped
6759
6987
  * being used on a block.
6760
6988
  */
@@ -6774,6 +7002,7 @@ export class ItemStopUseOnEvent {
6774
7002
  readonly source: Entity;
6775
7003
  }
6776
7004
  /**
7005
+ * @beta
6777
7006
  * Manages callbacks that are connected to an item stops used
6778
7007
  * on a block event.
6779
7008
  */
@@ -6796,6 +7025,7 @@ export class ItemStopUseOnEventSignal {
6796
7025
  unsubscribe(callback: (arg: ItemStopUseOnEvent) => void): void;
6797
7026
  }
6798
7027
  /**
7028
+ * @beta
6799
7029
  * Represents the type of an item - for example, Wool.
6800
7030
  */
6801
7031
  export class ItemType {
@@ -6807,6 +7037,7 @@ export class ItemType {
6807
7037
  readonly id: string;
6808
7038
  }
6809
7039
  /**
7040
+ * @beta
6810
7041
  * An iterator over a set of available item types.
6811
7042
  */
6812
7043
  export class ItemTypeIterator implements Iterable<ItemType> {
@@ -6815,6 +7046,7 @@ export class ItemTypeIterator implements Iterable<ItemType> {
6815
7046
  next(): IteratorResult<ItemType>;
6816
7047
  }
6817
7048
  /**
7049
+ * @beta
6818
7050
  * Returns the set of item types registered within Minecraft.
6819
7051
  */
6820
7052
  // tslint:disable-next-line:no-unnecessary-class
@@ -6834,6 +7066,7 @@ export class ItemTypes {
6834
7066
  static getAll(): ItemTypeIterator;
6835
7067
  }
6836
7068
  /**
7069
+ * @beta
6837
7070
  * Contains information related to an item being used.
6838
7071
  */
6839
7072
  export class ItemUseEvent {
@@ -6848,6 +7081,7 @@ export class ItemUseEvent {
6848
7081
  readonly source: Entity;
6849
7082
  }
6850
7083
  /**
7084
+ * @beta
6851
7085
  * Manages callbacks that are connected to an item use event.
6852
7086
  */
6853
7087
  export class ItemUseEventSignal {
@@ -6867,6 +7101,7 @@ export class ItemUseEventSignal {
6867
7101
  unsubscribe(callback: (arg: ItemUseEvent) => void): void;
6868
7102
  }
6869
7103
  /**
7104
+ * @beta
6870
7105
  * Contains information related to an item being used on a
6871
7106
  * block.
6872
7107
  */
@@ -6900,6 +7135,7 @@ export class ItemUseOnEvent {
6900
7135
  readonly source: Entity;
6901
7136
  }
6902
7137
  /**
7138
+ * @beta
6903
7139
  * Manages callbacks that are connected to an item being used
6904
7140
  * on a block event.
6905
7141
  */
@@ -6922,6 +7158,7 @@ export class ItemUseOnEventSignal {
6922
7158
  unsubscribe(callback: (arg: ItemUseOnEvent) => void): void;
6923
7159
  }
6924
7160
  /**
7161
+ * @beta
6925
7162
  * Contains information related to changes to a lever
6926
7163
  * activating or deactivating.
6927
7164
  */
@@ -6947,6 +7184,7 @@ export class LeverActionEvent extends BlockEvent {
6947
7184
  readonly player: Player;
6948
7185
  }
6949
7186
  /**
7187
+ * @beta
6950
7188
  * Manages callbacks that are connected to lever moves
6951
7189
  * (activates or deactivates).
6952
7190
  */
@@ -6969,6 +7207,7 @@ export class LeverActionEventSignal {
6969
7207
  unsubscribe(callback: (arg: LeverActionEvent) => void): void;
6970
7208
  }
6971
7209
  /**
7210
+ * @beta
6972
7211
  * Contains a location description that is useful for entities
6973
7212
  * and other items. X, Y, and Z can contain decimal fractions.
6974
7213
  * For integer-based locations useful for blocks, see {@link
@@ -7023,6 +7262,7 @@ export class Location {
7023
7262
  isNear(other: Location, epsilon: number): boolean;
7024
7263
  }
7025
7264
  /**
7265
+ * @beta
7026
7266
  * A specific currently-internal event used for passing
7027
7267
  * messages from client to server.
7028
7268
  */
@@ -7034,6 +7274,7 @@ export class MessageReceiveEvent {
7034
7274
  readonly sourceType: MessageSourceType;
7035
7275
  }
7036
7276
  /**
7277
+ * @beta
7037
7278
  * Contains definitions of standard Minecraft and Minecraft
7038
7279
  * Education Edition block types.
7039
7280
  */
@@ -10153,6 +10394,7 @@ export class MinecraftDimensionTypes {
10153
10394
  static readonly theEnd = 'minecraft:the_end';
10154
10395
  }
10155
10396
  /**
10397
+ * @beta
10156
10398
  * Returns available installed effect types within Minecraft.
10157
10399
  */
10158
10400
  // tslint:disable-next-line:no-unnecessary-class
@@ -10349,6 +10591,7 @@ export class MinecraftEntityTypes {
10349
10591
  static readonly zombieVillagerV2: EntityType;
10350
10592
  }
10351
10593
  /**
10594
+ * @beta
10352
10595
  * Contains definitions of standard Minecraft and Minecraft
10353
10596
  * Education Edition block types.
10354
10597
  */
@@ -12992,6 +13235,7 @@ export class MinecraftItemTypes {
12992
13235
  static readonly zombieVillagerSpawnEgg: ItemType;
12993
13236
  }
12994
13237
  /**
13238
+ * @beta
12995
13239
  * Contains a set of additional variable values for further
12996
13240
  * defining how rendering and animations function.
12997
13241
  */
@@ -13031,6 +13275,7 @@ export class MolangVariableMap {
13031
13275
  setVector3(variableName: string, vector: Vector): MolangVariableMap;
13032
13276
  }
13033
13277
  /**
13278
+ * @beta
13034
13279
  * Contains data resulting from a navigation operation,
13035
13280
  * including whether the navigation is possible and the path of
13036
13281
  * navigation.
@@ -13048,6 +13293,7 @@ export class NavigationResult {
13048
13293
  readonly path: BlockLocation[];
13049
13294
  }
13050
13295
  /**
13296
+ * @beta
13051
13297
  * Represents a min/max structure for expressing a potential
13052
13298
  * range of numbers.
13053
13299
  */
@@ -13069,6 +13315,7 @@ export class NumberRange {
13069
13315
  next(): number;
13070
13316
  }
13071
13317
  /**
13318
+ * @beta
13072
13319
  * Contains information related to changes to a piston
13073
13320
  * expanding or retracting.
13074
13321
  */
@@ -13093,6 +13340,7 @@ export class PistonActivateEvent extends BlockEvent {
13093
13340
  readonly piston: BlockPistonComponent;
13094
13341
  }
13095
13342
  /**
13343
+ * @beta
13096
13344
  * Manages callbacks that are connected to piston activations.
13097
13345
  */
13098
13346
  export class PistonActivateEventSignal {
@@ -13137,11 +13385,13 @@ export class PistonActivateEventSignal {
13137
13385
  export class Player extends Entity {
13138
13386
  protected constructor();
13139
13387
  /**
13388
+ * @beta
13140
13389
  * Dimension that the entity is currently within.
13141
13390
  * @throws This property can throw when used.
13142
13391
  */
13143
13392
  readonly dimension: Dimension;
13144
13393
  /**
13394
+ * @beta
13145
13395
  * Location of the center of the head component of the player.
13146
13396
  * @throws This property can throw when used.
13147
13397
  */
@@ -13155,10 +13405,13 @@ export class Player extends Entity {
13155
13405
  */
13156
13406
  readonly id: string;
13157
13407
  /**
13408
+ * @beta
13158
13409
  * True if the player is currently using a sneaking movement.
13159
13410
  */
13160
13411
  isSneaking: boolean;
13412
+ readonly level: number;
13161
13413
  /**
13414
+ * @beta
13162
13415
  * Current location of the player.
13163
13416
  * @throws This property can throw when used.
13164
13417
  */
@@ -13169,29 +13422,35 @@ export class Player extends Entity {
13169
13422
  */
13170
13423
  readonly name: string;
13171
13424
  /**
13425
+ * @beta
13172
13426
  * Optional name tag of the player.
13173
13427
  */
13174
13428
  nameTag: string;
13175
13429
  /**
13430
+ * @beta
13176
13431
  * Contains methods for manipulating the on-screen display of a
13177
13432
  * Player.
13178
13433
  */
13179
13434
  readonly onScreenDisplay: ScreenDisplay;
13180
13435
  /**
13436
+ * @beta
13181
13437
  * Main rotation of the entity.
13182
13438
  * @throws This property can throw when used.
13183
13439
  */
13184
13440
  readonly rotation: XYRotation;
13185
13441
  /**
13442
+ * @beta
13186
13443
  * Returns a scoreboard identity that represents this entity.
13187
13444
  * @throws This property can throw when used.
13188
13445
  */
13189
13446
  readonly scoreboard: ScoreboardIdentity;
13190
13447
  /**
13448
+ * @beta
13191
13449
  * Manages the selected slot in the player's hotbar.
13192
13450
  */
13193
13451
  selectedSlot: number;
13194
13452
  /**
13453
+ * @beta
13195
13454
  * Retrieves or sets an entity that is used as the target of
13196
13455
  * AI-related behaviors, like attacking. For players, which
13197
13456
  * don't use any AI semantics, this property does not do
@@ -13199,6 +13458,7 @@ export class Player extends Entity {
13199
13458
  * @throws This property can throw when used.
13200
13459
  */
13201
13460
  readonly target: Entity;
13461
+ readonly totalXpNeededForNextLevel: number;
13202
13462
  /**
13203
13463
  * Unique identifier of the type of the entity - for example,
13204
13464
  * 'minecraft:player'.
@@ -13206,16 +13466,20 @@ export class Player extends Entity {
13206
13466
  */
13207
13467
  readonly typeId: string;
13208
13468
  /**
13469
+ * @beta
13209
13470
  * Current speed of the player across X, Y, and Z dimensions.
13210
13471
  * @throws This property can throw when used.
13211
13472
  */
13212
13473
  readonly velocity: Vector;
13213
13474
  /**
13475
+ * @beta
13214
13476
  * Direction that the player is looking, from their head.
13215
13477
  * @throws This property can throw when used.
13216
13478
  */
13217
13479
  readonly viewDirection: Vector3;
13480
+ readonly xpEarnedAtCurrentLevel: number;
13218
13481
  /**
13482
+ * @beta
13219
13483
  * @remarks
13220
13484
  * Adds an effect, like poison, to the entity.
13221
13485
  * @param effectType
@@ -13228,7 +13492,10 @@ export class Player extends Entity {
13228
13492
  * @throws This function can throw errors.
13229
13493
  */
13230
13494
  addEffect(effectType: EffectType, duration: number, amplifier?: number, showParticles?: boolean): void;
13495
+ addExperience(amount: number): number;
13496
+ addLevels(amount: number): number;
13231
13497
  /**
13498
+ * @beta
13232
13499
  * @remarks
13233
13500
  * Adds a specified tag to an entity.
13234
13501
  * @param tag
@@ -13236,8 +13503,10 @@ export class Player extends Entity {
13236
13503
  * @throws This function can throw errors.
13237
13504
  */
13238
13505
  addTag(tag: string): boolean;
13506
+ applyDamage(amount: number, source?: EntityDamageSource): boolean;
13239
13507
  extinguishFire(useEffects?: boolean): boolean;
13240
13508
  /**
13509
+ * @beta
13241
13510
  * @remarks
13242
13511
  * Returns the first intersecting block from the direction that
13243
13512
  * this player is looking at.
@@ -13246,6 +13515,7 @@ export class Player extends Entity {
13246
13515
  */
13247
13516
  getBlockFromViewDirection(options?: BlockRaycastOptions): Block;
13248
13517
  /**
13518
+ * @beta
13249
13519
  * @remarks
13250
13520
  * Gets a component (that represents additional capabilities)
13251
13521
  * for an entity.
@@ -13257,12 +13527,14 @@ export class Player extends Entity {
13257
13527
  */
13258
13528
  getComponent(componentId: string): IEntityComponent;
13259
13529
  /**
13530
+ * @beta
13260
13531
  * @remarks
13261
13532
  * Returns all components that are both present on this entity
13262
13533
  * and supported by the API.
13263
13534
  */
13264
13535
  getComponents(): IEntityComponent[];
13265
13536
  /**
13537
+ * @beta
13266
13538
  * @remarks
13267
13539
  * Returns a property value.
13268
13540
  * @param identifier
@@ -13271,8 +13543,9 @@ export class Player extends Entity {
13271
13543
  * property has not been set.
13272
13544
  * @throws This function can throw errors.
13273
13545
  */
13274
- getDynamicProperty(identifier: string): boolean | number | string;
13546
+ getDynamicProperty(identifier: string): boolean | number | string | undefined;
13275
13547
  /**
13548
+ * @beta
13276
13549
  * @remarks
13277
13550
  * Returns the effect for the specified EffectType on the
13278
13551
  * entity, or undefined if the effect is not present.
@@ -13285,6 +13558,7 @@ export class Player extends Entity {
13285
13558
  getEffect(effectType: EffectType): Effect;
13286
13559
  getEffects(): Effect[];
13287
13560
  /**
13561
+ * @beta
13288
13562
  * @remarks
13289
13563
  * Returns a potential set of entities from the direction that
13290
13564
  * this player is looking at.
@@ -13293,6 +13567,7 @@ export class Player extends Entity {
13293
13567
  */
13294
13568
  getEntitiesFromViewDirection(options?: EntityRaycastOptions): Entity[];
13295
13569
  /**
13570
+ * @beta
13296
13571
  * @remarks
13297
13572
  * Gets the current item cooldown time for a particular
13298
13573
  * cooldown category.
@@ -13303,12 +13578,15 @@ export class Player extends Entity {
13303
13578
  */
13304
13579
  getItemCooldown(itemCategory: string): number;
13305
13580
  /**
13581
+ * @beta
13306
13582
  * @remarks
13307
13583
  * Returns all tags associated with an entity.
13308
13584
  * @throws This function can throw errors.
13309
13585
  */
13310
13586
  getTags(): string[];
13587
+ getTotalXp(): number;
13311
13588
  /**
13589
+ * @beta
13312
13590
  * @remarks
13313
13591
  * Returns true if the specified component is present on this
13314
13592
  * entity.
@@ -13319,6 +13597,7 @@ export class Player extends Entity {
13319
13597
  */
13320
13598
  hasComponent(componentId: string): boolean;
13321
13599
  /**
13600
+ * @beta
13322
13601
  * @remarks
13323
13602
  * Tests whether an entity has a particular tag.
13324
13603
  * @param tag
@@ -13327,18 +13606,21 @@ export class Player extends Entity {
13327
13606
  */
13328
13607
  hasTag(tag: string): boolean;
13329
13608
  /**
13609
+ * @beta
13330
13610
  * @remarks
13331
13611
  * Returns true if this player has operator-level permissions.
13332
13612
  * @throws This function can throw errors.
13333
13613
  */
13334
13614
  isOp(): boolean;
13335
13615
  /**
13616
+ * @beta
13336
13617
  * @remarks
13337
13618
  * Kills this entity. The entity will drop loot as normal.
13338
13619
  * @throws This function can throw errors.
13339
13620
  */
13340
13621
  kill(): void;
13341
13622
  /**
13623
+ * @beta
13342
13624
  * @remarks
13343
13625
  * Plays a sound that only this particular player can hear.
13344
13626
  * @param soundID
@@ -13349,6 +13631,7 @@ export class Player extends Entity {
13349
13631
  */
13350
13632
  playSound(soundID: string, soundOptions?: SoundOptions): void;
13351
13633
  /**
13634
+ * @beta
13352
13635
  * @remarks
13353
13636
  * This is an internal-facing method for posting a system
13354
13637
  * message to downstream clients.
@@ -13358,6 +13641,7 @@ export class Player extends Entity {
13358
13641
  */
13359
13642
  postClientMessage(id: string, value: string): void;
13360
13643
  /**
13644
+ * @beta
13361
13645
  * @remarks
13362
13646
  * Removes a specified property.
13363
13647
  * @param identifier
@@ -13365,6 +13649,7 @@ export class Player extends Entity {
13365
13649
  */
13366
13650
  removeDynamicProperty(identifier: string): boolean;
13367
13651
  /**
13652
+ * @beta
13368
13653
  * @remarks
13369
13654
  * Removes a specified tag from an entity.
13370
13655
  * @param tag
@@ -13372,6 +13657,7 @@ export class Player extends Entity {
13372
13657
  * @throws This function can throw errors.
13373
13658
  */
13374
13659
  removeTag(tag: string): boolean;
13660
+ resetLevel(): void;
13375
13661
  /**
13376
13662
  * @remarks
13377
13663
  * Runs a particular command asynchronously from the context of
@@ -13387,6 +13673,7 @@ export class Player extends Entity {
13387
13673
  */
13388
13674
  runCommandAsync(commandString: string): Promise<CommandResult>;
13389
13675
  /**
13676
+ * @beta
13390
13677
  * @remarks
13391
13678
  * Sets a specified property to a value.
13392
13679
  * @param identifier
@@ -13397,6 +13684,7 @@ export class Player extends Entity {
13397
13684
  setDynamicProperty(identifier: string, value: boolean | number | string): void;
13398
13685
  setOnFire(seconds: number, useEffects?: boolean): boolean;
13399
13686
  /**
13687
+ * @beta
13400
13688
  * @remarks
13401
13689
  * Will change the specified players permissions, and whether
13402
13690
  * they are operator or not.
@@ -13405,6 +13693,7 @@ export class Player extends Entity {
13405
13693
  */
13406
13694
  setOp(isOp: boolean): void;
13407
13695
  /**
13696
+ * @beta
13408
13697
  * @remarks
13409
13698
  * Sets the main rotation of the entity.
13410
13699
  * @param degreesX
@@ -13413,6 +13702,7 @@ export class Player extends Entity {
13413
13702
  */
13414
13703
  setRotation(degreesX: number, degreesY: number): void;
13415
13704
  /**
13705
+ * @beta
13416
13706
  * @remarks
13417
13707
  * Sets a velocity for the entity to move with.
13418
13708
  * @param velocity
@@ -13421,6 +13711,7 @@ export class Player extends Entity {
13421
13711
  */
13422
13712
  setVelocity(velocity: Vector3): void;
13423
13713
  /**
13714
+ * @beta
13424
13715
  * @remarks
13425
13716
  * Sets the item cooldown time for a particular cooldown
13426
13717
  * category.
@@ -13433,6 +13724,7 @@ export class Player extends Entity {
13433
13724
  */
13434
13725
  startItemCooldown(itemCategory: string, tickDuration: number): void;
13435
13726
  /**
13727
+ * @beta
13436
13728
  * @remarks
13437
13729
  * Teleports the selected player to a new location
13438
13730
  * @param location
@@ -13454,6 +13746,7 @@ export class Player extends Entity {
13454
13746
  keepVelocity?: boolean,
13455
13747
  ): void;
13456
13748
  /**
13749
+ * @beta
13457
13750
  * @remarks
13458
13751
  * Teleports the selected player to a new location, and will
13459
13752
  * have the player facing a specified location.
@@ -13468,14 +13761,16 @@ export class Player extends Entity {
13468
13761
  */
13469
13762
  teleportFacing(location: Vector3, dimension: Dimension, facingLocation: Vector3, keepVelocity?: boolean): void;
13470
13763
  /**
13764
+ * @beta
13471
13765
  * @remarks
13472
13766
  * Sends a message that is displayed on the connected client
13473
13767
  * for this player.
13474
13768
  * @param message
13475
13769
  * @throws This function can throw errors.
13476
13770
  */
13477
- tell(message: RawMessage | string): void;
13771
+ tell(message: (RawMessage | string)[] | RawMessage | string): void;
13478
13772
  /**
13773
+ * @beta
13479
13774
  * @remarks
13480
13775
  * Triggers an entity type event. For every entity, a number of
13481
13776
  * events are defined in an entities' definition for key entity
@@ -13489,6 +13784,7 @@ export class Player extends Entity {
13489
13784
  triggerEvent(eventName: string): void;
13490
13785
  }
13491
13786
  /**
13787
+ * @beta
13492
13788
  * Represents the inventory of a {@link Player} in the world.
13493
13789
  */
13494
13790
  export class PlayerInventoryComponentContainer extends InventoryComponentContainer {
@@ -13584,6 +13880,7 @@ export class PlayerInventoryComponentContainer extends InventoryComponentContain
13584
13880
  transferItem(fromSlot: number, toSlot: number, toContainer: Container): boolean;
13585
13881
  }
13586
13882
  /**
13883
+ * @beta
13587
13884
  * This type is usable for iterating over a set of players.
13588
13885
  * This means it can be used in statements like for...of
13589
13886
  * statements, Array.from(iterator), and more.
@@ -13600,6 +13897,7 @@ export class PlayerIterator implements Iterable<Player> {
13600
13897
  next(): IteratorResult<Player>;
13601
13898
  }
13602
13899
  /**
13900
+ * @beta
13603
13901
  * Contains information regarding a player that has joined.
13604
13902
  * See the playerSpawn event for more detailed information that
13605
13903
  * could be returned after the first time a player has spawned
@@ -13617,6 +13915,7 @@ export class PlayerJoinEvent {
13617
13915
  readonly playerName: string;
13618
13916
  }
13619
13917
  /**
13918
+ * @beta
13620
13919
  * Manages callbacks that are connected to a player joining the
13621
13920
  * world.
13622
13921
  */
@@ -13639,6 +13938,7 @@ export class PlayerJoinEventSignal {
13639
13938
  unsubscribe(callback: (arg: PlayerJoinEvent) => void): void;
13640
13939
  }
13641
13940
  /**
13941
+ * @beta
13642
13942
  * Contains information regarding a player that has left the
13643
13943
  * world.
13644
13944
  */
@@ -13655,6 +13955,7 @@ export class PlayerLeaveEvent {
13655
13955
  readonly playerName: string;
13656
13956
  }
13657
13957
  /**
13958
+ * @beta
13658
13959
  * Manages callbacks that are connected to a player leaving the
13659
13960
  * world.
13660
13961
  */
@@ -13677,6 +13978,7 @@ export class PlayerLeaveEventSignal {
13677
13978
  unsubscribe(callback: (arg: PlayerLeaveEvent) => void): void;
13678
13979
  }
13679
13980
  /**
13981
+ * @beta
13680
13982
  * An event that contains more information about a player
13681
13983
  * spawning.
13682
13984
  */
@@ -13693,6 +13995,7 @@ export class PlayerSpawnEvent {
13693
13995
  player: Player;
13694
13996
  }
13695
13997
  /**
13998
+ * @beta
13696
13999
  * Registers an event when a player is spawned (or re-spawned
13697
14000
  * after death) and fully ready within the world.
13698
14001
  */
@@ -13714,6 +14017,7 @@ export class PlayerSpawnEventSignal {
13714
14017
  unsubscribe(callback: (arg: PlayerSpawnEvent) => void): void;
13715
14018
  }
13716
14019
  /**
14020
+ * @beta
13717
14021
  * Contains information related to a projectile hitting an
13718
14022
  * entity or block.
13719
14023
  */
@@ -13751,6 +14055,7 @@ export class ProjectileHitEvent {
13751
14055
  readonly source: Entity;
13752
14056
  }
13753
14057
  /**
14058
+ * @beta
13754
14059
  * Manages callbacks that are connected to when a projectile
13755
14060
  * hits an entity or block.
13756
14061
  */
@@ -13773,6 +14078,7 @@ export class ProjectileHitEventSignal {
13773
14078
  unsubscribe(callback: (arg: ProjectileHitEvent) => void): void;
13774
14079
  }
13775
14080
  /**
14081
+ * @beta
13776
14082
  * Provides methods that should be used within the World
13777
14083
  * Initialize event to register dynamic properties that can be
13778
14084
  * used and stored within Minecraft.
@@ -13800,6 +14106,7 @@ export class PropertyRegistry {
13800
14106
  registerWorldDynamicProperties(propertiesDefinition: DynamicPropertiesDefinition): void;
13801
14107
  }
13802
14108
  /**
14109
+ * @beta
13803
14110
  * Contains objectives and participants for the scoreboard.
13804
14111
  */
13805
14112
  export class Scoreboard {
@@ -13846,6 +14153,7 @@ export class Scoreboard {
13846
14153
  * @throws This function can throw errors.
13847
14154
  */
13848
14155
  getParticipants(): ScoreboardIdentity[];
14156
+ getScore(objective: ScoreboardObjective, participant: ScoreboardIdentity): number;
13849
14157
  /**
13850
14158
  * @remarks
13851
14159
  * Removes an objective from the scoreboard.
@@ -13865,8 +14173,10 @@ export class Scoreboard {
13865
14173
  displaySlotId: string,
13866
14174
  objectiveDisplaySetting: ScoreboardObjectiveDisplayOptions,
13867
14175
  ): ScoreboardObjective;
14176
+ setScore(objective: ScoreboardObjective, participant: ScoreboardIdentity, score: number): boolean;
13868
14177
  }
13869
14178
  /**
14179
+ * @beta
13870
14180
  * Contains an identity of the scoreboard item.
13871
14181
  */
13872
14182
  export class ScoreboardIdentity {
@@ -13890,8 +14200,12 @@ export class ScoreboardIdentity {
13890
14200
  * @throws This function can throw errors.
13891
14201
  */
13892
14202
  getEntity(): Entity;
14203
+ getScore(objective: ScoreboardObjective): number;
14204
+ removeFromObjective(objective: ScoreboardObjective): boolean;
14205
+ setScore(objective: ScoreboardObjective, score: number): boolean;
13893
14206
  }
13894
14207
  /**
14208
+ * @beta
13895
14209
  * Contains objectives and participants for the scoreboard.
13896
14210
  */
13897
14211
  export class ScoreboardObjective {
@@ -13927,8 +14241,11 @@ export class ScoreboardObjective {
13927
14241
  * @throws This function can throw errors.
13928
14242
  */
13929
14243
  getScores(): ScoreboardScoreInfo[];
14244
+ removeParticipant(participant: ScoreboardIdentity): boolean;
14245
+ setScore(participant: ScoreboardIdentity, score: number): boolean;
13930
14246
  }
13931
14247
  /**
14248
+ * @beta
13932
14249
  * Contains a pair of a scoreboard participant and its
13933
14250
  * respective score.
13934
14251
  */
@@ -13944,6 +14261,7 @@ export class ScoreboardScoreInfo {
13944
14261
  readonly score: number;
13945
14262
  }
13946
14263
  /**
14264
+ * @beta
13947
14265
  * Contains information about user interface elements that are
13948
14266
  * showing up on the screen.
13949
14267
  */
@@ -13992,6 +14310,7 @@ export class ScriptEventCommandMessageEvent {
13992
14310
  readonly sourceType: MessageSourceType;
13993
14311
  }
13994
14312
  /**
14313
+ * @beta
13995
14314
  * Allows for registering an event handler that responds to
13996
14315
  * inbound /scriptevent commands.
13997
14316
  */
@@ -14016,6 +14335,7 @@ export class ScriptEventCommandMessageSignal {
14016
14335
  unsubscribe(callback: (arg: ScriptEventCommandMessageEvent) => void): void;
14017
14336
  }
14018
14337
  /**
14338
+ * @beta
14019
14339
  * Describes a particular seating position on this rideable
14020
14340
  * entity.
14021
14341
  */
@@ -14042,6 +14362,7 @@ export class Seat {
14042
14362
  readonly position: Location;
14043
14363
  }
14044
14364
  /**
14365
+ * @beta
14045
14366
  * Manages callbacks that are message passing to a server. This
14046
14367
  * event is not currently fully implemented, and should not be
14047
14368
  * used.
@@ -14065,6 +14386,7 @@ export class ServerMessageSignal {
14065
14386
  unsubscribe(callback: (arg: MessageReceiveEvent) => void): void;
14066
14387
  }
14067
14388
  /**
14389
+ * @beta
14068
14390
  * Contains the state of a string-based property for a {@link
14069
14391
  * BlockPermutation}.
14070
14392
  */
@@ -14093,15 +14415,18 @@ export class StringBlockProperty extends IBlockProperty {
14093
14415
  export class System {
14094
14416
  protected constructor();
14095
14417
  /**
14418
+ * @beta
14096
14419
  * Represents the current world tick of the server.
14097
14420
  */
14098
14421
  readonly currentTick: number;
14099
14422
  /**
14423
+ * @beta
14100
14424
  * Contains a set of events that are applicable for the
14101
14425
  * lifecycle of items in the Minecraft system.
14102
14426
  */
14103
14427
  readonly events: SystemEvents;
14104
14428
  /**
14429
+ * @beta
14105
14430
  * @remarks
14106
14431
  * Cancels the execution of a function run that was previously
14107
14432
  * scheduled via the `run` function.
@@ -14109,6 +14434,7 @@ export class System {
14109
14434
  */
14110
14435
  clearRun(runId: number): void;
14111
14436
  /**
14437
+ * @beta
14112
14438
  * @remarks
14113
14439
  * Cancels the execution of a scheduled function run that was
14114
14440
  * previously scheduled via the `runSchedule` function.
@@ -14129,6 +14455,7 @@ export class System {
14129
14455
  */
14130
14456
  run(callback: () => void): number;
14131
14457
  /**
14458
+ * @beta
14132
14459
  * @remarks
14133
14460
  * Runs a specified function at a scheduled interval. This is
14134
14461
  * frequently used to implement delayed behaviors and game
@@ -14146,6 +14473,7 @@ export class System {
14146
14473
  runSchedule(callback: () => void, tickInterval?: number): number;
14147
14474
  }
14148
14475
  /**
14476
+ * @beta
14149
14477
  * Contains a set of events that are available across the scope
14150
14478
  * of the Minecraft add-on system.
14151
14479
  */
@@ -14167,6 +14495,7 @@ export class SystemEvents {
14167
14495
  readonly scriptEventReceive: ScriptEventCommandMessageSignal;
14168
14496
  }
14169
14497
  /**
14498
+ * @beta
14170
14499
  * An event for handling updates, that fires 20 times every
14171
14500
  * second.
14172
14501
  */
@@ -14182,6 +14511,7 @@ export class TickEvent {
14182
14511
  readonly deltaTime: number;
14183
14512
  }
14184
14513
  /**
14514
+ * @beta
14185
14515
  * Manages callbacks that are connected to a tick event.
14186
14516
  */
14187
14517
  export class TickEventSignal {
@@ -14201,6 +14531,7 @@ export class TickEventSignal {
14201
14531
  unsubscribe(callback: (arg: TickEvent) => void): void;
14202
14532
  }
14203
14533
  /**
14534
+ * @beta
14204
14535
  * Represents a trigger for firing an event.
14205
14536
  */
14206
14537
  export class Trigger {
@@ -14211,6 +14542,7 @@ export class Trigger {
14211
14542
  constructor(eventName: string);
14212
14543
  }
14213
14544
  /**
14545
+ * @beta
14214
14546
  * Contains a description of a vector.
14215
14547
  */
14216
14548
  export class Vector {
@@ -14371,6 +14703,7 @@ export class Vector {
14371
14703
  static subtract(a: Vector3, b: Vector3): Vector;
14372
14704
  }
14373
14705
  /**
14706
+ * @beta
14374
14707
  * Contains information related to changes in weather in the
14375
14708
  * environment.
14376
14709
  */
@@ -14390,6 +14723,7 @@ export class WeatherChangeEvent {
14390
14723
  readonly raining: boolean;
14391
14724
  }
14392
14725
  /**
14726
+ * @beta
14393
14727
  * Manages callbacks that are connected to weather changing.
14394
14728
  */
14395
14729
  export class WeatherChangeEventSignal {
@@ -14415,16 +14749,19 @@ export class WeatherChangeEventSignal {
14415
14749
  export class World {
14416
14750
  protected constructor();
14417
14751
  /**
14752
+ * @beta
14418
14753
  * Contains a set of events that are applicable to the entirety
14419
14754
  * of the world.
14420
14755
  */
14421
14756
  readonly events: Events;
14422
14757
  /**
14758
+ * @beta
14423
14759
  * Returns the general global scoreboard that applies to the
14424
14760
  * world.
14425
14761
  */
14426
14762
  readonly scoreboard: Scoreboard;
14427
14763
  /**
14764
+ * @beta
14428
14765
  * @remarks
14429
14766
  * A method that is internal-only, used for broadcasting
14430
14767
  * specific messages between client and server.
@@ -14433,6 +14770,7 @@ export class World {
14433
14770
  */
14434
14771
  broadcastClientMessage(id: string, value: string): void;
14435
14772
  /**
14773
+ * @beta
14436
14774
  * @remarks
14437
14775
  * Returns the absolute time since the start of the world.
14438
14776
  */
@@ -14454,6 +14792,7 @@ export class World {
14454
14792
  */
14455
14793
  getDimension(dimensionId: string): Dimension;
14456
14794
  /**
14795
+ * @beta
14457
14796
  * @remarks
14458
14797
  * Returns a property value.
14459
14798
  * @param identifier
@@ -14462,8 +14801,9 @@ export class World {
14462
14801
  * property has not been set.
14463
14802
  * @throws This function can throw errors.
14464
14803
  */
14465
- getDynamicProperty(identifier: string): boolean | number | string;
14804
+ getDynamicProperty(identifier: string): boolean | number | string | undefined;
14466
14805
  /**
14806
+ * @beta
14467
14807
  * @remarks
14468
14808
  * Returns all players currently in the world.
14469
14809
  * @param options
@@ -14473,11 +14813,13 @@ export class World {
14473
14813
  */
14474
14814
  getPlayers(options?: EntityQueryOptions): PlayerIterator;
14475
14815
  /**
14816
+ * @beta
14476
14817
  * @remarks
14477
14818
  * Sets the current game time of the day.
14478
14819
  */
14479
14820
  getTime(): number;
14480
14821
  /**
14822
+ * @beta
14481
14823
  * @remarks
14482
14824
  * Plays a particular music track for all players.
14483
14825
  * @param trackID
@@ -14485,6 +14827,7 @@ export class World {
14485
14827
  */
14486
14828
  playMusic(trackID: string, musicOptions?: MusicOptions): void;
14487
14829
  /**
14830
+ * @beta
14488
14831
  * @remarks
14489
14832
  * Plays a sound for all players.
14490
14833
  * @param soundID
@@ -14492,6 +14835,7 @@ export class World {
14492
14835
  */
14493
14836
  playSound(soundID: string, soundOptions?: SoundOptions): void;
14494
14837
  /**
14838
+ * @beta
14495
14839
  * @remarks
14496
14840
  * Queues an additional music track for players. If a track is
14497
14841
  * not playing, a music track will play.
@@ -14500,6 +14844,7 @@ export class World {
14500
14844
  */
14501
14845
  queueMusic(trackID: string, musicOptions?: MusicOptions): void;
14502
14846
  /**
14847
+ * @beta
14503
14848
  * @remarks
14504
14849
  * Removes a specified property.
14505
14850
  * @param identifier
@@ -14507,14 +14852,16 @@ export class World {
14507
14852
  */
14508
14853
  removeDynamicProperty(identifier: string): boolean;
14509
14854
  /**
14855
+ * @beta
14510
14856
  * @remarks
14511
14857
  * Broadcasts a message that is displayed on all connected
14512
14858
  * clients.
14513
14859
  * @param message
14514
14860
  * @throws This function can throw errors.
14515
14861
  */
14516
- say(message: RawMessage | string): void;
14862
+ say(message: (RawMessage | string)[] | RawMessage | string): void;
14517
14863
  /**
14864
+ * @beta
14518
14865
  * @remarks
14519
14866
  * Sets a specified property to a value.
14520
14867
  * @param identifier
@@ -14524,18 +14871,21 @@ export class World {
14524
14871
  */
14525
14872
  setDynamicProperty(identifier: string, value: boolean | number | string): void;
14526
14873
  /**
14874
+ * @beta
14527
14875
  * @remarks
14528
14876
  * Returns the current game time of the day.
14529
14877
  * @param timeOfDay
14530
14878
  */
14531
14879
  setTime(timeOfDay: number): void;
14532
14880
  /**
14881
+ * @beta
14533
14882
  * @remarks
14534
14883
  * Stops any music tracks from playing.
14535
14884
  */
14536
14885
  stopMusic(): void;
14537
14886
  }
14538
14887
  /**
14888
+ * @beta
14539
14889
  * Contains information and methods that can be used at the
14540
14890
  * initialization of the scripting environment for a World.
14541
14891
  * Also, use the supplied propertyRegistry object to register
@@ -14566,6 +14916,7 @@ export class WorldInitializeEvent {
14566
14916
  readonly propertyRegistry: PropertyRegistry;
14567
14917
  }
14568
14918
  /**
14919
+ * @beta
14569
14920
  * Manages callbacks that are run at the initialization of the
14570
14921
  * scripting environment for a World. Do note that this event
14571
14922
  * may run multiple times within a session in the case that the
@@ -14590,6 +14941,7 @@ export class WorldInitializeEventSignal {
14590
14941
  unsubscribe(callback: (arg: WorldInitializeEvent) => void): void;
14591
14942
  }
14592
14943
  /**
14944
+ * @beta
14593
14945
  * Represents a rotation structure with pitch and yaw
14594
14946
  * components.
14595
14947
  */
@@ -14604,7 +14956,11 @@ export class XYRotation {
14604
14956
  */
14605
14957
  y: number;
14606
14958
  }
14959
+ export interface BlockFillOptions {
14960
+ matchingBlock?: BlockPermutation;
14961
+ }
14607
14962
  /**
14963
+ * @beta
14608
14964
  * Contains additional options for configuring a block raycast
14609
14965
  * query.
14610
14966
  */
@@ -14624,7 +14980,13 @@ export interface BlockRaycastOptions {
14624
14980
  */
14625
14981
  maxDistance?: number;
14626
14982
  }
14983
+ export interface EntityDamageSource {
14984
+ cause: EntityDamageCause;
14985
+ damagingEntity?: Entity;
14986
+ damagingProjectile?: Entity;
14987
+ }
14627
14988
  /**
14989
+ * @beta
14628
14990
  * Specifies additional filters that are used in registering a
14629
14991
  * data driven trigger event for entities.
14630
14992
  */
@@ -14647,6 +15009,7 @@ export interface EntityDataDrivenTriggerEventOptions {
14647
15009
  eventTypes?: string[];
14648
15010
  }
14649
15011
  /**
15012
+ * @beta
14650
15013
  * Contains optional parameters for registering an entity
14651
15014
  * event.
14652
15015
  */
@@ -14663,6 +15026,7 @@ export interface EntityEventOptions {
14663
15026
  entityTypes?: string[];
14664
15027
  }
14665
15028
  /**
15029
+ * @beta
14666
15030
  * Contains options for selecting entities within an area.
14667
15031
  */
14668
15032
  export interface EntityQueryOptions {
@@ -14785,6 +15149,7 @@ export interface EntityQueryOptions {
14785
15149
  volume?: BlockAreaSize;
14786
15150
  }
14787
15151
  /**
15152
+ * @beta
14788
15153
  * Contains additional options for filtering players based on
14789
15154
  * their score for an objective.
14790
15155
  */
@@ -14810,6 +15175,7 @@ export interface EntityQueryScoreOptions {
14810
15175
  objective?: string;
14811
15176
  }
14812
15177
  /**
15178
+ * @beta
14813
15179
  * Contains additional options for an entity raycast operation.
14814
15180
  */
14815
15181
  export interface EntityRaycastOptions {
@@ -14819,6 +15185,7 @@ export interface EntityRaycastOptions {
14819
15185
  maxDistance?: number;
14820
15186
  }
14821
15187
  /**
15188
+ * @beta
14822
15189
  * Additional configuration options for the {@link
14823
15190
  * Dimension.createExplosion} method.
14824
15191
  */
@@ -14843,6 +15210,7 @@ export interface ExplosionOptions {
14843
15210
  source?: Entity;
14844
15211
  }
14845
15212
  /**
15213
+ * @beta
14846
15214
  * Additional configuration options for {@link
14847
15215
  * World.playMusic}/{@link World.queueMusic} methods.
14848
15216
  */
@@ -14864,9 +15232,10 @@ export interface RawMessage {
14864
15232
  rawtext?: (RawMessage | string)[];
14865
15233
  text?: string;
14866
15234
  translate?: string;
14867
- with?: (RawMessage | string)[];
15235
+ with?: string[] | RawMessage;
14868
15236
  }
14869
15237
  /**
15238
+ * @beta
14870
15239
  * Contains additional options for how a scoreboard should be
14871
15240
  * displayed within its display slot.
14872
15241
  */
@@ -14884,6 +15253,7 @@ export interface ScriptEventMessageFilterOptions {
14884
15253
  namespaces: string[];
14885
15254
  }
14886
15255
  /**
15256
+ * @beta
14887
15257
  * Additional configuration options for the {@link
14888
15258
  * Player.playSound}/{@link World.playSound} method.
14889
15259
  */
@@ -14902,6 +15272,7 @@ export interface SoundOptions {
14902
15272
  volume?: number;
14903
15273
  }
14904
15274
  /**
15275
+ * @beta
14905
15276
  * Contains additional options for displaying a title and
14906
15277
  * optional subtitle.
14907
15278
  */
@@ -14924,6 +15295,7 @@ export interface TitleDisplayOptions {
14924
15295
  subtitle?: string;
14925
15296
  }
14926
15297
  /**
15298
+ * @beta
14927
15299
  * Contains a description of a vector.
14928
15300
  */
14929
15301
  export interface Vector3 {
@@ -14942,6 +15314,7 @@ export interface Vector3 {
14942
15314
  }
14943
15315
  export const TicksPerDay = 24000;
14944
15316
  /**
15317
+ * @beta
14945
15318
  * How many times the server ticks per second of real time.
14946
15319
  */
14947
15320
  export const TicksPerSecond = 20;