@minecraft/server 2.0.0-beta.1.21.80-preview.28 → 2.1.0-beta.1.21.90-preview.20
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.
- package/index.d.ts +372 -135
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* ```json
|
|
17
17
|
* {
|
|
18
18
|
* "module_name": "@minecraft/server",
|
|
19
|
-
* "version": "2.
|
|
19
|
+
* "version": "2.1.0-beta"
|
|
20
20
|
* }
|
|
21
21
|
* ```
|
|
22
22
|
*
|
|
@@ -1451,13 +1451,15 @@ export enum FluidType {
|
|
|
1451
1451
|
*/
|
|
1452
1452
|
export enum GameMode {
|
|
1453
1453
|
/**
|
|
1454
|
+
* @rc
|
|
1454
1455
|
* @remarks
|
|
1455
1456
|
* World is in a more locked-down experience, where blocks may
|
|
1456
1457
|
* not be manipulated.
|
|
1457
1458
|
*
|
|
1458
1459
|
*/
|
|
1459
|
-
|
|
1460
|
+
Adventure = 'Adventure',
|
|
1460
1461
|
/**
|
|
1462
|
+
* @rc
|
|
1461
1463
|
* @remarks
|
|
1462
1464
|
* World is in a full creative mode. In creative mode, the
|
|
1463
1465
|
* player has all the resources available in the item selection
|
|
@@ -1468,8 +1470,9 @@ export enum GameMode {
|
|
|
1468
1470
|
* disappear.
|
|
1469
1471
|
*
|
|
1470
1472
|
*/
|
|
1471
|
-
|
|
1473
|
+
Creative = 'Creative',
|
|
1472
1474
|
/**
|
|
1475
|
+
* @rc
|
|
1473
1476
|
* @remarks
|
|
1474
1477
|
* World is in spectator mode. In spectator mode, spectators
|
|
1475
1478
|
* are always flying and cannot become grounded. Spectators can
|
|
@@ -1480,8 +1483,9 @@ export enum GameMode {
|
|
|
1480
1483
|
* transparent floating head.
|
|
1481
1484
|
*
|
|
1482
1485
|
*/
|
|
1483
|
-
|
|
1486
|
+
Spectator = 'Spectator',
|
|
1484
1487
|
/**
|
|
1488
|
+
* @rc
|
|
1485
1489
|
* @remarks
|
|
1486
1490
|
* World is in a survival mode, where players can take damage
|
|
1487
1491
|
* and entities may not be peaceful. Survival mode is where the
|
|
@@ -1490,7 +1494,7 @@ export enum GameMode {
|
|
|
1490
1494
|
* time, chip away at player health and hunger bar.
|
|
1491
1495
|
*
|
|
1492
1496
|
*/
|
|
1493
|
-
|
|
1497
|
+
Survival = 'Survival',
|
|
1494
1498
|
}
|
|
1495
1499
|
|
|
1496
1500
|
/**
|
|
@@ -1754,7 +1758,7 @@ export enum GameRule {
|
|
|
1754
1758
|
}
|
|
1755
1759
|
|
|
1756
1760
|
/**
|
|
1757
|
-
* @
|
|
1761
|
+
* @rc
|
|
1758
1762
|
* Describes the graphics mode of a client. Used by {@link
|
|
1759
1763
|
* Player.graphicsMode}
|
|
1760
1764
|
*/
|
|
@@ -2314,6 +2318,25 @@ export enum PlatformType {
|
|
|
2314
2318
|
Mobile = 'Mobile',
|
|
2315
2319
|
}
|
|
2316
2320
|
|
|
2321
|
+
/**
|
|
2322
|
+
* @beta
|
|
2323
|
+
* Specifies the player inventory type.
|
|
2324
|
+
*/
|
|
2325
|
+
export enum PlayerInventoryType {
|
|
2326
|
+
/**
|
|
2327
|
+
* @remarks
|
|
2328
|
+
* Hotbar inventory.
|
|
2329
|
+
*
|
|
2330
|
+
*/
|
|
2331
|
+
Hotbar = 'Hotbar',
|
|
2332
|
+
/**
|
|
2333
|
+
* @remarks
|
|
2334
|
+
* Main inventory.
|
|
2335
|
+
*
|
|
2336
|
+
*/
|
|
2337
|
+
Inventory = 'Inventory',
|
|
2338
|
+
}
|
|
2339
|
+
|
|
2317
2340
|
/**
|
|
2318
2341
|
* Contains objectives and participants for the scoreboard.
|
|
2319
2342
|
*/
|
|
@@ -3312,7 +3335,7 @@ export class Block {
|
|
|
3312
3335
|
*/
|
|
3313
3336
|
readonly isSolid: boolean;
|
|
3314
3337
|
/**
|
|
3315
|
-
* @
|
|
3338
|
+
* @rc
|
|
3316
3339
|
* @remarks
|
|
3317
3340
|
* Returns true if this reference to a block is still valid
|
|
3318
3341
|
* (for example, if the block is unloaded, references to that
|
|
@@ -4033,22 +4056,23 @@ export class BlockComponentOnPlaceEvent extends BlockEvent {
|
|
|
4033
4056
|
}
|
|
4034
4057
|
|
|
4035
4058
|
/**
|
|
4036
|
-
*
|
|
4037
|
-
*
|
|
4059
|
+
* @rc
|
|
4060
|
+
* Contains information regarding a specific block being broken
|
|
4061
|
+
* by a player.
|
|
4038
4062
|
*/
|
|
4039
4063
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
4040
|
-
export class
|
|
4064
|
+
export class BlockComponentPlayerBreakEvent extends BlockEvent {
|
|
4041
4065
|
private constructor();
|
|
4042
4066
|
/**
|
|
4043
4067
|
* @remarks
|
|
4044
4068
|
* Returns permutation information about this block before it
|
|
4045
|
-
* was
|
|
4069
|
+
* was broken.
|
|
4046
4070
|
*
|
|
4047
4071
|
*/
|
|
4048
|
-
readonly
|
|
4072
|
+
readonly brokenBlockPermutation: BlockPermutation;
|
|
4049
4073
|
/**
|
|
4050
4074
|
* @remarks
|
|
4051
|
-
* The player that
|
|
4075
|
+
* The player that broke this block.
|
|
4052
4076
|
*
|
|
4053
4077
|
*/
|
|
4054
4078
|
readonly player?: Player;
|
|
@@ -4190,12 +4214,13 @@ export class BlockComponentTickEvent extends BlockEvent {
|
|
|
4190
4214
|
}
|
|
4191
4215
|
|
|
4192
4216
|
/**
|
|
4193
|
-
* @
|
|
4217
|
+
* @rc
|
|
4194
4218
|
* An instance of a custom component on a block.
|
|
4195
4219
|
*/
|
|
4196
4220
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
4197
4221
|
export class BlockCustomComponentInstance extends BlockComponent {
|
|
4198
4222
|
private constructor();
|
|
4223
|
+
readonly customComponentParameters: CustomComponentParameters;
|
|
4199
4224
|
}
|
|
4200
4225
|
|
|
4201
4226
|
/**
|
|
@@ -5359,7 +5384,7 @@ export class ButtonPushAfterEvent extends BlockEvent {
|
|
|
5359
5384
|
export class ButtonPushAfterEventSignal {
|
|
5360
5385
|
private constructor();
|
|
5361
5386
|
/**
|
|
5362
|
-
* @
|
|
5387
|
+
* @rc
|
|
5363
5388
|
* @remarks
|
|
5364
5389
|
* Adds a callback that will be called when a button is pushed.
|
|
5365
5390
|
*
|
|
@@ -5370,7 +5395,7 @@ export class ButtonPushAfterEventSignal {
|
|
|
5370
5395
|
*/
|
|
5371
5396
|
subscribe(callback: (arg0: ButtonPushAfterEvent) => void): (arg0: ButtonPushAfterEvent) => void;
|
|
5372
5397
|
/**
|
|
5373
|
-
* @
|
|
5398
|
+
* @rc
|
|
5374
5399
|
* @remarks
|
|
5375
5400
|
* Removes a callback from being called when a button is
|
|
5376
5401
|
* pushed.
|
|
@@ -5640,7 +5665,7 @@ export class CommandResult {
|
|
|
5640
5665
|
export class Component {
|
|
5641
5666
|
private constructor();
|
|
5642
5667
|
/**
|
|
5643
|
-
* @
|
|
5668
|
+
* @rc
|
|
5644
5669
|
* @remarks
|
|
5645
5670
|
* Returns whether the component is valid. A component is
|
|
5646
5671
|
* considered valid if its owner is valid, in addition to any
|
|
@@ -6000,7 +6025,7 @@ export class Container {
|
|
|
6000
6025
|
*/
|
|
6001
6026
|
readonly emptySlotsCount: number;
|
|
6002
6027
|
/**
|
|
6003
|
-
* @
|
|
6028
|
+
* @rc
|
|
6004
6029
|
* @remarks
|
|
6005
6030
|
* Returns whether a container object (or the entity or block
|
|
6006
6031
|
* that this container is associated with) is still available
|
|
@@ -6067,7 +6092,20 @@ export class Container {
|
|
|
6067
6092
|
*
|
|
6068
6093
|
* {@link InvalidContainerError}
|
|
6069
6094
|
*/
|
|
6070
|
-
find(itemStack: ItemStack): number;
|
|
6095
|
+
find(itemStack: ItemStack): number | undefined;
|
|
6096
|
+
/**
|
|
6097
|
+
* @beta
|
|
6098
|
+
* @remarks
|
|
6099
|
+
* Find the index of the last instance of an item inside the
|
|
6100
|
+
* container
|
|
6101
|
+
*
|
|
6102
|
+
* @param itemStack
|
|
6103
|
+
* The item to find.
|
|
6104
|
+
* @throws This function can throw errors.
|
|
6105
|
+
*
|
|
6106
|
+
* {@link InvalidContainerError}
|
|
6107
|
+
*/
|
|
6108
|
+
findLast(itemStack: ItemStack): number | undefined;
|
|
6071
6109
|
/**
|
|
6072
6110
|
* @beta
|
|
6073
6111
|
* @remarks
|
|
@@ -6077,7 +6115,7 @@ export class Container {
|
|
|
6077
6115
|
*
|
|
6078
6116
|
* {@link InvalidContainerError}
|
|
6079
6117
|
*/
|
|
6080
|
-
firstEmptySlot(): number;
|
|
6118
|
+
firstEmptySlot(): number | undefined;
|
|
6081
6119
|
/**
|
|
6082
6120
|
* @beta
|
|
6083
6121
|
* @remarks
|
|
@@ -6087,7 +6125,7 @@ export class Container {
|
|
|
6087
6125
|
*
|
|
6088
6126
|
* {@link InvalidContainerError}
|
|
6089
6127
|
*/
|
|
6090
|
-
firstItem(): number;
|
|
6128
|
+
firstItem(): number | undefined;
|
|
6091
6129
|
/**
|
|
6092
6130
|
* @remarks
|
|
6093
6131
|
* Gets an {@link ItemStack} of the item at the specified slot.
|
|
@@ -6185,19 +6223,6 @@ export class Container {
|
|
|
6185
6223
|
* ```
|
|
6186
6224
|
*/
|
|
6187
6225
|
moveItem(fromSlot: number, toSlot: number, toContainer: Container): void;
|
|
6188
|
-
/**
|
|
6189
|
-
* @beta
|
|
6190
|
-
* @remarks
|
|
6191
|
-
* Find the index of the last instance of an item inside the
|
|
6192
|
-
* container
|
|
6193
|
-
*
|
|
6194
|
-
* @param itemStack
|
|
6195
|
-
* The item to find.
|
|
6196
|
-
* @throws This function can throw errors.
|
|
6197
|
-
*
|
|
6198
|
-
* {@link InvalidContainerError}
|
|
6199
|
-
*/
|
|
6200
|
-
reverseFind(itemStack: ItemStack): number;
|
|
6201
6226
|
/**
|
|
6202
6227
|
* @remarks
|
|
6203
6228
|
* Sets an item stack within a particular slot.
|
|
@@ -6314,7 +6339,7 @@ export class ContainerSlot {
|
|
|
6314
6339
|
*/
|
|
6315
6340
|
readonly isStackable: boolean;
|
|
6316
6341
|
/**
|
|
6317
|
-
* @
|
|
6342
|
+
* @rc
|
|
6318
6343
|
* @remarks
|
|
6319
6344
|
* Returns whether the ContainerSlot is valid. The container
|
|
6320
6345
|
* slot is valid if the container exists and is loaded, and the
|
|
@@ -6738,7 +6763,7 @@ export class CustomCommandRegistry {
|
|
|
6738
6763
|
}
|
|
6739
6764
|
|
|
6740
6765
|
/**
|
|
6741
|
-
* @
|
|
6766
|
+
* @rc
|
|
6742
6767
|
* Contains the custom component's JSON parameters
|
|
6743
6768
|
*/
|
|
6744
6769
|
export class CustomComponentParameters {
|
|
@@ -7524,6 +7549,26 @@ export class Dimension {
|
|
|
7524
7549
|
* ```
|
|
7525
7550
|
*/
|
|
7526
7551
|
spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
|
|
7552
|
+
/**
|
|
7553
|
+
* @beta
|
|
7554
|
+
* @remarks
|
|
7555
|
+
* Stops all sounds from playing for all players.
|
|
7556
|
+
*
|
|
7557
|
+
* This function can't be called in read-only mode.
|
|
7558
|
+
*
|
|
7559
|
+
*/
|
|
7560
|
+
stopAllSounds(): void;
|
|
7561
|
+
/**
|
|
7562
|
+
* @beta
|
|
7563
|
+
* @remarks
|
|
7564
|
+
* Stops a sound from playing for all players.
|
|
7565
|
+
*
|
|
7566
|
+
* This function can't be called in read-only mode.
|
|
7567
|
+
*
|
|
7568
|
+
* @param soundId
|
|
7569
|
+
* Identifier of the sound.
|
|
7570
|
+
*/
|
|
7571
|
+
stopSound(soundId: string): void;
|
|
7527
7572
|
}
|
|
7528
7573
|
|
|
7529
7574
|
/**
|
|
@@ -7595,7 +7640,7 @@ export class Effect {
|
|
|
7595
7640
|
*/
|
|
7596
7641
|
readonly duration: number;
|
|
7597
7642
|
/**
|
|
7598
|
-
* @
|
|
7643
|
+
* @rc
|
|
7599
7644
|
* @remarks
|
|
7600
7645
|
* Returns whether an effect instance is available for use in
|
|
7601
7646
|
* this context.
|
|
@@ -7913,7 +7958,7 @@ export class Entity {
|
|
|
7913
7958
|
*/
|
|
7914
7959
|
readonly isSwimming: boolean;
|
|
7915
7960
|
/**
|
|
7916
|
-
* @
|
|
7961
|
+
* @rc
|
|
7917
7962
|
* @remarks
|
|
7918
7963
|
* Returns whether the entity can be manipulated by script. A
|
|
7919
7964
|
* Player is considered valid when it's EntityLifetimeState is
|
|
@@ -8506,7 +8551,7 @@ export class Entity {
|
|
|
8506
8551
|
*/
|
|
8507
8552
|
kill(): boolean;
|
|
8508
8553
|
/**
|
|
8509
|
-
* @
|
|
8554
|
+
* @rc
|
|
8510
8555
|
* @remarks
|
|
8511
8556
|
* Sets the rotation of the entity to face a target location.
|
|
8512
8557
|
* Both pitch and yaw will be set, if applicable, such as for
|
|
@@ -9931,32 +9976,6 @@ export class EntityItemComponent extends EntityComponent {
|
|
|
9931
9976
|
static readonly componentId = 'minecraft:item';
|
|
9932
9977
|
}
|
|
9933
9978
|
|
|
9934
|
-
/**
|
|
9935
|
-
* @beta
|
|
9936
|
-
* This type is usable for iterating over a set of entities.
|
|
9937
|
-
* This means it can be used in statements like for...of
|
|
9938
|
-
* statements, Array.from(iterator), and more.
|
|
9939
|
-
*/
|
|
9940
|
-
export class EntityIterator implements Iterable<Entity> {
|
|
9941
|
-
private constructor();
|
|
9942
|
-
/**
|
|
9943
|
-
* @remarks
|
|
9944
|
-
* This function can't be called in read-only mode.
|
|
9945
|
-
*
|
|
9946
|
-
*/
|
|
9947
|
-
[Symbol.iterator](): Iterator<Entity>;
|
|
9948
|
-
/**
|
|
9949
|
-
* @remarks
|
|
9950
|
-
* Retrieves the next item in this iteration. The resulting
|
|
9951
|
-
* IteratorResult contains .done and .value properties which
|
|
9952
|
-
* can be used to see the next Entity in the iteration.
|
|
9953
|
-
*
|
|
9954
|
-
* This function can't be called in read-only mode.
|
|
9955
|
-
*
|
|
9956
|
-
*/
|
|
9957
|
-
next(): IteratorResult<Entity>;
|
|
9958
|
-
}
|
|
9959
|
-
|
|
9960
9979
|
/**
|
|
9961
9980
|
* Defines the base movement speed in lava of this entity.
|
|
9962
9981
|
*/
|
|
@@ -11343,26 +11362,6 @@ export class EntityTypeFamilyComponent extends EntityComponent {
|
|
|
11343
11362
|
hasTypeFamily(typeFamily: string): boolean;
|
|
11344
11363
|
}
|
|
11345
11364
|
|
|
11346
|
-
/**
|
|
11347
|
-
* @beta
|
|
11348
|
-
* An iterator that loops through available entity types.
|
|
11349
|
-
*/
|
|
11350
|
-
export class EntityTypeIterator implements Iterable<EntityType> {
|
|
11351
|
-
private constructor();
|
|
11352
|
-
/**
|
|
11353
|
-
* @remarks
|
|
11354
|
-
* This function can't be called in read-only mode.
|
|
11355
|
-
*
|
|
11356
|
-
*/
|
|
11357
|
-
[Symbol.iterator](): Iterator<EntityType>;
|
|
11358
|
-
/**
|
|
11359
|
-
* @remarks
|
|
11360
|
-
* This function can't be called in read-only mode.
|
|
11361
|
-
*
|
|
11362
|
-
*/
|
|
11363
|
-
next(): IteratorResult<EntityType>;
|
|
11364
|
-
}
|
|
11365
|
-
|
|
11366
11365
|
/**
|
|
11367
11366
|
* Used for accessing all entity types currently available for
|
|
11368
11367
|
* use within the world.
|
|
@@ -11599,14 +11598,6 @@ export class FeedItemEffect {
|
|
|
11599
11598
|
readonly name: string;
|
|
11600
11599
|
}
|
|
11601
11600
|
|
|
11602
|
-
/**
|
|
11603
|
-
* @beta
|
|
11604
|
-
* Represents a set of filters for when an event should occur.
|
|
11605
|
-
*/
|
|
11606
|
-
export class FilterGroup {
|
|
11607
|
-
private constructor();
|
|
11608
|
-
}
|
|
11609
|
-
|
|
11610
11601
|
/**
|
|
11611
11602
|
* Represents constants related to fluid containers.
|
|
11612
11603
|
*/
|
|
@@ -12328,12 +12319,13 @@ export class ItemCooldownComponent extends ItemComponent {
|
|
|
12328
12319
|
}
|
|
12329
12320
|
|
|
12330
12321
|
/**
|
|
12331
|
-
* @
|
|
12322
|
+
* @rc
|
|
12332
12323
|
* An instance of a custom component on an item.
|
|
12333
12324
|
*/
|
|
12334
12325
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
12335
12326
|
export class ItemCustomComponentInstance extends ItemComponent {
|
|
12336
12327
|
private constructor();
|
|
12328
|
+
readonly customComponentParameters: CustomComponentParameters;
|
|
12337
12329
|
}
|
|
12338
12330
|
|
|
12339
12331
|
/**
|
|
@@ -13736,7 +13728,7 @@ export class LeverActionAfterEvent extends BlockEvent {
|
|
|
13736
13728
|
export class LeverActionAfterEventSignal {
|
|
13737
13729
|
private constructor();
|
|
13738
13730
|
/**
|
|
13739
|
-
* @
|
|
13731
|
+
* @rc
|
|
13740
13732
|
* @remarks
|
|
13741
13733
|
* Adds a callback that will be called when a lever is moved
|
|
13742
13734
|
* (activates or deactivates).
|
|
@@ -13748,7 +13740,7 @@ export class LeverActionAfterEventSignal {
|
|
|
13748
13740
|
*/
|
|
13749
13741
|
subscribe(callback: (arg0: LeverActionAfterEvent) => void): (arg0: LeverActionAfterEvent) => void;
|
|
13750
13742
|
/**
|
|
13751
|
-
* @
|
|
13743
|
+
* @rc
|
|
13752
13744
|
* @remarks
|
|
13753
13745
|
* Removes a callback from being called when a lever is moved
|
|
13754
13746
|
* (activates or deactivates).
|
|
@@ -14035,7 +14027,7 @@ export class Player extends Entity {
|
|
|
14035
14027
|
*/
|
|
14036
14028
|
readonly clientSystemInfo: ClientSystemInfo;
|
|
14037
14029
|
/**
|
|
14038
|
-
* @
|
|
14030
|
+
* @rc
|
|
14039
14031
|
* @remarks
|
|
14040
14032
|
* Gets the current graphics mode of the player's client. This
|
|
14041
14033
|
* can be changed in the Video section of the settings menu
|
|
@@ -14565,6 +14557,18 @@ export class Player extends Entity {
|
|
|
14565
14557
|
* @throws This function can throw errors.
|
|
14566
14558
|
*/
|
|
14567
14559
|
startItemCooldown(cooldownCategory: string, tickDuration: number): void;
|
|
14560
|
+
/**
|
|
14561
|
+
* @beta
|
|
14562
|
+
* @remarks
|
|
14563
|
+
* Stops all sounds from playing for this particular player.
|
|
14564
|
+
*
|
|
14565
|
+
* This function can't be called in read-only mode.
|
|
14566
|
+
*
|
|
14567
|
+
* @throws This function can throw errors.
|
|
14568
|
+
*
|
|
14569
|
+
* {@link InvalidEntityError}
|
|
14570
|
+
*/
|
|
14571
|
+
stopAllSounds(): void;
|
|
14568
14572
|
/**
|
|
14569
14573
|
* @remarks
|
|
14570
14574
|
* Stops any music tracks from playing for this particular
|
|
@@ -14575,6 +14579,20 @@ export class Player extends Entity {
|
|
|
14575
14579
|
* @throws This function can throw errors.
|
|
14576
14580
|
*/
|
|
14577
14581
|
stopMusic(): void;
|
|
14582
|
+
/**
|
|
14583
|
+
* @beta
|
|
14584
|
+
* @remarks
|
|
14585
|
+
* Stops a sound from playing for this particular player.
|
|
14586
|
+
*
|
|
14587
|
+
* This function can't be called in read-only mode.
|
|
14588
|
+
*
|
|
14589
|
+
* @param soundId
|
|
14590
|
+
* Identifier of the sound.
|
|
14591
|
+
* @throws This function can throw errors.
|
|
14592
|
+
*
|
|
14593
|
+
* {@link InvalidEntityError}
|
|
14594
|
+
*/
|
|
14595
|
+
stopSound(soundId: string): void;
|
|
14578
14596
|
}
|
|
14579
14597
|
|
|
14580
14598
|
/**
|
|
@@ -15047,6 +15065,77 @@ export class PlayerGameModeChangeBeforeEventSignal {
|
|
|
15047
15065
|
unsubscribe(callback: (arg0: PlayerGameModeChangeBeforeEvent) => void): void;
|
|
15048
15066
|
}
|
|
15049
15067
|
|
|
15068
|
+
/**
|
|
15069
|
+
* @beta
|
|
15070
|
+
* Contains information regarding an event after changing the
|
|
15071
|
+
* selected hotbar slot for a player.
|
|
15072
|
+
*/
|
|
15073
|
+
export class PlayerHotbarSelectedSlotChangeAfterEvent {
|
|
15074
|
+
private constructor();
|
|
15075
|
+
/**
|
|
15076
|
+
* @remarks
|
|
15077
|
+
* The item stack of the new slot selected.
|
|
15078
|
+
*
|
|
15079
|
+
*/
|
|
15080
|
+
readonly itemStack?: ItemStack;
|
|
15081
|
+
/**
|
|
15082
|
+
* @remarks
|
|
15083
|
+
* The new hotbar slot index selected.
|
|
15084
|
+
*
|
|
15085
|
+
*/
|
|
15086
|
+
readonly newSlotSelected: number;
|
|
15087
|
+
/**
|
|
15088
|
+
* @remarks
|
|
15089
|
+
* Source Player for this event.
|
|
15090
|
+
*
|
|
15091
|
+
*/
|
|
15092
|
+
readonly player: Player;
|
|
15093
|
+
/**
|
|
15094
|
+
* @remarks
|
|
15095
|
+
* The previous hotbar slot index selected.
|
|
15096
|
+
*
|
|
15097
|
+
*/
|
|
15098
|
+
readonly previousSlotSelected: number;
|
|
15099
|
+
}
|
|
15100
|
+
|
|
15101
|
+
/**
|
|
15102
|
+
* @beta
|
|
15103
|
+
* Manages callbacks that are connected after a player selected
|
|
15104
|
+
* hotbar slot is changed.
|
|
15105
|
+
*/
|
|
15106
|
+
export class PlayerHotbarSelectedSlotChangeAfterEventSignal {
|
|
15107
|
+
private constructor();
|
|
15108
|
+
/**
|
|
15109
|
+
* @remarks
|
|
15110
|
+
* Adds a callback that will be called after a player selected
|
|
15111
|
+
* hotbar slot is changed.
|
|
15112
|
+
*
|
|
15113
|
+
* This function can't be called in read-only mode.
|
|
15114
|
+
*
|
|
15115
|
+
* This function can be called in early-execution mode.
|
|
15116
|
+
*
|
|
15117
|
+
* @param callback
|
|
15118
|
+
* Function callback that is called when this event fires.
|
|
15119
|
+
* @param options
|
|
15120
|
+
* Additional filtering options for the event subscription.
|
|
15121
|
+
*/
|
|
15122
|
+
subscribe(
|
|
15123
|
+
callback: (arg0: PlayerHotbarSelectedSlotChangeAfterEvent) => void,
|
|
15124
|
+
options?: HotbarEventOptions,
|
|
15125
|
+
): (arg0: PlayerHotbarSelectedSlotChangeAfterEvent) => void;
|
|
15126
|
+
/**
|
|
15127
|
+
* @remarks
|
|
15128
|
+
* Removes a callback from being called after a player selected
|
|
15129
|
+
* hotbar slot is changed.
|
|
15130
|
+
*
|
|
15131
|
+
* This function can't be called in read-only mode.
|
|
15132
|
+
*
|
|
15133
|
+
* This function can be called in early-execution mode.
|
|
15134
|
+
*
|
|
15135
|
+
*/
|
|
15136
|
+
unsubscribe(callback: (arg0: PlayerHotbarSelectedSlotChangeAfterEvent) => void): void;
|
|
15137
|
+
}
|
|
15138
|
+
|
|
15050
15139
|
/**
|
|
15051
15140
|
* Event data for when a player input mode changes.
|
|
15052
15141
|
*/
|
|
@@ -15493,28 +15582,79 @@ export class PlayerInteractWithEntityBeforeEventSignal {
|
|
|
15493
15582
|
|
|
15494
15583
|
/**
|
|
15495
15584
|
* @beta
|
|
15496
|
-
*
|
|
15497
|
-
*
|
|
15498
|
-
* statements, Array.from(iterator), and more.
|
|
15585
|
+
* Contains information regarding an event after a player's
|
|
15586
|
+
* inventory item changes.
|
|
15499
15587
|
*/
|
|
15500
|
-
export class
|
|
15588
|
+
export class PlayerInventoryItemChangeAfterEvent {
|
|
15501
15589
|
private constructor();
|
|
15502
15590
|
/**
|
|
15503
15591
|
* @remarks
|
|
15592
|
+
* The previous item stack.
|
|
15593
|
+
*
|
|
15594
|
+
*/
|
|
15595
|
+
readonly beforeItemStack?: ItemStack;
|
|
15596
|
+
/**
|
|
15597
|
+
* @remarks
|
|
15598
|
+
* Inventory type.
|
|
15599
|
+
*
|
|
15600
|
+
*/
|
|
15601
|
+
readonly inventoryType: PlayerInventoryType;
|
|
15602
|
+
/**
|
|
15603
|
+
* @remarks
|
|
15604
|
+
* The new item stack.
|
|
15605
|
+
*
|
|
15606
|
+
*/
|
|
15607
|
+
readonly itemStack?: ItemStack;
|
|
15608
|
+
/**
|
|
15609
|
+
* @remarks
|
|
15610
|
+
* Source Player for this event.
|
|
15611
|
+
*
|
|
15612
|
+
*/
|
|
15613
|
+
readonly player: Player;
|
|
15614
|
+
/**
|
|
15615
|
+
* @remarks
|
|
15616
|
+
* The slot index with the change.
|
|
15617
|
+
*
|
|
15618
|
+
*/
|
|
15619
|
+
readonly slot: number;
|
|
15620
|
+
}
|
|
15621
|
+
|
|
15622
|
+
/**
|
|
15623
|
+
* @beta
|
|
15624
|
+
* Manages callbacks that are connected after a player's
|
|
15625
|
+
* inventory item is changed.
|
|
15626
|
+
*/
|
|
15627
|
+
export class PlayerInventoryItemChangeAfterEventSignal {
|
|
15628
|
+
private constructor();
|
|
15629
|
+
/**
|
|
15630
|
+
* @remarks
|
|
15631
|
+
* Adds a callback that will be called after a player's
|
|
15632
|
+
* inventory item is changed.
|
|
15633
|
+
*
|
|
15504
15634
|
* This function can't be called in read-only mode.
|
|
15505
15635
|
*
|
|
15636
|
+
* This function can be called in early-execution mode.
|
|
15637
|
+
*
|
|
15638
|
+
* @param callback
|
|
15639
|
+
* Function callback that is called when this event fires.
|
|
15640
|
+
* @param options
|
|
15641
|
+
* Additional filtering options for the event subscription.
|
|
15506
15642
|
*/
|
|
15507
|
-
|
|
15643
|
+
subscribe(
|
|
15644
|
+
callback: (arg0: PlayerInventoryItemChangeAfterEvent) => void,
|
|
15645
|
+
options?: InventoryItemEventOptions,
|
|
15646
|
+
): (arg0: PlayerInventoryItemChangeAfterEvent) => void;
|
|
15508
15647
|
/**
|
|
15509
15648
|
* @remarks
|
|
15510
|
-
*
|
|
15511
|
-
*
|
|
15512
|
-
* can be used to see the next Player in the iteration.
|
|
15649
|
+
* Removes a callback from being called after a player's
|
|
15650
|
+
* inventory item is changed.
|
|
15513
15651
|
*
|
|
15514
15652
|
* This function can't be called in read-only mode.
|
|
15515
15653
|
*
|
|
15654
|
+
* This function can be called in early-execution mode.
|
|
15655
|
+
*
|
|
15516
15656
|
*/
|
|
15517
|
-
|
|
15657
|
+
unsubscribe(callback: (arg0: PlayerInventoryItemChangeAfterEvent) => void): void;
|
|
15518
15658
|
}
|
|
15519
15659
|
|
|
15520
15660
|
/**
|
|
@@ -15546,7 +15686,7 @@ export class PlayerJoinAfterEvent {
|
|
|
15546
15686
|
export class PlayerJoinAfterEventSignal {
|
|
15547
15687
|
private constructor();
|
|
15548
15688
|
/**
|
|
15549
|
-
* @
|
|
15689
|
+
* @rc
|
|
15550
15690
|
* @remarks
|
|
15551
15691
|
* Adds a callback that will be called when a player joins the
|
|
15552
15692
|
* world.
|
|
@@ -15558,7 +15698,7 @@ export class PlayerJoinAfterEventSignal {
|
|
|
15558
15698
|
*/
|
|
15559
15699
|
subscribe(callback: (arg0: PlayerJoinAfterEvent) => void): (arg0: PlayerJoinAfterEvent) => void;
|
|
15560
15700
|
/**
|
|
15561
|
-
* @
|
|
15701
|
+
* @rc
|
|
15562
15702
|
* @remarks
|
|
15563
15703
|
* Removes a callback from being called when a player joins the
|
|
15564
15704
|
* world.
|
|
@@ -15599,7 +15739,7 @@ export class PlayerLeaveAfterEvent {
|
|
|
15599
15739
|
export class PlayerLeaveAfterEventSignal {
|
|
15600
15740
|
private constructor();
|
|
15601
15741
|
/**
|
|
15602
|
-
* @
|
|
15742
|
+
* @rc
|
|
15603
15743
|
* @remarks
|
|
15604
15744
|
* Adds a callback that will be called when a player leaves the
|
|
15605
15745
|
* world.
|
|
@@ -15611,7 +15751,7 @@ export class PlayerLeaveAfterEventSignal {
|
|
|
15611
15751
|
*/
|
|
15612
15752
|
subscribe(callback: (arg0: PlayerLeaveAfterEvent) => void): (arg0: PlayerLeaveAfterEvent) => void;
|
|
15613
15753
|
/**
|
|
15614
|
-
* @
|
|
15754
|
+
* @rc
|
|
15615
15755
|
* @remarks
|
|
15616
15756
|
* Removes a callback from being called when a player leaves
|
|
15617
15757
|
* the world.
|
|
@@ -15745,10 +15885,11 @@ export class PlayerPlaceBlockBeforeEvent extends BlockEvent {
|
|
|
15745
15885
|
readonly faceLocation: Vector3;
|
|
15746
15886
|
/**
|
|
15747
15887
|
* @remarks
|
|
15748
|
-
* The block permutation that
|
|
15888
|
+
* The block permutation that will be placed if the event is
|
|
15889
|
+
* not cancelled.
|
|
15749
15890
|
*
|
|
15750
15891
|
*/
|
|
15751
|
-
readonly
|
|
15892
|
+
readonly permutationToPlace: BlockPermutation;
|
|
15752
15893
|
/**
|
|
15753
15894
|
* @remarks
|
|
15754
15895
|
* Player that is placing the block for this event.
|
|
@@ -15823,7 +15964,7 @@ export class PlayerSpawnAfterEvent {
|
|
|
15823
15964
|
export class PlayerSpawnAfterEventSignal {
|
|
15824
15965
|
private constructor();
|
|
15825
15966
|
/**
|
|
15826
|
-
* @
|
|
15967
|
+
* @rc
|
|
15827
15968
|
* @remarks
|
|
15828
15969
|
* Registers a new event receiver for this particular type of
|
|
15829
15970
|
* event.
|
|
@@ -15835,7 +15976,7 @@ export class PlayerSpawnAfterEventSignal {
|
|
|
15835
15976
|
*/
|
|
15836
15977
|
subscribe(callback: (arg0: PlayerSpawnAfterEvent) => void): (arg0: PlayerSpawnAfterEvent) => void;
|
|
15837
15978
|
/**
|
|
15838
|
-
* @
|
|
15979
|
+
* @rc
|
|
15839
15980
|
* @remarks
|
|
15840
15981
|
* De-registers an event receiver for the player spawn event.
|
|
15841
15982
|
*
|
|
@@ -16355,7 +16496,7 @@ export class ScoreboardIdentity {
|
|
|
16355
16496
|
*/
|
|
16356
16497
|
readonly id: number;
|
|
16357
16498
|
/**
|
|
16358
|
-
* @
|
|
16499
|
+
* @rc
|
|
16359
16500
|
* @remarks
|
|
16360
16501
|
* Returns true if the ScoreboardIdentity reference is still
|
|
16361
16502
|
* valid.
|
|
@@ -16399,7 +16540,7 @@ export class ScoreboardObjective {
|
|
|
16399
16540
|
*/
|
|
16400
16541
|
readonly id: string;
|
|
16401
16542
|
/**
|
|
16402
|
-
* @
|
|
16543
|
+
* @rc
|
|
16403
16544
|
* @remarks
|
|
16404
16545
|
* Returns true if the ScoreboardObjective reference is still
|
|
16405
16546
|
* valid.
|
|
@@ -16558,7 +16699,7 @@ export class ScoreboardScoreInfo {
|
|
|
16558
16699
|
export class ScreenDisplay {
|
|
16559
16700
|
private constructor();
|
|
16560
16701
|
/**
|
|
16561
|
-
* @
|
|
16702
|
+
* @rc
|
|
16562
16703
|
* @remarks
|
|
16563
16704
|
* Returns true if the current reference to this screen display
|
|
16564
16705
|
* manager object is valid and functional.
|
|
@@ -16593,7 +16734,7 @@ export class ScreenDisplay {
|
|
|
16593
16734
|
*/
|
|
16594
16735
|
isForcedHidden(hudElement: HudElement): boolean;
|
|
16595
16736
|
/**
|
|
16596
|
-
* @
|
|
16737
|
+
* @rc
|
|
16597
16738
|
* @remarks
|
|
16598
16739
|
* This function can't be called in read-only mode.
|
|
16599
16740
|
*
|
|
@@ -16903,37 +17044,53 @@ export class ServerMessageAfterEventSignal {
|
|
|
16903
17044
|
}
|
|
16904
17045
|
|
|
16905
17046
|
/**
|
|
16906
|
-
* @
|
|
17047
|
+
* @rc
|
|
17048
|
+
* Provides an adaptable interface for callers to subscribe to
|
|
17049
|
+
* an event that fires before the game world shuts down. This
|
|
17050
|
+
* event occurs after players have left, but before the world
|
|
17051
|
+
* has closed.
|
|
16907
17052
|
*/
|
|
16908
17053
|
export class ShutdownBeforeEventSignal {
|
|
16909
17054
|
private constructor();
|
|
16910
17055
|
/**
|
|
16911
17056
|
* @remarks
|
|
17057
|
+
* Adds a new subscriber callback to this event.
|
|
17058
|
+
*
|
|
16912
17059
|
* This function can't be called in read-only mode.
|
|
16913
17060
|
*
|
|
16914
17061
|
* This function can be called in early-execution mode.
|
|
16915
17062
|
*
|
|
17063
|
+
* @param callback
|
|
17064
|
+
* Function callback that is called when this event fires.
|
|
16916
17065
|
*/
|
|
16917
17066
|
subscribe(callback: (arg0: ShutdownEvent) => void): (arg0: ShutdownEvent) => void;
|
|
16918
17067
|
/**
|
|
16919
17068
|
* @remarks
|
|
17069
|
+
* Removes a subscriber callback previously subscribed to via
|
|
17070
|
+
* the subscribe method.
|
|
17071
|
+
*
|
|
16920
17072
|
* This function can't be called in read-only mode.
|
|
16921
17073
|
*
|
|
16922
17074
|
* This function can be called in early-execution mode.
|
|
16923
17075
|
*
|
|
17076
|
+
* @param callback
|
|
17077
|
+
* Function closure that was previously passed to the subscribe
|
|
17078
|
+
* method.
|
|
16924
17079
|
*/
|
|
16925
17080
|
unsubscribe(callback: (arg0: ShutdownEvent) => void): void;
|
|
16926
17081
|
}
|
|
16927
17082
|
|
|
16928
17083
|
/**
|
|
16929
|
-
* @
|
|
17084
|
+
* @rc
|
|
17085
|
+
* The event object that gets dispatched when the game world is
|
|
17086
|
+
* shutting down.
|
|
16930
17087
|
*/
|
|
16931
17088
|
export class ShutdownEvent {
|
|
16932
17089
|
private constructor();
|
|
16933
17090
|
}
|
|
16934
17091
|
|
|
16935
17092
|
/**
|
|
16936
|
-
* @
|
|
17093
|
+
* @rc
|
|
16937
17094
|
*/
|
|
16938
17095
|
export class StartupBeforeEventSignal {
|
|
16939
17096
|
private constructor();
|
|
@@ -16956,7 +17113,7 @@ export class StartupBeforeEventSignal {
|
|
|
16956
17113
|
}
|
|
16957
17114
|
|
|
16958
17115
|
/**
|
|
16959
|
-
* @
|
|
17116
|
+
* @rc
|
|
16960
17117
|
*/
|
|
16961
17118
|
export class StartupEvent {
|
|
16962
17119
|
private constructor();
|
|
@@ -16967,6 +17124,7 @@ export class StartupEvent {
|
|
|
16967
17124
|
*/
|
|
16968
17125
|
readonly blockComponentRegistry: BlockComponentRegistry;
|
|
16969
17126
|
/**
|
|
17127
|
+
* @beta
|
|
16970
17128
|
* @remarks
|
|
16971
17129
|
* This property can be read in early-execution mode.
|
|
16972
17130
|
*
|
|
@@ -16997,7 +17155,7 @@ export class Structure {
|
|
|
16997
17155
|
*/
|
|
16998
17156
|
readonly id: string;
|
|
16999
17157
|
/**
|
|
17000
|
-
* @
|
|
17158
|
+
* @rc
|
|
17001
17159
|
* @remarks
|
|
17002
17160
|
* Returns whether the Structure is valid. The Structure may
|
|
17003
17161
|
* become invalid if it is deleted.
|
|
@@ -17359,7 +17517,7 @@ export class System {
|
|
|
17359
17517
|
*/
|
|
17360
17518
|
readonly afterEvents: SystemAfterEvents;
|
|
17361
17519
|
/**
|
|
17362
|
-
* @
|
|
17520
|
+
* @rc
|
|
17363
17521
|
* @remarks
|
|
17364
17522
|
* Returns a collection of before-events for system-level
|
|
17365
17523
|
* operations.
|
|
@@ -17377,7 +17535,7 @@ export class System {
|
|
|
17377
17535
|
*/
|
|
17378
17536
|
readonly currentTick: number;
|
|
17379
17537
|
/**
|
|
17380
|
-
* @
|
|
17538
|
+
* @rc
|
|
17381
17539
|
* @remarks
|
|
17382
17540
|
* Returns true if this is a world where the editor is
|
|
17383
17541
|
* currently loaded, returns false otherwise.
|
|
@@ -17597,7 +17755,7 @@ export class SystemAfterEvents {
|
|
|
17597
17755
|
}
|
|
17598
17756
|
|
|
17599
17757
|
/**
|
|
17600
|
-
* @
|
|
17758
|
+
* @rc
|
|
17601
17759
|
* A set of events that fire before an actual action occurs. In
|
|
17602
17760
|
* most cases, you can potentially cancel or modify the
|
|
17603
17761
|
* impending event. Note that in before events any APIs that
|
|
@@ -17619,6 +17777,7 @@ export class SystemBeforeEvents {
|
|
|
17619
17777
|
*/
|
|
17620
17778
|
readonly startup: StartupBeforeEventSignal;
|
|
17621
17779
|
/**
|
|
17780
|
+
* @beta
|
|
17622
17781
|
* @remarks
|
|
17623
17782
|
* Fires when the scripting watchdog shuts down the server. The
|
|
17624
17783
|
* can be due to using too much memory, or by causing
|
|
@@ -18793,6 +18952,13 @@ export class WorldAfterEvents {
|
|
|
18793
18952
|
*
|
|
18794
18953
|
*/
|
|
18795
18954
|
readonly playerGameModeChange: PlayerGameModeChangeAfterEventSignal;
|
|
18955
|
+
/**
|
|
18956
|
+
* @beta
|
|
18957
|
+
* @remarks
|
|
18958
|
+
* This property can be read in early-execution mode.
|
|
18959
|
+
*
|
|
18960
|
+
*/
|
|
18961
|
+
readonly playerHotbarSelectedSlotChange: PlayerHotbarSelectedSlotChangeAfterEventSignal;
|
|
18796
18962
|
/**
|
|
18797
18963
|
* @remarks
|
|
18798
18964
|
* This event fires when a player's {@link InputMode} changes.
|
|
@@ -18825,6 +18991,13 @@ export class WorldAfterEvents {
|
|
|
18825
18991
|
*
|
|
18826
18992
|
*/
|
|
18827
18993
|
readonly playerInteractWithEntity: PlayerInteractWithEntityAfterEventSignal;
|
|
18994
|
+
/**
|
|
18995
|
+
* @beta
|
|
18996
|
+
* @remarks
|
|
18997
|
+
* This property can be read in early-execution mode.
|
|
18998
|
+
*
|
|
18999
|
+
*/
|
|
19000
|
+
readonly playerInventoryItemChange: PlayerInventoryItemChangeAfterEventSignal;
|
|
18828
19001
|
/**
|
|
18829
19002
|
* @remarks
|
|
18830
19003
|
* This event fires when a player joins a world. See also
|
|
@@ -18921,7 +19094,7 @@ export class WorldAfterEvents {
|
|
|
18921
19094
|
*/
|
|
18922
19095
|
readonly weatherChange: WeatherChangeAfterEventSignal;
|
|
18923
19096
|
/**
|
|
18924
|
-
* @
|
|
19097
|
+
* @rc
|
|
18925
19098
|
* @remarks
|
|
18926
19099
|
* This property can be read in early-execution mode.
|
|
18927
19100
|
*
|
|
@@ -19066,14 +19239,14 @@ export class WorldBeforeEvents {
|
|
|
19066
19239
|
}
|
|
19067
19240
|
|
|
19068
19241
|
/**
|
|
19069
|
-
* @
|
|
19242
|
+
* @rc
|
|
19070
19243
|
*/
|
|
19071
19244
|
export class WorldLoadAfterEvent {
|
|
19072
19245
|
private constructor();
|
|
19073
19246
|
}
|
|
19074
19247
|
|
|
19075
19248
|
/**
|
|
19076
|
-
* @
|
|
19249
|
+
* @rc
|
|
19077
19250
|
*/
|
|
19078
19251
|
export class WorldLoadAfterEventSignal {
|
|
19079
19252
|
private constructor();
|
|
@@ -19170,12 +19343,9 @@ export interface BlockCustomComponent {
|
|
|
19170
19343
|
*/
|
|
19171
19344
|
onPlace?: (arg0: BlockComponentOnPlaceEvent, arg1: CustomComponentParameters) => void;
|
|
19172
19345
|
/**
|
|
19173
|
-
* @
|
|
19174
|
-
* This function will be called when a player destroys a
|
|
19175
|
-
* specific block.
|
|
19176
|
-
*
|
|
19346
|
+
* @rc
|
|
19177
19347
|
*/
|
|
19178
|
-
|
|
19348
|
+
onPlayerBreak?: (arg0: BlockComponentPlayerBreakEvent, arg1: CustomComponentParameters) => void;
|
|
19179
19349
|
/**
|
|
19180
19350
|
* @remarks
|
|
19181
19351
|
* This function will be called when a player sucessfully
|
|
@@ -20397,6 +20567,19 @@ export interface GreaterThanOrEqualsComparison {
|
|
|
20397
20567
|
greaterThanOrEquals: number;
|
|
20398
20568
|
}
|
|
20399
20569
|
|
|
20570
|
+
/**
|
|
20571
|
+
* @beta
|
|
20572
|
+
* Contains additional filtering options for hotbar events.
|
|
20573
|
+
*/
|
|
20574
|
+
export interface HotbarEventOptions {
|
|
20575
|
+
/**
|
|
20576
|
+
* @remarks
|
|
20577
|
+
* The slot indexes to consider.
|
|
20578
|
+
*
|
|
20579
|
+
*/
|
|
20580
|
+
allowedSlots?: number[];
|
|
20581
|
+
}
|
|
20582
|
+
|
|
20400
20583
|
/**
|
|
20401
20584
|
* An interface that is passed into {@link
|
|
20402
20585
|
* @minecraft/Server.PlayerButtonInputAfterEventSignal.subscribe}
|
|
@@ -20420,6 +20603,58 @@ export interface InputEventOptions {
|
|
|
20420
20603
|
state?: ButtonState;
|
|
20421
20604
|
}
|
|
20422
20605
|
|
|
20606
|
+
/**
|
|
20607
|
+
* @beta
|
|
20608
|
+
* Contains additional filtering options for inventory item
|
|
20609
|
+
* events.
|
|
20610
|
+
*/
|
|
20611
|
+
export interface InventoryItemEventOptions {
|
|
20612
|
+
/**
|
|
20613
|
+
* @remarks
|
|
20614
|
+
* The slot indexes to consider.
|
|
20615
|
+
*
|
|
20616
|
+
*/
|
|
20617
|
+
allowedSlots?: number[];
|
|
20618
|
+
/**
|
|
20619
|
+
* @remarks
|
|
20620
|
+
* The names for the items to exclude.
|
|
20621
|
+
*
|
|
20622
|
+
*/
|
|
20623
|
+
excludeItems?: string[];
|
|
20624
|
+
/**
|
|
20625
|
+
* @remarks
|
|
20626
|
+
* The item tags to exclude.
|
|
20627
|
+
*
|
|
20628
|
+
*/
|
|
20629
|
+
excludeTags?: string[];
|
|
20630
|
+
/**
|
|
20631
|
+
* @remarks
|
|
20632
|
+
* Flag to specify to ignore quantity changes only. True to
|
|
20633
|
+
* ignore quantity changes, false to not ignore quantity
|
|
20634
|
+
* changes.
|
|
20635
|
+
*
|
|
20636
|
+
*/
|
|
20637
|
+
ignoreQuantityChange?: boolean;
|
|
20638
|
+
/**
|
|
20639
|
+
* @remarks
|
|
20640
|
+
* The item names to consider.
|
|
20641
|
+
*
|
|
20642
|
+
*/
|
|
20643
|
+
includeItems?: string[];
|
|
20644
|
+
/**
|
|
20645
|
+
* @remarks
|
|
20646
|
+
* The item tags to consider.
|
|
20647
|
+
*
|
|
20648
|
+
*/
|
|
20649
|
+
includeTags?: string[];
|
|
20650
|
+
/**
|
|
20651
|
+
* @remarks
|
|
20652
|
+
* The player inventory type to consider.
|
|
20653
|
+
*
|
|
20654
|
+
*/
|
|
20655
|
+
inventoryType?: PlayerInventoryType;
|
|
20656
|
+
}
|
|
20657
|
+
|
|
20423
20658
|
/**
|
|
20424
20659
|
* Contains a set of events that will be raised for an item.
|
|
20425
20660
|
* This object must be bound using the ItemComponentRegistry.
|
|
@@ -20991,11 +21226,12 @@ export interface ScriptEventMessageFilterOptions {
|
|
|
20991
21226
|
}
|
|
20992
21227
|
|
|
20993
21228
|
/**
|
|
20994
|
-
* @
|
|
21229
|
+
* @rc
|
|
20995
21230
|
* Contains additional options for spawning an Entity.
|
|
20996
21231
|
*/
|
|
20997
21232
|
export interface SpawnEntityOptions {
|
|
20998
21233
|
/**
|
|
21234
|
+
* @beta
|
|
20999
21235
|
* @remarks
|
|
21000
21236
|
* Optional boolean which determines if this entity should
|
|
21001
21237
|
* persist in the game world. Persistence prevents the entity
|
|
@@ -21004,6 +21240,7 @@ export interface SpawnEntityOptions {
|
|
|
21004
21240
|
*/
|
|
21005
21241
|
initialPersistence?: boolean;
|
|
21006
21242
|
/**
|
|
21243
|
+
* @beta
|
|
21007
21244
|
* @remarks
|
|
21008
21245
|
* Optional initial rotation, in degrees, to set on the entity
|
|
21009
21246
|
* when it spawns.
|