@minecraft/server 2.8.0-beta.1.26.20-preview.27 → 2.8.0-rc.1.26.30-preview.21
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 +106 -2732
- package/package.json +2 -2
package/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
Copyright (c) Microsoft Corporation.
|
|
8
8
|
***************************************************************************** */
|
|
9
9
|
/**
|
|
10
|
-
* @
|
|
10
|
+
* @preview
|
|
11
11
|
* @packageDocumentation
|
|
12
12
|
* Contains many types related to manipulating a Minecraft
|
|
13
13
|
* world, including entities, blocks, dimensions, and more.
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* ```json
|
|
17
17
|
* {
|
|
18
18
|
* "module_name": "@minecraft/server",
|
|
19
|
-
* "version": "2.8.0
|
|
19
|
+
* "version": "2.8.0"
|
|
20
20
|
* }
|
|
21
21
|
* ```
|
|
22
22
|
*
|
|
@@ -229,55 +229,6 @@ export enum CommandPermissionLevel {
|
|
|
229
229
|
Owner = 4,
|
|
230
230
|
}
|
|
231
231
|
|
|
232
|
-
/**
|
|
233
|
-
* @beta
|
|
234
|
-
* The Action enum determines how the CompoundBlockVolume
|
|
235
|
-
* considers the associated CompoundBlockVolumeItem when
|
|
236
|
-
* performing inside/outside calculations.
|
|
237
|
-
*/
|
|
238
|
-
export enum CompoundBlockVolumeAction {
|
|
239
|
-
/**
|
|
240
|
-
* @remarks
|
|
241
|
-
* The associated BlockVolume is considered a positive space,
|
|
242
|
-
* and any intersection tests are considered hits
|
|
243
|
-
*
|
|
244
|
-
*/
|
|
245
|
-
Add = 0,
|
|
246
|
-
/**
|
|
247
|
-
* @remarks
|
|
248
|
-
* The associated BlockVolume is considered a negative or void
|
|
249
|
-
* space, and any intersection tests are considered misses.
|
|
250
|
-
* Using the Subtract action, it is possible to `punch holes`
|
|
251
|
-
* in block volumes so that any intersection tests may pass
|
|
252
|
-
* through such spaces
|
|
253
|
-
*
|
|
254
|
-
*/
|
|
255
|
-
Subtract = 1,
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
/**
|
|
259
|
-
* @beta
|
|
260
|
-
* An enum describing the relativity of the
|
|
261
|
-
* CompoundBlockVolumeItem, relative to the parent
|
|
262
|
-
* CompoundVolume.
|
|
263
|
-
*/
|
|
264
|
-
export enum CompoundBlockVolumePositionRelativity {
|
|
265
|
-
/**
|
|
266
|
-
* @remarks
|
|
267
|
-
* The locations within the associated BlockVolume are relative
|
|
268
|
-
* to the CompoundBlockVolume to which they were added
|
|
269
|
-
*
|
|
270
|
-
*/
|
|
271
|
-
Relative = 0,
|
|
272
|
-
/**
|
|
273
|
-
* @remarks
|
|
274
|
-
* The locations within the associated BlockVolume are in
|
|
275
|
-
* absolute world space
|
|
276
|
-
*
|
|
277
|
-
*/
|
|
278
|
-
Absolute = 1,
|
|
279
|
-
}
|
|
280
|
-
|
|
281
232
|
/**
|
|
282
233
|
* Reasons that the {@link
|
|
283
234
|
* @minecraft/server.ContainerRulesError} was thrown.
|
|
@@ -380,13 +331,6 @@ export enum CustomCommandErrorReason {
|
|
|
380
331
|
*
|
|
381
332
|
*/
|
|
382
333
|
RegistryReadOnly = 'RegistryReadOnly',
|
|
383
|
-
/**
|
|
384
|
-
* @beta
|
|
385
|
-
* @remarks
|
|
386
|
-
* Non enum type command parameters cannot use enumName.
|
|
387
|
-
*
|
|
388
|
-
*/
|
|
389
|
-
UnexpectedEnumName = 'UnexpectedEnumName',
|
|
390
334
|
}
|
|
391
335
|
|
|
392
336
|
/**
|
|
@@ -837,7 +781,7 @@ export enum EntityComponentTypes {
|
|
|
837
781
|
Color2 = 'minecraft:color2',
|
|
838
782
|
CursorInventory = 'minecraft:cursor_inventory',
|
|
839
783
|
/**
|
|
840
|
-
* @
|
|
784
|
+
* @rc
|
|
841
785
|
* @remarks
|
|
842
786
|
* Represents this entity's ender inventory properties.
|
|
843
787
|
*
|
|
@@ -1124,14 +1068,6 @@ export enum EntityComponentTypes {
|
|
|
1124
1068
|
*
|
|
1125
1069
|
*/
|
|
1126
1070
|
NavigationWalk = 'minecraft:navigation.walk',
|
|
1127
|
-
/**
|
|
1128
|
-
* @beta
|
|
1129
|
-
* @remarks
|
|
1130
|
-
* Adds NPC capabilities to an entity such as custom skin,
|
|
1131
|
-
* name, and dialogue interactions.
|
|
1132
|
-
*
|
|
1133
|
-
*/
|
|
1134
|
-
Npc = 'minecraft:npc',
|
|
1135
1071
|
/**
|
|
1136
1072
|
* @remarks
|
|
1137
1073
|
* When present on an entity, this entity is on fire.
|
|
@@ -1502,13 +1438,6 @@ export enum EntityHealCause {
|
|
|
1502
1438
|
*
|
|
1503
1439
|
*/
|
|
1504
1440
|
SelfHeal = 'SelfHeal',
|
|
1505
|
-
/**
|
|
1506
|
-
* @beta
|
|
1507
|
-
* @remarks
|
|
1508
|
-
* Healing caused when Totem of Undying is activated.
|
|
1509
|
-
*
|
|
1510
|
-
*/
|
|
1511
|
-
TotemOfUndying = 'TotemOfUndying',
|
|
1512
1441
|
}
|
|
1513
1442
|
|
|
1514
1443
|
/**
|
|
@@ -1616,14 +1545,6 @@ export enum EntitySwingSource {
|
|
|
1616
1545
|
* and mainhand slots.
|
|
1617
1546
|
*/
|
|
1618
1547
|
export enum EquipmentSlot {
|
|
1619
|
-
/**
|
|
1620
|
-
* @beta
|
|
1621
|
-
* @remarks
|
|
1622
|
-
* The body slot. This slot is used to hold armor for
|
|
1623
|
-
* non-humanoid mobs.
|
|
1624
|
-
*
|
|
1625
|
-
*/
|
|
1626
|
-
Body = 'Body',
|
|
1627
1548
|
/**
|
|
1628
1549
|
* @remarks
|
|
1629
1550
|
* The chest slot. This slot is used to hold items such as
|
|
@@ -1866,10 +1787,6 @@ export enum GameRule {
|
|
|
1866
1787
|
*
|
|
1867
1788
|
*/
|
|
1868
1789
|
KeepInventory = 'keepInventory',
|
|
1869
|
-
/**
|
|
1870
|
-
* @beta
|
|
1871
|
-
*/
|
|
1872
|
-
LocatorBar = 'locatorBar',
|
|
1873
1790
|
/**
|
|
1874
1791
|
* @remarks
|
|
1875
1792
|
* The maximum number of chained commands that can execute per
|
|
@@ -2341,34 +2258,6 @@ export enum LiquidType {
|
|
|
2341
2258
|
Water = 'Water',
|
|
2342
2259
|
}
|
|
2343
2260
|
|
|
2344
|
-
/**
|
|
2345
|
-
* @beta
|
|
2346
|
-
* Enum representing the different reasons why a locator bar
|
|
2347
|
-
* operation may fail.
|
|
2348
|
-
*/
|
|
2349
|
-
export enum LocatorBarErrorReason {
|
|
2350
|
-
/**
|
|
2351
|
-
* @remarks
|
|
2352
|
-
* The waypoint already exists in the locator bar and cannot be
|
|
2353
|
-
* added again.
|
|
2354
|
-
*
|
|
2355
|
-
*/
|
|
2356
|
-
WaypointAlreadyExists = 'WaypointAlreadyExists',
|
|
2357
|
-
/**
|
|
2358
|
-
* @remarks
|
|
2359
|
-
* The maximum number of waypoints has been reached and no more
|
|
2360
|
-
* can be added.
|
|
2361
|
-
*
|
|
2362
|
-
*/
|
|
2363
|
-
WaypointLimitExceeded = 'WaypointLimitExceeded',
|
|
2364
|
-
/**
|
|
2365
|
-
* @remarks
|
|
2366
|
-
* The specified waypoint does not exist in the locator bar.
|
|
2367
|
-
*
|
|
2368
|
-
*/
|
|
2369
|
-
WaypointNotFound = 'WaypointNotFound',
|
|
2370
|
-
}
|
|
2371
|
-
|
|
2372
2261
|
/**
|
|
2373
2262
|
* Describes the memory of a device.
|
|
2374
2263
|
*/
|
|
@@ -3013,61 +2902,6 @@ export enum TintMethod {
|
|
|
3013
2902
|
Water = 'Water',
|
|
3014
2903
|
}
|
|
3015
2904
|
|
|
3016
|
-
/**
|
|
3017
|
-
* @beta
|
|
3018
|
-
* An enumeration with the reason that a watchdog is deciding
|
|
3019
|
-
* to terminate execution of a behavior packs' script.
|
|
3020
|
-
*/
|
|
3021
|
-
export enum WatchdogTerminateReason {
|
|
3022
|
-
/**
|
|
3023
|
-
* @remarks
|
|
3024
|
-
* Script runtime for a behavior pack is terminated due to
|
|
3025
|
-
* non-responsiveness from script (a hang or infinite loop).
|
|
3026
|
-
*
|
|
3027
|
-
*/
|
|
3028
|
-
Hang = 'Hang',
|
|
3029
|
-
/**
|
|
3030
|
-
* @remarks
|
|
3031
|
-
* Script runtime for a behavior pack is terminated due to a
|
|
3032
|
-
* stack overflow (a long, and potentially infinite) chain of
|
|
3033
|
-
* function calls.
|
|
3034
|
-
*
|
|
3035
|
-
*/
|
|
3036
|
-
StackOverflow = 'StackOverflow',
|
|
3037
|
-
}
|
|
3038
|
-
|
|
3039
|
-
/**
|
|
3040
|
-
* @beta
|
|
3041
|
-
* Enum representing different texture icons that can be
|
|
3042
|
-
* displayed for waypoints on the locator bar.
|
|
3043
|
-
*/
|
|
3044
|
-
export enum WaypointTexture {
|
|
3045
|
-
/**
|
|
3046
|
-
* @remarks
|
|
3047
|
-
* Circle waypoint icon texture.
|
|
3048
|
-
*
|
|
3049
|
-
*/
|
|
3050
|
-
Circle = 'minecraft:circle',
|
|
3051
|
-
/**
|
|
3052
|
-
* @remarks
|
|
3053
|
-
* Small square waypoint icon texture.
|
|
3054
|
-
*
|
|
3055
|
-
*/
|
|
3056
|
-
SmallSquare = 'minecraft:small_square',
|
|
3057
|
-
/**
|
|
3058
|
-
* @remarks
|
|
3059
|
-
* Small star waypoint icon texture.
|
|
3060
|
-
*
|
|
3061
|
-
*/
|
|
3062
|
-
SmallStar = 'minecraft:small_star',
|
|
3063
|
-
/**
|
|
3064
|
-
* @remarks
|
|
3065
|
-
* Square waypoint icon texture.
|
|
3066
|
-
*
|
|
3067
|
-
*/
|
|
3068
|
-
Square = 'minecraft:square',
|
|
3069
|
-
}
|
|
3070
|
-
|
|
3071
2905
|
/**
|
|
3072
2906
|
* Used to specify the type of weather condition within the
|
|
3073
2907
|
* world.
|
|
@@ -3221,7 +3055,6 @@ export type EntityComponentTypeMap = {
|
|
|
3221
3055
|
'minecraft:navigation.generic': EntityNavigationGenericComponent;
|
|
3222
3056
|
'minecraft:navigation.hover': EntityNavigationHoverComponent;
|
|
3223
3057
|
'minecraft:navigation.walk': EntityNavigationWalkComponent;
|
|
3224
|
-
'minecraft:npc': EntityNpcComponent;
|
|
3225
3058
|
'minecraft:onfire': EntityOnFireComponent;
|
|
3226
3059
|
'minecraft:player.exhaustion': EntityExhaustionComponent;
|
|
3227
3060
|
'minecraft:player.hunger': EntityHungerComponent;
|
|
@@ -3255,7 +3088,6 @@ export type EntityComponentTypeMap = {
|
|
|
3255
3088
|
'navigation.generic': EntityNavigationGenericComponent;
|
|
3256
3089
|
'navigation.hover': EntityNavigationHoverComponent;
|
|
3257
3090
|
'navigation.walk': EntityNavigationWalkComponent;
|
|
3258
|
-
npc: EntityNpcComponent;
|
|
3259
3091
|
onfire: EntityOnFireComponent;
|
|
3260
3092
|
'player.exhaustion': EntityExhaustionComponent;
|
|
3261
3093
|
'player.hunger': EntityHungerComponent;
|
|
@@ -3275,15 +3107,6 @@ export type EntityComponentTypeMap = {
|
|
|
3275
3107
|
wants_jockey: EntityWantsJockeyComponent;
|
|
3276
3108
|
};
|
|
3277
3109
|
|
|
3278
|
-
/**
|
|
3279
|
-
* @beta
|
|
3280
|
-
*/
|
|
3281
|
-
export type EntityIdentifierType<T> = [T] extends [never]
|
|
3282
|
-
? VanillaEntityIdentifier
|
|
3283
|
-
: T extends string
|
|
3284
|
-
? VanillaEntityIdentifier | T
|
|
3285
|
-
: never;
|
|
3286
|
-
|
|
3287
3110
|
export type ItemComponentReturnType<T extends string> = T extends keyof ItemComponentTypeMap
|
|
3288
3111
|
? ItemComponentTypeMap[T]
|
|
3289
3112
|
: ItemCustomComponentInstance;
|
|
@@ -3309,15 +3132,6 @@ export type ItemComponentTypeMap = {
|
|
|
3309
3132
|
potion: ItemPotionComponent;
|
|
3310
3133
|
};
|
|
3311
3134
|
|
|
3312
|
-
/**
|
|
3313
|
-
* @beta
|
|
3314
|
-
*/
|
|
3315
|
-
export type VanillaEntityIdentifier =
|
|
3316
|
-
| EntityType
|
|
3317
|
-
| minecraftvanilladata.MinecraftEntityTypes
|
|
3318
|
-
| `${minecraftvanilladata.MinecraftEntityTypes}`
|
|
3319
|
-
| `${minecraftvanilladata.MinecraftEntityTypes}<${string}>`;
|
|
3320
|
-
|
|
3321
3135
|
/**
|
|
3322
3136
|
* Handle to an aim-assist category that exists in the
|
|
3323
3137
|
* world.aimAssist registry.
|
|
@@ -3475,9 +3289,7 @@ export class AimAssistCategorySettings {
|
|
|
3475
3289
|
* A record mapping block Ids to their priority settings.
|
|
3476
3290
|
* Larger numbers have greater priority.
|
|
3477
3291
|
*/
|
|
3478
|
-
setBlockPriorities(
|
|
3479
|
-
blockPriorities: Record<keyof typeof minecraftvanilladata.MinecraftBlockTypes | string, number>,
|
|
3480
|
-
): void;
|
|
3292
|
+
setBlockPriorities(blockPriorities: Record<string, number>): void;
|
|
3481
3293
|
/**
|
|
3482
3294
|
* @remarks
|
|
3483
3295
|
* Sets the priority settings used for block targeting.
|
|
@@ -3496,9 +3308,7 @@ export class AimAssistCategorySettings {
|
|
|
3496
3308
|
* A record mapping entity Ids to their priority settings.
|
|
3497
3309
|
* Larger numbers have greater priority.
|
|
3498
3310
|
*/
|
|
3499
|
-
setEntityPriorities(
|
|
3500
|
-
entityPriorities: Record<keyof typeof minecraftvanilladata.MinecraftEntityTypes | string, number>,
|
|
3501
|
-
): void;
|
|
3311
|
+
setEntityPriorities(entityPriorities: Record<string, number>): void;
|
|
3502
3312
|
/**
|
|
3503
3313
|
* @remarks
|
|
3504
3314
|
* Sets the priority settings used for entity targeting.
|
|
@@ -3697,10 +3507,8 @@ export class AimAssistPresetSettings {
|
|
|
3697
3507
|
*
|
|
3698
3508
|
* This function can't be called in restricted-execution mode.
|
|
3699
3509
|
*
|
|
3700
|
-
* @param targets
|
|
3701
|
-
* An array of block tags.
|
|
3702
3510
|
*/
|
|
3703
|
-
setExcludedBlockTagTargets(
|
|
3511
|
+
setExcludedBlockTagTargets(blockTagTargets?: string[]): void;
|
|
3704
3512
|
/**
|
|
3705
3513
|
* @remarks
|
|
3706
3514
|
* Sets the list of block Ids to exclude from aim assist
|
|
@@ -3708,10 +3516,8 @@ export class AimAssistPresetSettings {
|
|
|
3708
3516
|
*
|
|
3709
3517
|
* This function can't be called in restricted-execution mode.
|
|
3710
3518
|
*
|
|
3711
|
-
* @param targets
|
|
3712
|
-
* An array of block Ids.
|
|
3713
3519
|
*/
|
|
3714
|
-
setExcludedBlockTargets(
|
|
3520
|
+
setExcludedBlockTargets(blockTargets?: string[]): void;
|
|
3715
3521
|
/**
|
|
3716
3522
|
* @remarks
|
|
3717
3523
|
* Sets the list of entity Ids to exclude from aim assist
|
|
@@ -3719,10 +3525,8 @@ export class AimAssistPresetSettings {
|
|
|
3719
3525
|
*
|
|
3720
3526
|
* This function can't be called in restricted-execution mode.
|
|
3721
3527
|
*
|
|
3722
|
-
* @param targets
|
|
3723
|
-
* An array of entity Ids.
|
|
3724
3528
|
*/
|
|
3725
|
-
setExcludedEntityTargets(
|
|
3529
|
+
setExcludedEntityTargets(entityTargets?: string[]): void;
|
|
3726
3530
|
/**
|
|
3727
3531
|
* @remarks
|
|
3728
3532
|
* Sets the list of entity type families to exclude from aim
|
|
@@ -3730,10 +3534,8 @@ export class AimAssistPresetSettings {
|
|
|
3730
3534
|
*
|
|
3731
3535
|
* This function can't be called in restricted-execution mode.
|
|
3732
3536
|
*
|
|
3733
|
-
* @param targets
|
|
3734
|
-
* An array of entity type families.
|
|
3735
3537
|
*/
|
|
3736
|
-
setExcludedEntityTypeFamilyTargets(
|
|
3538
|
+
setExcludedEntityTypeFamilyTargets(entityTypeFamilyTargets?: string[]): void;
|
|
3737
3539
|
/**
|
|
3738
3540
|
* @remarks
|
|
3739
3541
|
* Sets the per-item aim-assist category Ids.
|
|
@@ -3744,7 +3546,7 @@ export class AimAssistPresetSettings {
|
|
|
3744
3546
|
* A record mapping item Ids to aim-assist category Ids.
|
|
3745
3547
|
* Category Ids must have a namespace.
|
|
3746
3548
|
*/
|
|
3747
|
-
setItemSettings(itemSettings: Record<
|
|
3549
|
+
setItemSettings(itemSettings: Record<string, string>): void;
|
|
3748
3550
|
/**
|
|
3749
3551
|
* @remarks
|
|
3750
3552
|
* Sets the list of item Ids that will target liquid blocks
|
|
@@ -3755,7 +3557,7 @@ export class AimAssistPresetSettings {
|
|
|
3755
3557
|
* @param items
|
|
3756
3558
|
* An array of item Ids.
|
|
3757
3559
|
*/
|
|
3758
|
-
setLiquidTargetingItems(items?:
|
|
3560
|
+
setLiquidTargetingItems(items?: string[]): void;
|
|
3759
3561
|
}
|
|
3760
3562
|
|
|
3761
3563
|
/**
|
|
@@ -3861,28 +3663,6 @@ export class AimAssistRegistry {
|
|
|
3861
3663
|
getPresets(): AimAssistPreset[];
|
|
3862
3664
|
}
|
|
3863
3665
|
|
|
3864
|
-
/**
|
|
3865
|
-
* @beta
|
|
3866
|
-
* Describes a single banner pattern, which includes a colour
|
|
3867
|
-
* and a pattern type.
|
|
3868
|
-
*/
|
|
3869
|
-
export class BannerPattern {
|
|
3870
|
-
private constructor();
|
|
3871
|
-
/**
|
|
3872
|
-
* @remarks
|
|
3873
|
-
* The color to apply to this banner pattern.
|
|
3874
|
-
*
|
|
3875
|
-
*/
|
|
3876
|
-
readonly color: string;
|
|
3877
|
-
/**
|
|
3878
|
-
* @remarks
|
|
3879
|
-
* The pattern type (e.g. gradient, chevron, cross, etc.) to
|
|
3880
|
-
* apply to the banner.
|
|
3881
|
-
*
|
|
3882
|
-
*/
|
|
3883
|
-
readonly pattern: string;
|
|
3884
|
-
}
|
|
3885
|
-
|
|
3886
3666
|
/**
|
|
3887
3667
|
* Describes a type of biome.
|
|
3888
3668
|
*/
|
|
@@ -3979,20 +3759,6 @@ export class Block {
|
|
|
3979
3759
|
* {@link LocationOutOfWorldBoundariesError}
|
|
3980
3760
|
*/
|
|
3981
3761
|
readonly isLiquid: boolean;
|
|
3982
|
-
/**
|
|
3983
|
-
* @beta
|
|
3984
|
-
* @remarks
|
|
3985
|
-
* Returns true if this block is solid and impassible - (e.g.,
|
|
3986
|
-
* a cobblestone block and a diamond block are solid, while a
|
|
3987
|
-
* ladder block and a fence block are not).
|
|
3988
|
-
*
|
|
3989
|
-
* @throws This property can throw when used.
|
|
3990
|
-
*
|
|
3991
|
-
* {@link LocationInUnloadedChunkError}
|
|
3992
|
-
*
|
|
3993
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
3994
|
-
*/
|
|
3995
|
-
readonly isSolid: boolean;
|
|
3996
3762
|
/**
|
|
3997
3763
|
* @remarks
|
|
3998
3764
|
* Returns true if this reference to a block is still valid
|
|
@@ -4158,30 +3924,6 @@ export class Block {
|
|
|
4158
3924
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4159
3925
|
*/
|
|
4160
3926
|
canContainLiquid(liquidType: LiquidType): boolean;
|
|
4161
|
-
/**
|
|
4162
|
-
* @beta
|
|
4163
|
-
* @remarks
|
|
4164
|
-
* Checks to see whether it is valid to place the specified
|
|
4165
|
-
* block type or block permutation, on a specified face on this
|
|
4166
|
-
* block.
|
|
4167
|
-
*
|
|
4168
|
-
* @param blockToPlace
|
|
4169
|
-
* Block type or block permutation to check placement for.
|
|
4170
|
-
* @param faceToPlaceOn
|
|
4171
|
-
* Optional specific face of this block to check placement
|
|
4172
|
-
* against.
|
|
4173
|
-
* @returns
|
|
4174
|
-
* Returns `true` if the block type or permutation can be
|
|
4175
|
-
* placed on this block, else `false`.
|
|
4176
|
-
* @throws This function can throw errors.
|
|
4177
|
-
*
|
|
4178
|
-
* {@link Error}
|
|
4179
|
-
*
|
|
4180
|
-
* {@link LocationInUnloadedChunkError}
|
|
4181
|
-
*
|
|
4182
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4183
|
-
*/
|
|
4184
|
-
canPlace(blockToPlace: BlockPermutation | BlockType | string, faceToPlaceOn?: Direction): boolean;
|
|
4185
3927
|
/**
|
|
4186
3928
|
* @remarks
|
|
4187
3929
|
* Returns the {@link Vector3} of the center of this block on
|
|
@@ -4278,29 +4020,6 @@ export class Block {
|
|
|
4278
4020
|
* {@link LocationInUnloadedChunkError}
|
|
4279
4021
|
*/
|
|
4280
4022
|
getLightLevel(): number;
|
|
4281
|
-
/**
|
|
4282
|
-
* @beta
|
|
4283
|
-
* @throws This function can throw errors.
|
|
4284
|
-
*
|
|
4285
|
-
* {@link LocationInUnloadedChunkError}
|
|
4286
|
-
*
|
|
4287
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4288
|
-
*/
|
|
4289
|
-
getMapColor(): RGBA;
|
|
4290
|
-
/**
|
|
4291
|
-
* @beta
|
|
4292
|
-
* @remarks
|
|
4293
|
-
* Returns array of all loaded block parts if this block has
|
|
4294
|
-
* the 'minecraft:multi_block' trait. If it does not have the
|
|
4295
|
-
* trait returns undefined
|
|
4296
|
-
*
|
|
4297
|
-
* @throws This function can throw errors.
|
|
4298
|
-
*
|
|
4299
|
-
* {@link LocationInUnloadedChunkError}
|
|
4300
|
-
*
|
|
4301
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4302
|
-
*/
|
|
4303
|
-
getParts(): Block[] | undefined;
|
|
4304
4023
|
/**
|
|
4305
4024
|
* @remarks
|
|
4306
4025
|
* Returns the net redstone power of this block.
|
|
@@ -4568,27 +4287,6 @@ export class Block {
|
|
|
4568
4287
|
* {@link LocationOutOfWorldBoundariesError}
|
|
4569
4288
|
*/
|
|
4570
4289
|
south(steps?: number): Block | undefined;
|
|
4571
|
-
/**
|
|
4572
|
-
* @beta
|
|
4573
|
-
* @remarks
|
|
4574
|
-
* Tries to set the block in the dimension to the state of the
|
|
4575
|
-
* permutation by first checking if the placement is valid.
|
|
4576
|
-
*
|
|
4577
|
-
* This function can't be called in restricted-execution mode.
|
|
4578
|
-
*
|
|
4579
|
-
* @param permutation
|
|
4580
|
-
* Permutation that contains a set of property states for the
|
|
4581
|
-
* Block.
|
|
4582
|
-
* @returns
|
|
4583
|
-
* Returns `true` if the block permutation data was
|
|
4584
|
-
* successfully set, else `false`.
|
|
4585
|
-
* @throws This function can throw errors.
|
|
4586
|
-
*
|
|
4587
|
-
* {@link LocationInUnloadedChunkError}
|
|
4588
|
-
*
|
|
4589
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
4590
|
-
*/
|
|
4591
|
-
trySetPermutation(permutation: BlockPermutation): boolean;
|
|
4592
4290
|
/**
|
|
4593
4291
|
* @remarks
|
|
4594
4292
|
* Returns the {@link Block} to the west of this block
|
|
@@ -4606,137 +4304,6 @@ export class Block {
|
|
|
4606
4304
|
west(steps?: number): Block | undefined;
|
|
4607
4305
|
}
|
|
4608
4306
|
|
|
4609
|
-
/**
|
|
4610
|
-
* @beta
|
|
4611
|
-
* Bounding Box Utils is a utility class that provides a number
|
|
4612
|
-
* of useful functions for the creation and utility of {@link
|
|
4613
|
-
* BlockBoundingBox} objects
|
|
4614
|
-
*/
|
|
4615
|
-
export class BlockBoundingBoxUtils {
|
|
4616
|
-
private constructor();
|
|
4617
|
-
/**
|
|
4618
|
-
* @remarks
|
|
4619
|
-
* Create a validated instance of a {@link BlockBoundingBox}
|
|
4620
|
-
* where the min and max components are guaranteed to be (min
|
|
4621
|
-
* <= max)
|
|
4622
|
-
*
|
|
4623
|
-
* This function can't be called in restricted-execution mode.
|
|
4624
|
-
*
|
|
4625
|
-
* @param min
|
|
4626
|
-
* A corner world location
|
|
4627
|
-
* @param max
|
|
4628
|
-
* A corner world location diametrically opposite
|
|
4629
|
-
*/
|
|
4630
|
-
static createValid(min: Vector3, max: Vector3): BlockBoundingBox;
|
|
4631
|
-
/**
|
|
4632
|
-
* @remarks
|
|
4633
|
-
* Expand a {@link BlockBoundingBox} by a given amount along
|
|
4634
|
-
* each axis.
|
|
4635
|
-
* Sizes can be negative to perform contraction.
|
|
4636
|
-
* Note: corners can be inverted if the contraction size is
|
|
4637
|
-
* greater than the span, but the min/max relationship will
|
|
4638
|
-
* remain correct
|
|
4639
|
-
*
|
|
4640
|
-
* This function can't be called in restricted-execution mode.
|
|
4641
|
-
*
|
|
4642
|
-
* @returns
|
|
4643
|
-
* Return a new {@link BlockBoundingBox} object representing
|
|
4644
|
-
* the changes
|
|
4645
|
-
*/
|
|
4646
|
-
static dilate(box: BlockBoundingBox, size: Vector3): BlockBoundingBox;
|
|
4647
|
-
/**
|
|
4648
|
-
* @remarks
|
|
4649
|
-
* Check if two {@link BlockBoundingBox} objects are identical
|
|
4650
|
-
*
|
|
4651
|
-
* This function can't be called in restricted-execution mode.
|
|
4652
|
-
*
|
|
4653
|
-
*/
|
|
4654
|
-
static equals(box: BlockBoundingBox, other: BlockBoundingBox): boolean;
|
|
4655
|
-
/**
|
|
4656
|
-
* @remarks
|
|
4657
|
-
* Expand the initial box object bounds to include the 2nd box
|
|
4658
|
-
* argument. The resultant {@link BlockBoundingBox} object
|
|
4659
|
-
* will be a BlockBoundingBox which exactly encompasses the two
|
|
4660
|
-
* boxes.
|
|
4661
|
-
*
|
|
4662
|
-
* This function can't be called in restricted-execution mode.
|
|
4663
|
-
*
|
|
4664
|
-
* @returns
|
|
4665
|
-
* A new {@link BlockBoundingBox} instance representing the
|
|
4666
|
-
* smallest possible bounding box which can encompass both
|
|
4667
|
-
*/
|
|
4668
|
-
static expand(box: BlockBoundingBox, other: BlockBoundingBox): BlockBoundingBox;
|
|
4669
|
-
/**
|
|
4670
|
-
* @remarks
|
|
4671
|
-
* Calculate the center block of a given {@link
|
|
4672
|
-
* BlockBoundingBox} object.
|
|
4673
|
-
*
|
|
4674
|
-
* This function can't be called in restricted-execution mode.
|
|
4675
|
-
*
|
|
4676
|
-
* @returns
|
|
4677
|
-
* Note that {@link BlockBoundingBox} objects represent whole
|
|
4678
|
-
* blocks, so the center of boxes which have odd numbered
|
|
4679
|
-
* bounds are not mathematically centered...
|
|
4680
|
-
* i.e. a BlockBoundingBox( 0,0,0 -> 3,3,3 ) would have a
|
|
4681
|
-
* center of (1,1,1) (not (1.5, 1.5, 1.5) as expected)
|
|
4682
|
-
*/
|
|
4683
|
-
static getCenter(box: BlockBoundingBox): Vector3;
|
|
4684
|
-
/**
|
|
4685
|
-
* @remarks
|
|
4686
|
-
* Calculate the BlockBoundingBox which represents the union
|
|
4687
|
-
* area of two intersecting BlockBoundingBoxes
|
|
4688
|
-
*
|
|
4689
|
-
* This function can't be called in restricted-execution mode.
|
|
4690
|
-
*
|
|
4691
|
-
*/
|
|
4692
|
-
static getIntersection(box: BlockBoundingBox, other: BlockBoundingBox): BlockBoundingBox | undefined;
|
|
4693
|
-
/**
|
|
4694
|
-
* @remarks
|
|
4695
|
-
* Get the Span of each of the BlockBoundingBox Axis components
|
|
4696
|
-
*
|
|
4697
|
-
* This function can't be called in restricted-execution mode.
|
|
4698
|
-
*
|
|
4699
|
-
*/
|
|
4700
|
-
static getSpan(box: BlockBoundingBox): Vector3;
|
|
4701
|
-
/**
|
|
4702
|
-
* @remarks
|
|
4703
|
-
* Check to see if two BlockBoundingBox objects intersect
|
|
4704
|
-
*
|
|
4705
|
-
* This function can't be called in restricted-execution mode.
|
|
4706
|
-
*
|
|
4707
|
-
*/
|
|
4708
|
-
static intersects(box: BlockBoundingBox, other: BlockBoundingBox): boolean;
|
|
4709
|
-
/**
|
|
4710
|
-
* @remarks
|
|
4711
|
-
* Check to see if a given coordinate is inside a
|
|
4712
|
-
* BlockBoundingBox
|
|
4713
|
-
*
|
|
4714
|
-
* This function can't be called in restricted-execution mode.
|
|
4715
|
-
*
|
|
4716
|
-
*/
|
|
4717
|
-
static isInside(box: BlockBoundingBox, pos: Vector3): boolean;
|
|
4718
|
-
/**
|
|
4719
|
-
* @remarks
|
|
4720
|
-
* Check to see if a BlockBoundingBox is valid (i.e. (min <=
|
|
4721
|
-
* max))
|
|
4722
|
-
*
|
|
4723
|
-
* This function can't be called in restricted-execution mode.
|
|
4724
|
-
*
|
|
4725
|
-
*/
|
|
4726
|
-
static isValid(box: BlockBoundingBox): boolean;
|
|
4727
|
-
/**
|
|
4728
|
-
* @remarks
|
|
4729
|
-
* Move a BlockBoundingBox by a given amount
|
|
4730
|
-
*
|
|
4731
|
-
* This function can't be called in restricted-execution mode.
|
|
4732
|
-
*
|
|
4733
|
-
* @returns
|
|
4734
|
-
* Return a new BlockBoundingBox object which represents the
|
|
4735
|
-
* change
|
|
4736
|
-
*/
|
|
4737
|
-
static translate(box: BlockBoundingBox, delta: Vector3): BlockBoundingBox;
|
|
4738
|
-
}
|
|
4739
|
-
|
|
4740
4307
|
/**
|
|
4741
4308
|
* Base type for components associated with blocks.
|
|
4742
4309
|
*/
|
|
@@ -4779,22 +4346,6 @@ export class BlockComponentBlockBreakEvent extends BlockEvent {
|
|
|
4779
4346
|
readonly entitySource?: Entity;
|
|
4780
4347
|
}
|
|
4781
4348
|
|
|
4782
|
-
/**
|
|
4783
|
-
* @beta
|
|
4784
|
-
* Contains information regarding a specific block permutation
|
|
4785
|
-
* that was changed from a previous permutation.
|
|
4786
|
-
*/
|
|
4787
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
4788
|
-
export class BlockComponentBlockStateChangeEvent extends BlockEvent {
|
|
4789
|
-
private constructor();
|
|
4790
|
-
/**
|
|
4791
|
-
* @remarks
|
|
4792
|
-
* The previous BlockPermutation.
|
|
4793
|
-
*
|
|
4794
|
-
*/
|
|
4795
|
-
readonly previousPermutation: BlockPermutation;
|
|
4796
|
-
}
|
|
4797
|
-
|
|
4798
4349
|
/**
|
|
4799
4350
|
* Contains information regarding an event sent by an entity to
|
|
4800
4351
|
* this block in the world.
|
|
@@ -4960,13 +4511,6 @@ export class BlockComponentRandomTickEvent extends BlockEvent {
|
|
|
4960
4511
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
4961
4512
|
export class BlockComponentRedstoneUpdateEvent extends BlockEvent {
|
|
4962
4513
|
private constructor();
|
|
4963
|
-
/**
|
|
4964
|
-
* @beta
|
|
4965
|
-
* @remarks
|
|
4966
|
-
* The first update event for the redstone component.
|
|
4967
|
-
*
|
|
4968
|
-
*/
|
|
4969
|
-
readonly firstUpdate: boolean;
|
|
4970
4514
|
/**
|
|
4971
4515
|
* @remarks
|
|
4972
4516
|
* The redstone signal strength passing through this block. It
|
|
@@ -5050,7 +4594,7 @@ export class BlockComponentTickEvent extends BlockEvent {
|
|
|
5050
4594
|
}
|
|
5051
4595
|
|
|
5052
4596
|
/**
|
|
5053
|
-
* @
|
|
4597
|
+
* @rc
|
|
5054
4598
|
* Contains information regarding a specific container block
|
|
5055
4599
|
* being closed.
|
|
5056
4600
|
*/
|
|
@@ -5068,7 +4612,7 @@ export class BlockContainerClosedAfterEvent extends BlockEvent {
|
|
|
5068
4612
|
}
|
|
5069
4613
|
|
|
5070
4614
|
/**
|
|
5071
|
-
* @
|
|
4615
|
+
* @rc
|
|
5072
4616
|
* Manages callbacks that are connected to when a block
|
|
5073
4617
|
* container is closed.
|
|
5074
4618
|
*/
|
|
@@ -5102,7 +4646,7 @@ export class BlockContainerClosedAfterEventSignal {
|
|
|
5102
4646
|
}
|
|
5103
4647
|
|
|
5104
4648
|
/**
|
|
5105
|
-
* @
|
|
4649
|
+
* @rc
|
|
5106
4650
|
* Contains information regarding a specific container block
|
|
5107
4651
|
* being opened.
|
|
5108
4652
|
*/
|
|
@@ -5120,7 +4664,7 @@ export class BlockContainerOpenedAfterEvent extends BlockEvent {
|
|
|
5120
4664
|
}
|
|
5121
4665
|
|
|
5122
4666
|
/**
|
|
5123
|
-
* @
|
|
4667
|
+
* @rc
|
|
5124
4668
|
* Manages callbacks that are connected to when a block
|
|
5125
4669
|
* container is opened.
|
|
5126
4670
|
*/
|
|
@@ -5371,18 +4915,6 @@ export class BlockLocationIterator implements Iterable<Vector3> {
|
|
|
5371
4915
|
*
|
|
5372
4916
|
*/
|
|
5373
4917
|
[Symbol.iterator](): Iterator<Vector3>;
|
|
5374
|
-
/**
|
|
5375
|
-
* @beta
|
|
5376
|
-
* @remarks
|
|
5377
|
-
* Checks if the underlining block volume has been invalidated.
|
|
5378
|
-
* Will return false if the block volume was modified between
|
|
5379
|
-
* creating the iterator and iterating it, and true otherwise.
|
|
5380
|
-
*
|
|
5381
|
-
* @throws This function can throw errors.
|
|
5382
|
-
*
|
|
5383
|
-
* {@link minecraftcommon.EngineError}
|
|
5384
|
-
*/
|
|
5385
|
-
isValid(): boolean;
|
|
5386
4918
|
/**
|
|
5387
4919
|
* @remarks
|
|
5388
4920
|
* This function can't be called in restricted-execution mode.
|
|
@@ -5754,20 +5286,6 @@ export class BlockPrecipitationInteractionsComponent extends BlockComponent {
|
|
|
5754
5286
|
* {@link LocationOutOfWorldBoundariesError}
|
|
5755
5287
|
*/
|
|
5756
5288
|
accumulatesSnow(): boolean;
|
|
5757
|
-
/**
|
|
5758
|
-
* @beta
|
|
5759
|
-
* @remarks
|
|
5760
|
-
* Returns `true` if this block can have snow within it, like a
|
|
5761
|
-
* flower submerged in snow. Returns `false` if this block
|
|
5762
|
-
* cannot have snow within it.
|
|
5763
|
-
*
|
|
5764
|
-
* @throws This function can throw errors.
|
|
5765
|
-
*
|
|
5766
|
-
* {@link LocationInUnloadedChunkError}
|
|
5767
|
-
*
|
|
5768
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
5769
|
-
*/
|
|
5770
|
-
isSnowLoggable(): boolean;
|
|
5771
5289
|
/**
|
|
5772
5290
|
* @remarks
|
|
5773
5291
|
* Returns `true` if rain will not go through the block.
|
|
@@ -6299,15 +5817,6 @@ export class BlockVolumeBase {
|
|
|
6299
5817
|
*
|
|
6300
5818
|
*/
|
|
6301
5819
|
getBlockLocationIterator(): BlockLocationIterator;
|
|
6302
|
-
/**
|
|
6303
|
-
* @beta
|
|
6304
|
-
* @remarks
|
|
6305
|
-
* Return a {@link BlockBoundingBox} object which represents
|
|
6306
|
-
* the validated min and max coordinates of the volume
|
|
6307
|
-
*
|
|
6308
|
-
* @throws This function can throw errors.
|
|
6309
|
-
*/
|
|
6310
|
-
getBoundingBox(): BlockBoundingBox;
|
|
6311
5820
|
/**
|
|
6312
5821
|
* @remarks
|
|
6313
5822
|
* Return the capacity (volume) of the BlockVolume (W*D*H)
|
|
@@ -6538,23 +6047,6 @@ export class Camera {
|
|
|
6538
6047
|
| CameraSetRotOptions
|
|
6539
6048
|
| CameraTargetOptions,
|
|
6540
6049
|
): void;
|
|
6541
|
-
/**
|
|
6542
|
-
* @beta
|
|
6543
|
-
* @remarks
|
|
6544
|
-
* Sets the current active camera with easing.
|
|
6545
|
-
*
|
|
6546
|
-
* This function can't be called in restricted-execution mode.
|
|
6547
|
-
*
|
|
6548
|
-
* @param cameraPreset
|
|
6549
|
-
* Identifier of a camera preset file defined within JSON.
|
|
6550
|
-
* @param easeOptions
|
|
6551
|
-
* Options to ease the camera from the previous camera to the
|
|
6552
|
-
* current one.
|
|
6553
|
-
* @throws
|
|
6554
|
-
* Throws when easing to minecraft:first_person presets
|
|
6555
|
-
* currently without the experimental cameras toggle enabled.
|
|
6556
|
-
*/
|
|
6557
|
-
setCameraWithEase(cameraPreset: string, easeOptions: EaseOptions): void;
|
|
6558
6050
|
/**
|
|
6559
6051
|
* @remarks
|
|
6560
6052
|
* Sets the current active camera for the specified player and
|
|
@@ -6594,164 +6086,6 @@ export class CatmullRomSpline {
|
|
|
6594
6086
|
controlPoints: Vector3[];
|
|
6595
6087
|
}
|
|
6596
6088
|
|
|
6597
|
-
/**
|
|
6598
|
-
* @beta
|
|
6599
|
-
* An event that fires as players enter chat messages.
|
|
6600
|
-
*/
|
|
6601
|
-
export class ChatSendAfterEvent {
|
|
6602
|
-
private constructor();
|
|
6603
|
-
/**
|
|
6604
|
-
* @remarks
|
|
6605
|
-
* Message that is being broadcast.
|
|
6606
|
-
*
|
|
6607
|
-
*/
|
|
6608
|
-
readonly message: string;
|
|
6609
|
-
/**
|
|
6610
|
-
* @remarks
|
|
6611
|
-
* Player that sent the chat message.
|
|
6612
|
-
*
|
|
6613
|
-
*/
|
|
6614
|
-
readonly sender: Player;
|
|
6615
|
-
/**
|
|
6616
|
-
* @remarks
|
|
6617
|
-
* Optional list of players that will receive this message. If
|
|
6618
|
-
* defined, this message is directly targeted to one or more
|
|
6619
|
-
* players (i.e., is not broadcast.)
|
|
6620
|
-
*
|
|
6621
|
-
*/
|
|
6622
|
-
readonly targets?: Player[];
|
|
6623
|
-
}
|
|
6624
|
-
|
|
6625
|
-
/**
|
|
6626
|
-
* @beta
|
|
6627
|
-
* Manages callbacks that are connected to chat messages being
|
|
6628
|
-
* sent.
|
|
6629
|
-
*/
|
|
6630
|
-
export class ChatSendAfterEventSignal {
|
|
6631
|
-
private constructor();
|
|
6632
|
-
/**
|
|
6633
|
-
* @remarks
|
|
6634
|
-
* Adds a callback that will be called when new chat messages
|
|
6635
|
-
* are sent.
|
|
6636
|
-
*
|
|
6637
|
-
* This function can't be called in restricted-execution mode.
|
|
6638
|
-
*
|
|
6639
|
-
* This function can be called in early-execution mode.
|
|
6640
|
-
*
|
|
6641
|
-
*/
|
|
6642
|
-
subscribe(callback: (arg0: ChatSendAfterEvent) => void): (arg0: ChatSendAfterEvent) => void;
|
|
6643
|
-
/**
|
|
6644
|
-
* @remarks
|
|
6645
|
-
* Removes a callback from being called when new chat messages
|
|
6646
|
-
* are sent.
|
|
6647
|
-
*
|
|
6648
|
-
* This function can't be called in restricted-execution mode.
|
|
6649
|
-
*
|
|
6650
|
-
* This function can be called in early-execution mode.
|
|
6651
|
-
*
|
|
6652
|
-
*/
|
|
6653
|
-
unsubscribe(callback: (arg0: ChatSendAfterEvent) => void): void;
|
|
6654
|
-
}
|
|
6655
|
-
|
|
6656
|
-
/**
|
|
6657
|
-
* @beta
|
|
6658
|
-
* An event that fires as players enter chat messages.
|
|
6659
|
-
*/
|
|
6660
|
-
export class ChatSendBeforeEvent {
|
|
6661
|
-
private constructor();
|
|
6662
|
-
/**
|
|
6663
|
-
* @remarks
|
|
6664
|
-
* If set to true in a beforeChat event handler, this message
|
|
6665
|
-
* is not broadcast out.
|
|
6666
|
-
*
|
|
6667
|
-
*/
|
|
6668
|
-
cancel: boolean;
|
|
6669
|
-
/**
|
|
6670
|
-
* @remarks
|
|
6671
|
-
* Message that is being broadcast.
|
|
6672
|
-
*
|
|
6673
|
-
*/
|
|
6674
|
-
readonly message: string;
|
|
6675
|
-
/**
|
|
6676
|
-
* @remarks
|
|
6677
|
-
* Player that sent the chat message.
|
|
6678
|
-
*
|
|
6679
|
-
*/
|
|
6680
|
-
readonly sender: Player;
|
|
6681
|
-
/**
|
|
6682
|
-
* @remarks
|
|
6683
|
-
* Optional list of players that will receive this message. If
|
|
6684
|
-
* defined, this message is directly targeted to one or more
|
|
6685
|
-
* players (i.e., is not broadcast.)
|
|
6686
|
-
*
|
|
6687
|
-
*/
|
|
6688
|
-
readonly targets?: Player[];
|
|
6689
|
-
}
|
|
6690
|
-
|
|
6691
|
-
/**
|
|
6692
|
-
* @beta
|
|
6693
|
-
* Manages callbacks that are connected to an event that fires
|
|
6694
|
-
* before chat messages are sent.
|
|
6695
|
-
* @example customCommand.ts
|
|
6696
|
-
* ```typescript
|
|
6697
|
-
* import { world, DimensionLocation } from '@minecraft/server';
|
|
6698
|
-
*
|
|
6699
|
-
* function customCommand(targetLocation: DimensionLocation) {
|
|
6700
|
-
* const chatCallback = world.beforeEvents.chatSend.subscribe(eventData => {
|
|
6701
|
-
* if (eventData.message.includes('cancel')) {
|
|
6702
|
-
* // Cancel event if the message contains "cancel"
|
|
6703
|
-
* eventData.cancel = true;
|
|
6704
|
-
* } else {
|
|
6705
|
-
* const args = eventData.message.split(' ');
|
|
6706
|
-
*
|
|
6707
|
-
* if (args.length > 0) {
|
|
6708
|
-
* switch (args[0].toLowerCase()) {
|
|
6709
|
-
* case 'echo':
|
|
6710
|
-
* // Send a modified version of chat message
|
|
6711
|
-
* world.sendMessage(`Echo '${eventData.message.substring(4).trim()}'`);
|
|
6712
|
-
* break;
|
|
6713
|
-
* case 'help':
|
|
6714
|
-
* world.sendMessage(`Available commands: echo <message>`);
|
|
6715
|
-
* break;
|
|
6716
|
-
* }
|
|
6717
|
-
* }
|
|
6718
|
-
* }
|
|
6719
|
-
* });
|
|
6720
|
-
* }
|
|
6721
|
-
* ```
|
|
6722
|
-
*/
|
|
6723
|
-
export class ChatSendBeforeEventSignal {
|
|
6724
|
-
private constructor();
|
|
6725
|
-
/**
|
|
6726
|
-
* @remarks
|
|
6727
|
-
* Adds a callback that will be called before new chat messages
|
|
6728
|
-
* are sent.
|
|
6729
|
-
*
|
|
6730
|
-
* This function can't be called in restricted-execution mode.
|
|
6731
|
-
*
|
|
6732
|
-
* This function can be called in early-execution mode.
|
|
6733
|
-
*
|
|
6734
|
-
* @param callback
|
|
6735
|
-
* This closure is called with restricted-execution privilege.
|
|
6736
|
-
* @returns
|
|
6737
|
-
* Closure that is called with restricted-execution privilege.
|
|
6738
|
-
*/
|
|
6739
|
-
subscribe(callback: (arg0: ChatSendBeforeEvent) => void): (arg0: ChatSendBeforeEvent) => void;
|
|
6740
|
-
/**
|
|
6741
|
-
* @remarks
|
|
6742
|
-
* Removes a callback from being called before new chat
|
|
6743
|
-
* messages are sent.
|
|
6744
|
-
*
|
|
6745
|
-
* This function can't be called in restricted-execution mode.
|
|
6746
|
-
*
|
|
6747
|
-
* This function can be called in early-execution mode.
|
|
6748
|
-
*
|
|
6749
|
-
* @param callback
|
|
6750
|
-
* This closure is called with restricted-execution privilege.
|
|
6751
|
-
*/
|
|
6752
|
-
unsubscribe(callback: (arg0: ChatSendBeforeEvent) => void): void;
|
|
6753
|
-
}
|
|
6754
|
-
|
|
6755
6089
|
/**
|
|
6756
6090
|
* Contains the device information for a client instance.
|
|
6757
6091
|
*/
|
|
@@ -6759,7 +6093,7 @@ export class ChatSendBeforeEventSignal {
|
|
|
6759
6093
|
export class ClientSystemInfo extends SystemInfo {
|
|
6760
6094
|
private constructor();
|
|
6761
6095
|
/**
|
|
6762
|
-
* @
|
|
6096
|
+
* @rc
|
|
6763
6097
|
* @remarks
|
|
6764
6098
|
* The locale selected by the client (e.g., en_US, fr_FR,
|
|
6765
6099
|
* ja_JP). Note that in most cases, server scripts should not
|
|
@@ -6824,258 +6158,6 @@ export class Component {
|
|
|
6824
6158
|
readonly typeId: string;
|
|
6825
6159
|
}
|
|
6826
6160
|
|
|
6827
|
-
/**
|
|
6828
|
-
* @beta
|
|
6829
|
-
* The Compound Block Volume is a collection of individual
|
|
6830
|
-
* block volume definitions which, as a collection, define a
|
|
6831
|
-
* larger volume of (sometimes non-contiguous) irregular
|
|
6832
|
-
* shapes.
|
|
6833
|
-
* This class is loosely based on the concept of CSG
|
|
6834
|
-
* (Computational Solid Geometry) and allows a user to create
|
|
6835
|
-
* complex volumes by building a stack of volumes and voids to
|
|
6836
|
-
* make a larger single volume.
|
|
6837
|
-
* For example - normally a creator would create a hollow cube
|
|
6838
|
-
* by creating 6 "wall" surfaces for each face.
|
|
6839
|
-
* With a Compound Block Volume, a creator can define a hollow
|
|
6840
|
-
* cube by creating a single outer solid cube, and then
|
|
6841
|
-
* defining a further single 'void' cube inside the larger one.
|
|
6842
|
-
* Similarly, the Compound Block Volume can represent irregular
|
|
6843
|
-
* shaped volumes (e.g. a tree consists of a trunk and lots of
|
|
6844
|
-
* leaf cubes which are not necessarily contiguously placed).
|
|
6845
|
-
* Each of the volumes added to the CompoundBlockVolume are (by
|
|
6846
|
-
* default) relative to the origin set (either at construction
|
|
6847
|
-
* or via one of the set functions).
|
|
6848
|
-
* However, it is also possible to push volumes to the compound
|
|
6849
|
-
* collection which are absolute in nature and are not affected
|
|
6850
|
-
* by origin changes.
|
|
6851
|
-
*/
|
|
6852
|
-
export class CompoundBlockVolume {
|
|
6853
|
-
/**
|
|
6854
|
-
* @remarks
|
|
6855
|
-
* Return the 'capacity' of the bounding rectangle which
|
|
6856
|
-
* represents the collection of volumes in the stack
|
|
6857
|
-
*
|
|
6858
|
-
*/
|
|
6859
|
-
readonly capacity: number;
|
|
6860
|
-
readonly items: CompoundBlockVolumeItem[];
|
|
6861
|
-
readonly itemsAbsolute: CompoundBlockVolumeItem[];
|
|
6862
|
-
/**
|
|
6863
|
-
* @remarks
|
|
6864
|
-
* Return the number of volumes (positive and negative) in the
|
|
6865
|
-
* volume stack
|
|
6866
|
-
*
|
|
6867
|
-
*/
|
|
6868
|
-
readonly volumeCount: number;
|
|
6869
|
-
/**
|
|
6870
|
-
* @remarks
|
|
6871
|
-
* Create a CompoundBlockVolume object
|
|
6872
|
-
*
|
|
6873
|
-
* @param origin
|
|
6874
|
-
* An optional world space origin on which to center the
|
|
6875
|
-
* compound volume.
|
|
6876
|
-
* If not specified, the origin is set to (0,0,0)
|
|
6877
|
-
*/
|
|
6878
|
-
constructor(origin?: Vector3);
|
|
6879
|
-
/**
|
|
6880
|
-
* @remarks
|
|
6881
|
-
* Clear the contents of the volume stack
|
|
6882
|
-
*
|
|
6883
|
-
* This function can't be called in restricted-execution mode.
|
|
6884
|
-
*
|
|
6885
|
-
*/
|
|
6886
|
-
clear(): void;
|
|
6887
|
-
/**
|
|
6888
|
-
* @remarks
|
|
6889
|
-
* Fetch a Block Location Iterator for the Compound Block
|
|
6890
|
-
* Volume. This iterator will allow a creator to iterate
|
|
6891
|
-
* across all of the selected volumes within the larger
|
|
6892
|
-
* bounding area.
|
|
6893
|
-
* Areas of a volume which have been overridden by a
|
|
6894
|
-
* subtractive volume will not be included in the iterator
|
|
6895
|
-
* step.
|
|
6896
|
-
* (i.e. if you push a cube to the stack, and then push a
|
|
6897
|
-
* subtractive volume to the same location, then the iterator
|
|
6898
|
-
* will step over the initial volume because it is considered
|
|
6899
|
-
* negative space)
|
|
6900
|
-
* Note that the Block Locations returned by this iterator are
|
|
6901
|
-
* in absolute world space (irrespective of whether the
|
|
6902
|
-
* compound volume items pushed are absolute or relative)
|
|
6903
|
-
*
|
|
6904
|
-
* This function can't be called in restricted-execution mode.
|
|
6905
|
-
*
|
|
6906
|
-
*/
|
|
6907
|
-
getBlockLocationIterator(): BlockLocationIterator;
|
|
6908
|
-
/**
|
|
6909
|
-
* @remarks
|
|
6910
|
-
* Get the largest bounding box that represents a container for
|
|
6911
|
-
* all of the volumes on the stack
|
|
6912
|
-
* Note that the bounding box returned is represented in
|
|
6913
|
-
* absolute world space (irrespective of whether the compound
|
|
6914
|
-
* volume items pushed are absolute or relative)
|
|
6915
|
-
*
|
|
6916
|
-
* This function can't be called in restricted-execution mode.
|
|
6917
|
-
*
|
|
6918
|
-
*/
|
|
6919
|
-
getBoundingBox(): BlockBoundingBox;
|
|
6920
|
-
/**
|
|
6921
|
-
* @remarks
|
|
6922
|
-
* Get the max block location of the outermost bounding
|
|
6923
|
-
* rectangle which represents the volumes on the stack.
|
|
6924
|
-
* Note that the max location returned is in absolute world
|
|
6925
|
-
* space (irrespective of whether the compound volume items
|
|
6926
|
-
* pushed are absolute or relative)
|
|
6927
|
-
*
|
|
6928
|
-
* This function can't be called in restricted-execution mode.
|
|
6929
|
-
*
|
|
6930
|
-
*/
|
|
6931
|
-
getMax(): Vector3;
|
|
6932
|
-
/**
|
|
6933
|
-
* @remarks
|
|
6934
|
-
* Get the min block location of the outermost bounding
|
|
6935
|
-
* rectangle which represents the volumes on the stack.
|
|
6936
|
-
* Note that the min location returned is in absolute world
|
|
6937
|
-
* space (irrespective of whether the compound volume items
|
|
6938
|
-
* pushed are absolute or relative)
|
|
6939
|
-
*
|
|
6940
|
-
* This function can't be called in restricted-execution mode.
|
|
6941
|
-
*
|
|
6942
|
-
*/
|
|
6943
|
-
getMin(): Vector3;
|
|
6944
|
-
/**
|
|
6945
|
-
* @remarks
|
|
6946
|
-
* Fetch the origin in world space of the compound volume
|
|
6947
|
-
*
|
|
6948
|
-
* This function can't be called in restricted-execution mode.
|
|
6949
|
-
*
|
|
6950
|
-
*/
|
|
6951
|
-
getOrigin(): Vector3;
|
|
6952
|
-
/**
|
|
6953
|
-
* @remarks
|
|
6954
|
-
* Return a boolean which signals if there are any volume items
|
|
6955
|
-
* pushed to the volume
|
|
6956
|
-
*
|
|
6957
|
-
* This function can't be called in restricted-execution mode.
|
|
6958
|
-
*
|
|
6959
|
-
*/
|
|
6960
|
-
isEmpty(): boolean;
|
|
6961
|
-
/**
|
|
6962
|
-
* @remarks
|
|
6963
|
-
* Return a boolean representing whether or not a given
|
|
6964
|
-
* absolute world space block location is inside a positive
|
|
6965
|
-
* block volume.
|
|
6966
|
-
* E.g. if the stack contains a large cube followed by a
|
|
6967
|
-
* slightly smaller negative cube, and the test location is
|
|
6968
|
-
* within the negative cube - the function will return false
|
|
6969
|
-
* because it's not 'inside' a volume (it IS inside the
|
|
6970
|
-
* bounding rectangle, but it is not inside a positively
|
|
6971
|
-
* defined location)
|
|
6972
|
-
*
|
|
6973
|
-
* This function can't be called in restricted-execution mode.
|
|
6974
|
-
*
|
|
6975
|
-
*/
|
|
6976
|
-
isInside(worldLocation: Vector3): boolean;
|
|
6977
|
-
/**
|
|
6978
|
-
* @remarks
|
|
6979
|
-
* Inspect the last entry pushed to the volume stack without
|
|
6980
|
-
* affecting the stack contents.
|
|
6981
|
-
*
|
|
6982
|
-
* This function can't be called in restricted-execution mode.
|
|
6983
|
-
*
|
|
6984
|
-
* @param forceRelativity
|
|
6985
|
-
* Determine whether the function returns a
|
|
6986
|
-
* CompoundBlockVolumeItem which is forced into either relative
|
|
6987
|
-
* or absolute coordinate system.
|
|
6988
|
-
* `true` = force returned item to be relative to volume origin
|
|
6989
|
-
* `false` = force returned item to be absolute world space
|
|
6990
|
-
* location
|
|
6991
|
-
*
|
|
6992
|
-
* If no flag is specified, the item returned retains whatever
|
|
6993
|
-
* relativity it had when it was pushed
|
|
6994
|
-
* @returns
|
|
6995
|
-
* Returns undefined if the stack is empty
|
|
6996
|
-
*/
|
|
6997
|
-
peekLastVolume(forceRelativity?: CompoundBlockVolumePositionRelativity): CompoundBlockVolumeItem | undefined;
|
|
6998
|
-
/**
|
|
6999
|
-
* @remarks
|
|
7000
|
-
* Remove the last entry from the volume stack. This will
|
|
7001
|
-
* reduce the stack size by one
|
|
7002
|
-
*
|
|
7003
|
-
* This function can't be called in restricted-execution mode.
|
|
7004
|
-
*
|
|
7005
|
-
*/
|
|
7006
|
-
popVolume(): boolean;
|
|
7007
|
-
/**
|
|
7008
|
-
* @remarks
|
|
7009
|
-
* Push a volume item to the stack. The volume item contains
|
|
7010
|
-
* an 'action' parameter which determines whether this volume
|
|
7011
|
-
* is a positive or negative space.
|
|
7012
|
-
* The item also contains a `locationRelativity` which
|
|
7013
|
-
* determines whether it is relative or absolute to the
|
|
7014
|
-
* compound volume origin
|
|
7015
|
-
*
|
|
7016
|
-
* This function can't be called in restricted-execution mode.
|
|
7017
|
-
*
|
|
7018
|
-
* @param item
|
|
7019
|
-
* Item to push to the end of the stack
|
|
7020
|
-
*/
|
|
7021
|
-
pushVolume(item: CompoundBlockVolumeItem): void;
|
|
7022
|
-
/**
|
|
7023
|
-
* @remarks
|
|
7024
|
-
* If the volume stack is empty, this function will push the
|
|
7025
|
-
* specified item to the stack.
|
|
7026
|
-
* If the volume stack is NOT empty, this function will replace
|
|
7027
|
-
* the last item on the stack with the new item.
|
|
7028
|
-
*
|
|
7029
|
-
* This function can't be called in restricted-execution mode.
|
|
7030
|
-
*
|
|
7031
|
-
* @param item
|
|
7032
|
-
* Item to add or replace
|
|
7033
|
-
*/
|
|
7034
|
-
replaceOrAddLastVolume(item: CompoundBlockVolumeItem): boolean;
|
|
7035
|
-
/**
|
|
7036
|
-
* @remarks
|
|
7037
|
-
* Set the origin of the compound volume to an absolute world
|
|
7038
|
-
* space location
|
|
7039
|
-
*
|
|
7040
|
-
* This function can't be called in restricted-execution mode.
|
|
7041
|
-
*
|
|
7042
|
-
* @param preserveExistingVolumes
|
|
7043
|
-
* This optional boolean flag determines whether the relative
|
|
7044
|
-
* `CompoundBlockVolumeItem`'s are frozen in place, or are
|
|
7045
|
-
* affected by the new origin.
|
|
7046
|
-
* Imagine a scenario where you have a series of relative
|
|
7047
|
-
* locations around an origin which make up a sphere; all of
|
|
7048
|
-
* these locations are in the range of -2 to 2.
|
|
7049
|
-
* Push each of these locations to the compound volume as
|
|
7050
|
-
* relative items.
|
|
7051
|
-
* Now, move the origin and all of the locations representing
|
|
7052
|
-
* the sphere move accordingly.
|
|
7053
|
-
* However, let's say you want to add a 2nd sphere next to the
|
|
7054
|
-
* 1st.
|
|
7055
|
-
* In this case, set the new origin a few locations over, but
|
|
7056
|
-
* 'preserveExistingVolumes' = true.
|
|
7057
|
-
* This will set a new origin, but the existing sphere
|
|
7058
|
-
* locations will remain relative to the original origin.
|
|
7059
|
-
* Now, you can push the relative sphere locations again (this
|
|
7060
|
-
* time they will be relative to the new origin) - resulting in
|
|
7061
|
-
* 2 spheres next to each other.
|
|
7062
|
-
*/
|
|
7063
|
-
setOrigin(position: Vector3, preserveExistingVolumes?: boolean): void;
|
|
7064
|
-
/**
|
|
7065
|
-
* @remarks
|
|
7066
|
-
* Similar to {@link CompoundBlockVolume.setOrigin} - this
|
|
7067
|
-
* function will translate the origin by a given delta to a new
|
|
7068
|
-
* position
|
|
7069
|
-
*
|
|
7070
|
-
* This function can't be called in restricted-execution mode.
|
|
7071
|
-
*
|
|
7072
|
-
* @param preserveExistingVolumes
|
|
7073
|
-
* See the description for the arguments to {@link
|
|
7074
|
-
* CompoundBlockVolume.setOrigin}
|
|
7075
|
-
*/
|
|
7076
|
-
translateOrigin(delta: Vector3, preserveExistingVolumes?: boolean): void;
|
|
7077
|
-
}
|
|
7078
|
-
|
|
7079
6161
|
/**
|
|
7080
6162
|
* Represents a container that can hold sets of items. Used
|
|
7081
6163
|
* with entities such as Players, Chest Minecarts, Llamas, and
|
|
@@ -7213,9 +6295,7 @@ export class Container {
|
|
|
7213
6295
|
*
|
|
7214
6296
|
* @param itemStack
|
|
7215
6297
|
* The stack of items to add.
|
|
7216
|
-
* @throws
|
|
7217
|
-
* Won't throw {@link ContainerRules} error for over weight
|
|
7218
|
-
* limit but will instead add items up to the weight limit.
|
|
6298
|
+
* @throws This function can throw errors.
|
|
7219
6299
|
*
|
|
7220
6300
|
* {@link ContainerRulesError}
|
|
7221
6301
|
*
|
|
@@ -7453,8 +6533,6 @@ export class Container {
|
|
|
7453
6533
|
* @throws
|
|
7454
6534
|
* Throws if either this container or `toContainer` are invalid
|
|
7455
6535
|
* or if the `fromSlot` or `toSlot` indices out of bounds.
|
|
7456
|
-
* Won't throw {@link ContainerRules} error for over weight
|
|
7457
|
-
* limit but will instead add items up to the weight limit.
|
|
7458
6536
|
*
|
|
7459
6537
|
* {@link ContainerRulesError}
|
|
7460
6538
|
*
|
|
@@ -8237,30 +7315,6 @@ export class Dimension {
|
|
|
8237
7315
|
block: BlockPermutation | BlockType | string,
|
|
8238
7316
|
options?: BlockFillOptions,
|
|
8239
7317
|
): ListBlockVolume;
|
|
8240
|
-
/**
|
|
8241
|
-
* @beta
|
|
8242
|
-
* @remarks
|
|
8243
|
-
* Finds the location of the closest biome of a particular
|
|
8244
|
-
* type. Note that the findClosestBiome operation can take some
|
|
8245
|
-
* time to complete, so avoid using many of these calls within
|
|
8246
|
-
* a particular tick.
|
|
8247
|
-
*
|
|
8248
|
-
* @param pos
|
|
8249
|
-
* Starting location to look for a biome to find.
|
|
8250
|
-
* @param biomeToFind
|
|
8251
|
-
* Identifier of the biome to look for.
|
|
8252
|
-
* @param options
|
|
8253
|
-
* Additional selection criteria for a biome search.
|
|
8254
|
-
* @returns
|
|
8255
|
-
* Returns a location of the biome, or undefined if a biome
|
|
8256
|
-
* could not be found.
|
|
8257
|
-
* @throws This function can throw errors.
|
|
8258
|
-
*
|
|
8259
|
-
* {@link minecraftcommon.EngineError}
|
|
8260
|
-
*
|
|
8261
|
-
* {@link Error}
|
|
8262
|
-
*/
|
|
8263
|
-
findClosestBiome(pos: Vector3, biomeToFind: BiomeType | string, options?: BiomeSearchOptions): Vector3 | undefined;
|
|
8264
7318
|
/**
|
|
8265
7319
|
* @remarks
|
|
8266
7320
|
* Returns the biome type at the specified location.
|
|
@@ -8480,26 +7534,6 @@ export class Dimension {
|
|
|
8480
7534
|
* {@link minecraftcommon.UnsupportedFunctionalityError}
|
|
8481
7535
|
*/
|
|
8482
7536
|
getEntitiesFromRay(location: Vector3, direction: Vector3, options?: EntityRaycastOptions): EntityRaycastHit[];
|
|
8483
|
-
/**
|
|
8484
|
-
* @beta
|
|
8485
|
-
* @remarks
|
|
8486
|
-
* Returns a vector of generated structures that contain the
|
|
8487
|
-
* specified location (ex: Pillager Outpost, Mineshaft, etc.).
|
|
8488
|
-
* The vector will be empty if no structures are found.
|
|
8489
|
-
*
|
|
8490
|
-
* @param location
|
|
8491
|
-
* Location at which to check for structures.
|
|
8492
|
-
* @throws
|
|
8493
|
-
* An error will be thrown if the location is out of world
|
|
8494
|
-
* bounds.
|
|
8495
|
-
* An error will be thrown if the location is in an unloaded
|
|
8496
|
-
* chunk.
|
|
8497
|
-
*
|
|
8498
|
-
* {@link LocationInUnloadedChunkError}
|
|
8499
|
-
*
|
|
8500
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
8501
|
-
*/
|
|
8502
|
-
getGeneratedStructures(location: Vector3): (minecraftvanilladata.MinecraftFeatureTypes | string)[];
|
|
8503
7537
|
/**
|
|
8504
7538
|
* @remarks
|
|
8505
7539
|
* Returns the total brightness level of light shining on a
|
|
@@ -8561,16 +7595,6 @@ export class Dimension {
|
|
|
8561
7595
|
* @throws This function can throw errors.
|
|
8562
7596
|
*/
|
|
8563
7597
|
getTopmostBlock(locationXZ: VectorXZ, minHeight?: number): Block | undefined;
|
|
8564
|
-
/**
|
|
8565
|
-
* @beta
|
|
8566
|
-
* @remarks
|
|
8567
|
-
* Returns the current weather.
|
|
8568
|
-
*
|
|
8569
|
-
* @returns
|
|
8570
|
-
* Returns a WeatherType that explains the broad category of
|
|
8571
|
-
* weather that is currently going on.
|
|
8572
|
-
*/
|
|
8573
|
-
getWeather(): WeatherType;
|
|
8574
7598
|
/**
|
|
8575
7599
|
* @remarks
|
|
8576
7600
|
* Returns true if the chunk at the given location is loaded
|
|
@@ -8814,11 +7838,7 @@ export class Dimension {
|
|
|
8814
7838
|
* }
|
|
8815
7839
|
* ```
|
|
8816
7840
|
*/
|
|
8817
|
-
spawnEntity
|
|
8818
|
-
identifier: EntityIdentifierType<NoInfer<T>>,
|
|
8819
|
-
location: Vector3,
|
|
8820
|
-
options?: SpawnEntityOptions,
|
|
8821
|
-
): Entity;
|
|
7841
|
+
spawnEntity(identifier: EntityType | string, location: Vector3, options?: SpawnEntityOptions): Entity;
|
|
8822
7842
|
/**
|
|
8823
7843
|
* @remarks
|
|
8824
7844
|
* Creates a new item stack as an entity at the specified
|
|
@@ -8913,83 +7933,6 @@ export class Dimension {
|
|
|
8913
7933
|
* ```
|
|
8914
7934
|
*/
|
|
8915
7935
|
spawnParticle(effectName: string, location: Vector3, molangVariables?: MolangVariableMap): void;
|
|
8916
|
-
/**
|
|
8917
|
-
* @beta
|
|
8918
|
-
* @remarks
|
|
8919
|
-
* Spawns an experience orb at a specified location in the
|
|
8920
|
-
* dimension.
|
|
8921
|
-
*
|
|
8922
|
-
* This function can't be called in restricted-execution mode.
|
|
8923
|
-
*
|
|
8924
|
-
* @param location
|
|
8925
|
-
* The location at which to spawn the experience orb.
|
|
8926
|
-
* @param amount
|
|
8927
|
-
* The amount of experience to give the experience orb.
|
|
8928
|
-
* Bounds: [1, 12000]
|
|
8929
|
-
* @throws This function can throw errors.
|
|
8930
|
-
*
|
|
8931
|
-
* {@link LocationInUnloadedChunkError}
|
|
8932
|
-
*
|
|
8933
|
-
* {@link LocationOutOfWorldBoundariesError}
|
|
8934
|
-
*/
|
|
8935
|
-
spawnXp(location: Vector3, amount: number): void;
|
|
8936
|
-
/**
|
|
8937
|
-
* @beta
|
|
8938
|
-
* @remarks
|
|
8939
|
-
* Stops all sounds from playing for all players.
|
|
8940
|
-
*
|
|
8941
|
-
* This function can't be called in restricted-execution mode.
|
|
8942
|
-
*
|
|
8943
|
-
*/
|
|
8944
|
-
stopAllSounds(): void;
|
|
8945
|
-
/**
|
|
8946
|
-
* @beta
|
|
8947
|
-
* @remarks
|
|
8948
|
-
* Stops a sound from playing for all players.
|
|
8949
|
-
*
|
|
8950
|
-
* This function can't be called in restricted-execution mode.
|
|
8951
|
-
*
|
|
8952
|
-
* @param soundId
|
|
8953
|
-
* Identifier of the sound.
|
|
8954
|
-
*/
|
|
8955
|
-
stopSound(soundId: string): void;
|
|
8956
|
-
}
|
|
8957
|
-
|
|
8958
|
-
/**
|
|
8959
|
-
* @beta
|
|
8960
|
-
* Provides the functionality for registering custom
|
|
8961
|
-
* dimensions. Custom dimensions can only be registered during
|
|
8962
|
-
* the system startup event.
|
|
8963
|
-
*/
|
|
8964
|
-
export class DimensionRegistry {
|
|
8965
|
-
private constructor();
|
|
8966
|
-
/**
|
|
8967
|
-
* @remarks
|
|
8968
|
-
* Registers a new custom dimension type. Must be called during
|
|
8969
|
-
* the system startup event. The dimension will be created
|
|
8970
|
-
* using the void generator.
|
|
8971
|
-
*
|
|
8972
|
-
* This function can be called in early-execution mode.
|
|
8973
|
-
*
|
|
8974
|
-
* @param typeId
|
|
8975
|
-
* The namespaced identifier for the custom dimension (e.g.,
|
|
8976
|
-
* 'mypack:my_dimension'). Must include a namespace and use
|
|
8977
|
-
* only valid identifier characters.
|
|
8978
|
-
* @throws This function can throw errors.
|
|
8979
|
-
*
|
|
8980
|
-
* {@link CustomDimensionAlreadyRegisteredError}
|
|
8981
|
-
*
|
|
8982
|
-
* {@link CustomDimensionInvalidRegistryError}
|
|
8983
|
-
*
|
|
8984
|
-
* {@link CustomDimensionNameError}
|
|
8985
|
-
*
|
|
8986
|
-
* {@link CustomDimensionReloadNewDimensionError}
|
|
8987
|
-
*
|
|
8988
|
-
* {@link minecraftcommon.EngineError}
|
|
8989
|
-
*
|
|
8990
|
-
* {@link NamespaceNameError}
|
|
8991
|
-
*/
|
|
8992
|
-
registerCustomDimension(typeId: string): void;
|
|
8993
7936
|
}
|
|
8994
7937
|
|
|
8995
7938
|
/**
|
|
@@ -9504,26 +8447,6 @@ export class Entity {
|
|
|
9504
8447
|
* {@link InvalidEntityError}
|
|
9505
8448
|
*/
|
|
9506
8449
|
readonly location: Vector3;
|
|
9507
|
-
/**
|
|
9508
|
-
* @beta
|
|
9509
|
-
* @remarks
|
|
9510
|
-
* Boolean which determines if the player nameplate should be
|
|
9511
|
-
* depth tested for visibility.
|
|
9512
|
-
*
|
|
9513
|
-
* This property can't be edited in restricted-execution mode.
|
|
9514
|
-
*
|
|
9515
|
-
*/
|
|
9516
|
-
nameplateDepthTested: boolean;
|
|
9517
|
-
/**
|
|
9518
|
-
* @beta
|
|
9519
|
-
* @remarks
|
|
9520
|
-
* Float that determines the render distance of this entity's
|
|
9521
|
-
* nameplate.
|
|
9522
|
-
*
|
|
9523
|
-
* This property can't be edited in restricted-execution mode.
|
|
9524
|
-
*
|
|
9525
|
-
*/
|
|
9526
|
-
nameplateRenderDistance: number;
|
|
9527
8450
|
/**
|
|
9528
8451
|
* @remarks
|
|
9529
8452
|
* Given name of the entity.
|
|
@@ -9539,18 +8462,6 @@ export class Entity {
|
|
|
9539
8462
|
*
|
|
9540
8463
|
*/
|
|
9541
8464
|
readonly scoreboardIdentity?: ScoreboardIdentity;
|
|
9542
|
-
/**
|
|
9543
|
-
* @beta
|
|
9544
|
-
* @remarks
|
|
9545
|
-
* Retrieves or sets an entity that is used as the target of
|
|
9546
|
-
* AI-related behaviors, like attacking. If the entity
|
|
9547
|
-
* currently has no target returns undefined.
|
|
9548
|
-
*
|
|
9549
|
-
* @throws This property can throw when used.
|
|
9550
|
-
*
|
|
9551
|
-
* {@link InvalidEntityError}
|
|
9552
|
-
*/
|
|
9553
|
-
readonly target?: Entity;
|
|
9554
8465
|
/**
|
|
9555
8466
|
* @remarks
|
|
9556
8467
|
* Identifier of the type of the entity - for example,
|
|
@@ -10792,18 +9703,6 @@ export class EntityBaseMovementComponent extends EntityComponent {
|
|
|
10792
9703
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
10793
9704
|
export class EntityBreathableComponent extends EntityComponent {
|
|
10794
9705
|
private constructor();
|
|
10795
|
-
/**
|
|
10796
|
-
* @beta
|
|
10797
|
-
* @remarks
|
|
10798
|
-
* The current air supply of the entity.
|
|
10799
|
-
*
|
|
10800
|
-
* This property can't be edited in restricted-execution mode.
|
|
10801
|
-
*
|
|
10802
|
-
* @throws
|
|
10803
|
-
* Will throw an error if the air supply is out of bounds
|
|
10804
|
-
* [suffocationTime, maxAirSupply].
|
|
10805
|
-
*/
|
|
10806
|
-
airSupply: number;
|
|
10807
9706
|
/**
|
|
10808
9707
|
* @remarks
|
|
10809
9708
|
* If true, this entity can breathe in air.
|
|
@@ -10832,14 +9731,6 @@ export class EntityBreathableComponent extends EntityComponent {
|
|
|
10832
9731
|
* @throws This property can throw when used.
|
|
10833
9732
|
*/
|
|
10834
9733
|
readonly breathesWater: boolean;
|
|
10835
|
-
/**
|
|
10836
|
-
* @beta
|
|
10837
|
-
* @remarks
|
|
10838
|
-
* If true, the entity is able to breathe.
|
|
10839
|
-
*
|
|
10840
|
-
* @throws This property can throw when used.
|
|
10841
|
-
*/
|
|
10842
|
-
readonly canBreathe: boolean;
|
|
10843
9734
|
/**
|
|
10844
9735
|
* @remarks
|
|
10845
9736
|
* If true, this entity will have visible bubbles while in
|
|
@@ -10974,7 +9865,7 @@ export class EntityComponent extends Component {
|
|
|
10974
9865
|
}
|
|
10975
9866
|
|
|
10976
9867
|
/**
|
|
10977
|
-
* @
|
|
9868
|
+
* @rc
|
|
10978
9869
|
* Contains information regarding a specific entity container
|
|
10979
9870
|
* being closed.
|
|
10980
9871
|
*/
|
|
@@ -10990,7 +9881,7 @@ export class EntityContainerClosedAfterEvent {
|
|
|
10990
9881
|
}
|
|
10991
9882
|
|
|
10992
9883
|
/**
|
|
10993
|
-
* @
|
|
9884
|
+
* @rc
|
|
10994
9885
|
* Manages callbacks that are connected to when an entity
|
|
10995
9886
|
* container is closed.
|
|
10996
9887
|
*/
|
|
@@ -11024,7 +9915,7 @@ export class EntityContainerClosedAfterEventSignal {
|
|
|
11024
9915
|
}
|
|
11025
9916
|
|
|
11026
9917
|
/**
|
|
11027
|
-
* @
|
|
9918
|
+
* @rc
|
|
11028
9919
|
* Contains information regarding a specific entity container
|
|
11029
9920
|
* being opened.
|
|
11030
9921
|
*/
|
|
@@ -11040,7 +9931,7 @@ export class EntityContainerOpenedAfterEvent {
|
|
|
11040
9931
|
}
|
|
11041
9932
|
|
|
11042
9933
|
/**
|
|
11043
|
-
* @
|
|
9934
|
+
* @rc
|
|
11044
9935
|
* Manages callbacks that are connected to when an entity
|
|
11045
9936
|
* container is opened.
|
|
11046
9937
|
*/
|
|
@@ -11167,7 +10058,7 @@ export class EntityDieAfterEventSignal {
|
|
|
11167
10058
|
}
|
|
11168
10059
|
|
|
11169
10060
|
/**
|
|
11170
|
-
* @
|
|
10061
|
+
* @rc
|
|
11171
10062
|
* Represents this entity's ender inventory properties. This
|
|
11172
10063
|
* component is always present on players and any items in its
|
|
11173
10064
|
* container will display for the player when they access an
|
|
@@ -12795,42 +11686,6 @@ export class EntityNavigationWalkComponent extends EntityNavigationComponent {
|
|
|
12795
11686
|
static readonly componentId = 'minecraft:navigation.walk';
|
|
12796
11687
|
}
|
|
12797
11688
|
|
|
12798
|
-
/**
|
|
12799
|
-
* @beta
|
|
12800
|
-
* Adds NPC capabilities to an entity such as custom skin,
|
|
12801
|
-
* name, and dialogue interactions.
|
|
12802
|
-
*/
|
|
12803
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
12804
|
-
export class EntityNpcComponent extends EntityComponent {
|
|
12805
|
-
private constructor();
|
|
12806
|
-
/**
|
|
12807
|
-
* @remarks
|
|
12808
|
-
* The DialogueScene that is opened when players first interact
|
|
12809
|
-
* with the NPC.
|
|
12810
|
-
*
|
|
12811
|
-
* This property can't be edited in restricted-execution mode.
|
|
12812
|
-
*
|
|
12813
|
-
*/
|
|
12814
|
-
defaultScene: string;
|
|
12815
|
-
/**
|
|
12816
|
-
* @remarks
|
|
12817
|
-
* The name of the NPC as it is displayed to players.
|
|
12818
|
-
*
|
|
12819
|
-
* This property can't be edited in restricted-execution mode.
|
|
12820
|
-
*
|
|
12821
|
-
*/
|
|
12822
|
-
name: string;
|
|
12823
|
-
/**
|
|
12824
|
-
* @remarks
|
|
12825
|
-
* The index of the skin the NPC will use.
|
|
12826
|
-
*
|
|
12827
|
-
* This property can't be edited in restricted-execution mode.
|
|
12828
|
-
*
|
|
12829
|
-
*/
|
|
12830
|
-
skinIndex: number;
|
|
12831
|
-
static readonly componentId = 'minecraft:npc';
|
|
12832
|
-
}
|
|
12833
|
-
|
|
12834
11689
|
/**
|
|
12835
11690
|
* When present on an entity, this entity is on fire.
|
|
12836
11691
|
* @example setOnFire.ts
|
|
@@ -13702,7 +12557,7 @@ export class EntityTypes {
|
|
|
13702
12557
|
* Retrieves an entity type using a string-based identifier.
|
|
13703
12558
|
*
|
|
13704
12559
|
*/
|
|
13705
|
-
static get
|
|
12560
|
+
static get(identifier: string): EntityType | undefined;
|
|
13706
12561
|
/**
|
|
13707
12562
|
* @remarks
|
|
13708
12563
|
* Retrieves a set of all entity types within this world.
|
|
@@ -13749,51 +12604,6 @@ export class EntityWantsJockeyComponent extends EntityComponent {
|
|
|
13749
12604
|
static readonly componentId = 'minecraft:wants_jockey';
|
|
13750
12605
|
}
|
|
13751
12606
|
|
|
13752
|
-
/**
|
|
13753
|
-
* @beta
|
|
13754
|
-
* Waypoint that tracks an entity's position. The waypoint
|
|
13755
|
-
* automatically updates as the entity moves and becomes
|
|
13756
|
-
* invalid when the entity is removed.
|
|
13757
|
-
*/
|
|
13758
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
13759
|
-
export class EntityWaypoint extends Waypoint {
|
|
13760
|
-
/**
|
|
13761
|
-
* @remarks
|
|
13762
|
-
* The entity being tracked by this waypoint.
|
|
13763
|
-
*
|
|
13764
|
-
* @throws This property can throw when used.
|
|
13765
|
-
*
|
|
13766
|
-
* {@link InvalidWaypointError}
|
|
13767
|
-
*
|
|
13768
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
13769
|
-
*/
|
|
13770
|
-
readonly entity: Entity;
|
|
13771
|
-
/**
|
|
13772
|
-
* @remarks
|
|
13773
|
-
* The visibility rules that control when the waypoint is shown
|
|
13774
|
-
* based on the entity's state (e.g., sneaking, invisible,
|
|
13775
|
-
* dead).
|
|
13776
|
-
*
|
|
13777
|
-
* @throws This property can throw when used.
|
|
13778
|
-
*
|
|
13779
|
-
* {@link InvalidWaypointError}
|
|
13780
|
-
*
|
|
13781
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
13782
|
-
*/
|
|
13783
|
-
readonly entityRules: EntityVisibilityRules;
|
|
13784
|
-
/**
|
|
13785
|
-
* @throws This function can throw errors.
|
|
13786
|
-
*
|
|
13787
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
13788
|
-
*/
|
|
13789
|
-
constructor(
|
|
13790
|
-
entity: Entity,
|
|
13791
|
-
textureSelector: WaypointTextureSelector,
|
|
13792
|
-
entityRules: EntityVisibilityRules,
|
|
13793
|
-
color?: RGB,
|
|
13794
|
-
);
|
|
13795
|
-
}
|
|
13796
|
-
|
|
13797
12607
|
/**
|
|
13798
12608
|
* Loot item function that modifies a dropped treasure map to
|
|
13799
12609
|
* mark a location.
|
|
@@ -14213,13 +13023,6 @@ export class GameRules {
|
|
|
14213
13023
|
*
|
|
14214
13024
|
*/
|
|
14215
13025
|
keepInventory: boolean;
|
|
14216
|
-
/**
|
|
14217
|
-
* @beta
|
|
14218
|
-
* @remarks
|
|
14219
|
-
* This property can't be edited in restricted-execution mode.
|
|
14220
|
-
*
|
|
14221
|
-
*/
|
|
14222
|
-
locatorBar: boolean;
|
|
14223
13026
|
/**
|
|
14224
13027
|
* @remarks
|
|
14225
13028
|
* This property can't be edited in restricted-execution mode.
|
|
@@ -16551,175 +15354,6 @@ export class ListBlockVolume extends BlockVolumeBase {
|
|
|
16551
15354
|
remove(locations: Vector3[]): void;
|
|
16552
15355
|
}
|
|
16553
15356
|
|
|
16554
|
-
/**
|
|
16555
|
-
* @beta
|
|
16556
|
-
* Waypoint that points to a fixed location in the world.
|
|
16557
|
-
* Unlike entity waypoints, location waypoints always remain
|
|
16558
|
-
* valid and their position can be updated.
|
|
16559
|
-
*/
|
|
16560
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
16561
|
-
export class LocationWaypoint extends Waypoint {
|
|
16562
|
-
/**
|
|
16563
|
-
* @throws This function can throw errors.
|
|
16564
|
-
*
|
|
16565
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
16566
|
-
*/
|
|
16567
|
-
constructor(dimensionLocation: DimensionLocation, textureSelector: WaypointTextureSelector, color?: RGB);
|
|
16568
|
-
/**
|
|
16569
|
-
* @remarks
|
|
16570
|
-
* Updates the dimension and location that this waypoint points
|
|
16571
|
-
* to.
|
|
16572
|
-
*
|
|
16573
|
-
* This function can't be called in restricted-execution mode.
|
|
16574
|
-
*
|
|
16575
|
-
* @param dimensionLocation
|
|
16576
|
-
* The new {@link DimensionLocation} (dimension and
|
|
16577
|
-
* coordinates) for the waypoint.
|
|
16578
|
-
*/
|
|
16579
|
-
setDimensionLocation(dimensionLocation: DimensionLocation): void;
|
|
16580
|
-
}
|
|
16581
|
-
|
|
16582
|
-
/**
|
|
16583
|
-
* @beta
|
|
16584
|
-
* Manages the collection of waypoints displayed on a player's
|
|
16585
|
-
* locator bar. Allows adding, removing, and querying waypoints
|
|
16586
|
-
* with a maximum capacity limit.
|
|
16587
|
-
*
|
|
16588
|
-
* Invalid waypoints in the locator bar will be automatically
|
|
16589
|
-
* removed in the next tick. This includes waypoints tied to
|
|
16590
|
-
* entities that have been removed from the world.
|
|
16591
|
-
*
|
|
16592
|
-
* Note: You can control whether vanilla player waypoints are
|
|
16593
|
-
* automatically added to the locator bar using the
|
|
16594
|
-
* `locatorbar` {@link GameRule}. This game rule is currently
|
|
16595
|
-
* named `locatorbar` but will likely be renamed in a future
|
|
16596
|
-
* update to be more descriptive.
|
|
16597
|
-
*
|
|
16598
|
-
* Note: You can only modify, remove, or query waypoints that
|
|
16599
|
-
* were added by this pack.
|
|
16600
|
-
* @example sharedWaypoint.ts
|
|
16601
|
-
* ```typescript
|
|
16602
|
-
* /\*
|
|
16603
|
-
* import { world, LocationWaypoint, WaypointTextureSelector, WaypointTexture } from "@minecraft/server"
|
|
16604
|
-
*
|
|
16605
|
-
* function sharedWaypoint() {
|
|
16606
|
-
* const players = world.getAllPlayers();
|
|
16607
|
-
*
|
|
16608
|
-
* if (players.length < 2) {
|
|
16609
|
-
* console.warn("Need at least 2 players for this example.");
|
|
16610
|
-
* return;
|
|
16611
|
-
* }
|
|
16612
|
-
*
|
|
16613
|
-
* const playerA = players[0];
|
|
16614
|
-
* const playerB = players[1];
|
|
16615
|
-
*
|
|
16616
|
-
* // Create a single waypoint at a specific location
|
|
16617
|
-
* const textureSelector: WaypointTextureSelector = {
|
|
16618
|
-
* textureBoundsList: [
|
|
16619
|
-
* { lowerBound: 0, texture: WaypointTexture.Circle }
|
|
16620
|
-
* ]
|
|
16621
|
-
* };
|
|
16622
|
-
*
|
|
16623
|
-
* const waypoint = new LocationWaypoint(
|
|
16624
|
-
* { dimension: playerA.dimension, x: 100, y: 64, z: 100 },
|
|
16625
|
-
* textureSelector,
|
|
16626
|
-
* { red: 1, green: 0, blue: 0 } // Initially red
|
|
16627
|
-
* );
|
|
16628
|
-
*
|
|
16629
|
-
* // Add the same waypoint to both players' locator bars
|
|
16630
|
-
* playerA.locatorBar.addWaypoint(waypoint);
|
|
16631
|
-
* playerB.locatorBar.addWaypoint(waypoint);
|
|
16632
|
-
*
|
|
16633
|
-
* // Change the color - this affects both players
|
|
16634
|
-
* waypoint.color = { red: 0, green: 1, blue: 0 }; // Now green for both players
|
|
16635
|
-
* }
|
|
16636
|
-
* *\/
|
|
16637
|
-
* ```
|
|
16638
|
-
*/
|
|
16639
|
-
export class LocatorBar {
|
|
16640
|
-
private constructor();
|
|
16641
|
-
/**
|
|
16642
|
-
* @remarks
|
|
16643
|
-
* The current number of waypoints in the locator bar.
|
|
16644
|
-
*
|
|
16645
|
-
*/
|
|
16646
|
-
readonly count: number;
|
|
16647
|
-
/**
|
|
16648
|
-
* @remarks
|
|
16649
|
-
* The maximum number of waypoints that can be added to the
|
|
16650
|
-
* locator bar.
|
|
16651
|
-
*
|
|
16652
|
-
*/
|
|
16653
|
-
readonly maxCount: number;
|
|
16654
|
-
/**
|
|
16655
|
-
* @remarks
|
|
16656
|
-
* Adds a waypoint to the locator bar. Throws an error if the
|
|
16657
|
-
* waypoint already exists, the maximum waypoint limit has been
|
|
16658
|
-
* reached, or the waypoint is invalid.
|
|
16659
|
-
*
|
|
16660
|
-
* This function can't be called in restricted-execution mode.
|
|
16661
|
-
*
|
|
16662
|
-
* @param waypoint
|
|
16663
|
-
* The {@link Waypoint} to add to the locator bar.
|
|
16664
|
-
* @throws This function can throw errors.
|
|
16665
|
-
*
|
|
16666
|
-
* {@link minecraftcommon.EngineError}
|
|
16667
|
-
*
|
|
16668
|
-
* {@link InvalidWaypointError}
|
|
16669
|
-
*
|
|
16670
|
-
* {@link LocatorBarError}
|
|
16671
|
-
*/
|
|
16672
|
-
addWaypoint(waypoint: Waypoint): void;
|
|
16673
|
-
/**
|
|
16674
|
-
* @remarks
|
|
16675
|
-
* Returns an array of all waypoints currently in the locator
|
|
16676
|
-
* bar.
|
|
16677
|
-
*
|
|
16678
|
-
* This function can't be called in restricted-execution mode.
|
|
16679
|
-
*
|
|
16680
|
-
*/
|
|
16681
|
-
getAllWaypoints(): Waypoint[];
|
|
16682
|
-
/**
|
|
16683
|
-
* @remarks
|
|
16684
|
-
* Checks whether the specified waypoint exists in the locator
|
|
16685
|
-
* bar.
|
|
16686
|
-
*
|
|
16687
|
-
* This function can't be called in restricted-execution mode.
|
|
16688
|
-
*
|
|
16689
|
-
* @param waypoint
|
|
16690
|
-
* The {@link Waypoint} to check for.
|
|
16691
|
-
*/
|
|
16692
|
-
hasWaypoint(waypoint: Waypoint): boolean;
|
|
16693
|
-
/**
|
|
16694
|
-
* @remarks
|
|
16695
|
-
* Removes all waypoints from the locator bar, clearing it
|
|
16696
|
-
* completely.
|
|
16697
|
-
*
|
|
16698
|
-
* This function can't be called in restricted-execution mode.
|
|
16699
|
-
*
|
|
16700
|
-
* @throws This function can throw errors.
|
|
16701
|
-
*
|
|
16702
|
-
* {@link minecraftcommon.EngineError}
|
|
16703
|
-
*/
|
|
16704
|
-
removeAllWaypoints(): void;
|
|
16705
|
-
/**
|
|
16706
|
-
* @remarks
|
|
16707
|
-
* Removes a specific waypoint from the locator bar. Returns an
|
|
16708
|
-
* error if the waypoint does not exist in the locator bar.
|
|
16709
|
-
*
|
|
16710
|
-
* This function can't be called in restricted-execution mode.
|
|
16711
|
-
*
|
|
16712
|
-
* @param waypoint
|
|
16713
|
-
* The {@link Waypoint} to remove from the locator bar.
|
|
16714
|
-
* @throws This function can throw errors.
|
|
16715
|
-
*
|
|
16716
|
-
* {@link minecraftcommon.EngineError}
|
|
16717
|
-
*
|
|
16718
|
-
* {@link LocatorBarError}
|
|
16719
|
-
*/
|
|
16720
|
-
removeWaypoint(waypoint: Waypoint): void;
|
|
16721
|
-
}
|
|
16722
|
-
|
|
16723
15357
|
/**
|
|
16724
15358
|
* Loot item function that drops extra items if the provided
|
|
16725
15359
|
* tool has the looting enchant.
|
|
@@ -17099,47 +15733,20 @@ export class MatchToolCondition extends LootItemCondition {
|
|
|
17099
15733
|
}
|
|
17100
15734
|
|
|
17101
15735
|
/**
|
|
17102
|
-
*
|
|
17103
|
-
*
|
|
17104
|
-
* messages from client to server.
|
|
15736
|
+
* Contains a set of additional variable values for further
|
|
15737
|
+
* defining how rendering and animations function.
|
|
17105
15738
|
*/
|
|
17106
|
-
export class
|
|
17107
|
-
private constructor();
|
|
15739
|
+
export class MolangVariableMap {
|
|
17108
15740
|
/**
|
|
17109
15741
|
* @remarks
|
|
17110
|
-
*
|
|
15742
|
+
* Adds the following variables to Molang:
|
|
15743
|
+
* - `<variable_name>.r` - Red color value [0-1]
|
|
15744
|
+
* - `<variable_name>.g` - Green color value [0-1]
|
|
15745
|
+
* - `<variable_name>.b` - Blue color value [0-1]
|
|
17111
15746
|
*
|
|
15747
|
+
* @throws This function can throw errors.
|
|
17112
15748
|
*/
|
|
17113
|
-
|
|
17114
|
-
/**
|
|
17115
|
-
* @remarks
|
|
17116
|
-
* The message.
|
|
17117
|
-
*
|
|
17118
|
-
*/
|
|
17119
|
-
readonly message: string;
|
|
17120
|
-
/**
|
|
17121
|
-
* @remarks
|
|
17122
|
-
* The player who sent the message.
|
|
17123
|
-
*
|
|
17124
|
-
*/
|
|
17125
|
-
readonly player: Player;
|
|
17126
|
-
}
|
|
17127
|
-
|
|
17128
|
-
/**
|
|
17129
|
-
* Contains a set of additional variable values for further
|
|
17130
|
-
* defining how rendering and animations function.
|
|
17131
|
-
*/
|
|
17132
|
-
export class MolangVariableMap {
|
|
17133
|
-
/**
|
|
17134
|
-
* @remarks
|
|
17135
|
-
* Adds the following variables to Molang:
|
|
17136
|
-
* - `<variable_name>.r` - Red color value [0-1]
|
|
17137
|
-
* - `<variable_name>.g` - Green color value [0-1]
|
|
17138
|
-
* - `<variable_name>.b` - Blue color value [0-1]
|
|
17139
|
-
*
|
|
17140
|
-
* @throws This function can throw errors.
|
|
17141
|
-
*/
|
|
17142
|
-
setColorRGB(variableName: string, color: RGB): void;
|
|
15749
|
+
setColorRGB(variableName: string, color: RGB): void;
|
|
17143
15750
|
/**
|
|
17144
15751
|
* @remarks
|
|
17145
15752
|
* Adds the following variables to Molang:
|
|
@@ -17193,49 +15800,6 @@ export class MolangVariableMap {
|
|
|
17193
15800
|
setVector3(variableName: string, vector: Vector3): void;
|
|
17194
15801
|
}
|
|
17195
15802
|
|
|
17196
|
-
/**
|
|
17197
|
-
* @beta
|
|
17198
|
-
* Pack setting name and value that changed.
|
|
17199
|
-
*/
|
|
17200
|
-
export class PackSettingChangeAfterEvent {
|
|
17201
|
-
private constructor();
|
|
17202
|
-
/**
|
|
17203
|
-
* @remarks
|
|
17204
|
-
* The name of the setting.
|
|
17205
|
-
*
|
|
17206
|
-
*/
|
|
17207
|
-
readonly settingName: string;
|
|
17208
|
-
/**
|
|
17209
|
-
* @remarks
|
|
17210
|
-
* The value of the setting.
|
|
17211
|
-
*
|
|
17212
|
-
*/
|
|
17213
|
-
readonly settingValue: boolean | number | string;
|
|
17214
|
-
}
|
|
17215
|
-
|
|
17216
|
-
/**
|
|
17217
|
-
* @beta
|
|
17218
|
-
*/
|
|
17219
|
-
export class PackSettingChangeAfterEventSignal {
|
|
17220
|
-
private constructor();
|
|
17221
|
-
/**
|
|
17222
|
-
* @remarks
|
|
17223
|
-
* This function can't be called in restricted-execution mode.
|
|
17224
|
-
*
|
|
17225
|
-
* This function can be called in early-execution mode.
|
|
17226
|
-
*
|
|
17227
|
-
*/
|
|
17228
|
-
subscribe(callback: (arg0: PackSettingChangeAfterEvent) => void): (arg0: PackSettingChangeAfterEvent) => void;
|
|
17229
|
-
/**
|
|
17230
|
-
* @remarks
|
|
17231
|
-
* This function can't be called in restricted-execution mode.
|
|
17232
|
-
*
|
|
17233
|
-
* This function can be called in early-execution mode.
|
|
17234
|
-
*
|
|
17235
|
-
*/
|
|
17236
|
-
unsubscribe(callback: (arg0: PackSettingChangeAfterEvent) => void): void;
|
|
17237
|
-
}
|
|
17238
|
-
|
|
17239
15803
|
/**
|
|
17240
15804
|
* Loot item condition that checks whether the looting entity
|
|
17241
15805
|
* is currently a passenger of a specific type of entity.
|
|
@@ -17403,62 +15967,6 @@ export class Player extends Entity {
|
|
|
17403
15967
|
* @throws This property can throw when used.
|
|
17404
15968
|
*/
|
|
17405
15969
|
readonly camera: Camera;
|
|
17406
|
-
/**
|
|
17407
|
-
* @beta
|
|
17408
|
-
* @remarks
|
|
17409
|
-
* The player's chat display name, composed from {@link
|
|
17410
|
-
* Player.chatNamePrefix} + {@link Player.name} + {@link
|
|
17411
|
-
* Player.chatNameSuffix}. This is the name shown as the author
|
|
17412
|
-
* of chat messages sent by this player. To change the name
|
|
17413
|
-
* shown above the player's head, use {@link Entity.nameTag}.
|
|
17414
|
-
*
|
|
17415
|
-
* @throws This property can throw when used.
|
|
17416
|
-
*
|
|
17417
|
-
* {@link InvalidEntityError}
|
|
17418
|
-
*/
|
|
17419
|
-
readonly chatDisplayName: string;
|
|
17420
|
-
/**
|
|
17421
|
-
* @beta
|
|
17422
|
-
* @remarks
|
|
17423
|
-
* An optional string that, when set, is prepended to the text
|
|
17424
|
-
* of chat messages sent by this player. Useful for applying
|
|
17425
|
-
* formatting or color codes to a player's messages (e.g., '§a'
|
|
17426
|
-
* to make their messages green). Does not affect the player's
|
|
17427
|
-
* name display - use {@link Player.chatNamePrefix} for the
|
|
17428
|
-
* name shown in chat, or {@link Entity.nameTag} for the name
|
|
17429
|
-
* above the player's head. Set to undefined to clear.
|
|
17430
|
-
*
|
|
17431
|
-
* This property can't be edited in restricted-execution mode.
|
|
17432
|
-
*
|
|
17433
|
-
*/
|
|
17434
|
-
chatMessagePrefix?: string;
|
|
17435
|
-
/**
|
|
17436
|
-
* @beta
|
|
17437
|
-
* @remarks
|
|
17438
|
-
* An optional string that, when set, is prepended to the
|
|
17439
|
-
* player's name in chat messages. Does not affect the name tag
|
|
17440
|
-
* above the player's head or the player list - use {@link
|
|
17441
|
-
* Entity.nameTag} for that. To prefix the message text itself,
|
|
17442
|
-
* use {@link Player.chatMessagePrefix}. Set to undefined to
|
|
17443
|
-
* clear.
|
|
17444
|
-
*
|
|
17445
|
-
* This property can't be edited in restricted-execution mode.
|
|
17446
|
-
*
|
|
17447
|
-
*/
|
|
17448
|
-
chatNamePrefix?: string;
|
|
17449
|
-
/**
|
|
17450
|
-
* @beta
|
|
17451
|
-
* @remarks
|
|
17452
|
-
* An optional string that, when set, is appended to the
|
|
17453
|
-
* player's name in chat messages. Does not affect the name tag
|
|
17454
|
-
* above the player's head or the player list - use {@link
|
|
17455
|
-
* Entity.nameTag} for that. See also {@link
|
|
17456
|
-
* Player.chatNamePrefix}. Set to undefined to clear.
|
|
17457
|
-
*
|
|
17458
|
-
* This property can't be edited in restricted-execution mode.
|
|
17459
|
-
*
|
|
17460
|
-
*/
|
|
17461
|
-
chatNameSuffix?: string;
|
|
17462
15970
|
/**
|
|
17463
15971
|
* @remarks
|
|
17464
15972
|
* Contains the player's device information.
|
|
@@ -17533,14 +16041,6 @@ export class Player extends Entity {
|
|
|
17533
16041
|
* @throws This property can throw when used.
|
|
17534
16042
|
*/
|
|
17535
16043
|
readonly level: number;
|
|
17536
|
-
/**
|
|
17537
|
-
* @beta
|
|
17538
|
-
* @remarks
|
|
17539
|
-
* The player's Locator Bar. This property is used for managing
|
|
17540
|
-
* waypoints displayed on the HUD.
|
|
17541
|
-
*
|
|
17542
|
-
*/
|
|
17543
|
-
readonly locatorBar: LocatorBar;
|
|
17544
16044
|
/**
|
|
17545
16045
|
* @remarks
|
|
17546
16046
|
* Name of the player.
|
|
@@ -17556,17 +16056,6 @@ export class Player extends Entity {
|
|
|
17556
16056
|
* @throws This property can throw when used.
|
|
17557
16057
|
*/
|
|
17558
16058
|
readonly onScreenDisplay: ScreenDisplay;
|
|
17559
|
-
/**
|
|
17560
|
-
* @beta
|
|
17561
|
-
* @remarks
|
|
17562
|
-
* The party information for this player, or undefined if the
|
|
17563
|
-
* player is not in a party.
|
|
17564
|
-
*
|
|
17565
|
-
* @throws This property can throw when used.
|
|
17566
|
-
*
|
|
17567
|
-
* {@link InvalidEntityError}
|
|
17568
|
-
*/
|
|
17569
|
-
readonly partyInfo?: PartyInfo;
|
|
17570
16059
|
/**
|
|
17571
16060
|
* @throws This property can throw when used.
|
|
17572
16061
|
*
|
|
@@ -17640,20 +16129,6 @@ export class Player extends Entity {
|
|
|
17640
16129
|
* Throws if the Entity or Entity ID is invalid.
|
|
17641
16130
|
*/
|
|
17642
16131
|
clearPropertyOverridesForEntity(targetEntity: Entity | string): void;
|
|
17643
|
-
/**
|
|
17644
|
-
* @beta
|
|
17645
|
-
* @remarks
|
|
17646
|
-
* Eats an item, providing the item's hunger and saturation
|
|
17647
|
-
* effects to the player. Can only be used on food items.
|
|
17648
|
-
*
|
|
17649
|
-
* This function can't be called in restricted-execution mode.
|
|
17650
|
-
*
|
|
17651
|
-
* @param itemStack
|
|
17652
|
-
* The item to eat.
|
|
17653
|
-
* @throws
|
|
17654
|
-
* Throws if the item is not a food item.
|
|
17655
|
-
*/
|
|
17656
|
-
eatItem(itemStack: ItemStack): void;
|
|
17657
16132
|
/**
|
|
17658
16133
|
* @remarks
|
|
17659
16134
|
* The player's aim-assist settings.
|
|
@@ -17754,17 +16229,6 @@ export class Player extends Entity {
|
|
|
17754
16229
|
* ```
|
|
17755
16230
|
*/
|
|
17756
16231
|
playSound(soundId: string, soundOptions?: PlayerSoundOptions): void;
|
|
17757
|
-
/**
|
|
17758
|
-
* @beta
|
|
17759
|
-
* @remarks
|
|
17760
|
-
* This is an internal-facing method for posting a system
|
|
17761
|
-
* message to downstream clients.
|
|
17762
|
-
*
|
|
17763
|
-
* This function can't be called in restricted-execution mode.
|
|
17764
|
-
*
|
|
17765
|
-
* @throws This function can throw errors.
|
|
17766
|
-
*/
|
|
17767
|
-
postClientMessage(id: string, value: string): void;
|
|
17768
16232
|
/**
|
|
17769
16233
|
* @remarks
|
|
17770
16234
|
* Queues an additional music track that only this particular
|
|
@@ -18040,18 +16504,6 @@ export class Player extends Entity {
|
|
|
18040
16504
|
* @throws This function can throw errors.
|
|
18041
16505
|
*/
|
|
18042
16506
|
startItemCooldown(cooldownCategory: string, tickDuration: number): void;
|
|
18043
|
-
/**
|
|
18044
|
-
* @beta
|
|
18045
|
-
* @remarks
|
|
18046
|
-
* Stops all sounds from playing for this particular player.
|
|
18047
|
-
*
|
|
18048
|
-
* This function can't be called in restricted-execution mode.
|
|
18049
|
-
*
|
|
18050
|
-
* @throws This function can throw errors.
|
|
18051
|
-
*
|
|
18052
|
-
* {@link InvalidEntityError}
|
|
18053
|
-
*/
|
|
18054
|
-
stopAllSounds(): void;
|
|
18055
16507
|
/**
|
|
18056
16508
|
* @remarks
|
|
18057
16509
|
* Stops any music tracks from playing for this particular
|
|
@@ -18062,20 +16514,6 @@ export class Player extends Entity {
|
|
|
18062
16514
|
* @throws This function can throw errors.
|
|
18063
16515
|
*/
|
|
18064
16516
|
stopMusic(): void;
|
|
18065
|
-
/**
|
|
18066
|
-
* @beta
|
|
18067
|
-
* @remarks
|
|
18068
|
-
* Stops a sound from playing for this particular player.
|
|
18069
|
-
*
|
|
18070
|
-
* This function can't be called in restricted-execution mode.
|
|
18071
|
-
*
|
|
18072
|
-
* @param soundId
|
|
18073
|
-
* Identifier of the sound.
|
|
18074
|
-
* @throws This function can throw errors.
|
|
18075
|
-
*
|
|
18076
|
-
* {@link InvalidEntityError}
|
|
18077
|
-
*/
|
|
18078
|
-
stopSound(soundId: string): void;
|
|
18079
16517
|
}
|
|
18080
16518
|
|
|
18081
16519
|
/**
|
|
@@ -19360,88 +17798,6 @@ export class PlayerPlaceBlockAfterEventSignal {
|
|
|
19360
17798
|
unsubscribe(callback: (arg0: PlayerPlaceBlockAfterEvent) => void): void;
|
|
19361
17799
|
}
|
|
19362
17800
|
|
|
19363
|
-
/**
|
|
19364
|
-
* @beta
|
|
19365
|
-
* Contains information regarding an event before a player
|
|
19366
|
-
* places a block.
|
|
19367
|
-
*/
|
|
19368
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
19369
|
-
export class PlayerPlaceBlockBeforeEvent extends BlockEvent {
|
|
19370
|
-
private constructor();
|
|
19371
|
-
/**
|
|
19372
|
-
* @remarks
|
|
19373
|
-
* If set to true, cancels the block place event.
|
|
19374
|
-
*
|
|
19375
|
-
*/
|
|
19376
|
-
cancel: boolean;
|
|
19377
|
-
/**
|
|
19378
|
-
* @remarks
|
|
19379
|
-
* The face of the block that the new block is being placed on.
|
|
19380
|
-
*
|
|
19381
|
-
*/
|
|
19382
|
-
readonly face: Direction;
|
|
19383
|
-
/**
|
|
19384
|
-
* @remarks
|
|
19385
|
-
* Location relative to the bottom north-west corner of the
|
|
19386
|
-
* block where the new block is being placed onto.
|
|
19387
|
-
*
|
|
19388
|
-
*/
|
|
19389
|
-
readonly faceLocation: Vector3;
|
|
19390
|
-
/**
|
|
19391
|
-
* @remarks
|
|
19392
|
-
* The block permutation that will be placed if the event is
|
|
19393
|
-
* not cancelled.
|
|
19394
|
-
*
|
|
19395
|
-
*/
|
|
19396
|
-
readonly permutationToPlace: BlockPermutation;
|
|
19397
|
-
/**
|
|
19398
|
-
* @remarks
|
|
19399
|
-
* Player that is placing the block for this event.
|
|
19400
|
-
*
|
|
19401
|
-
*/
|
|
19402
|
-
readonly player: Player;
|
|
19403
|
-
}
|
|
19404
|
-
|
|
19405
|
-
/**
|
|
19406
|
-
* @beta
|
|
19407
|
-
* Manages callbacks that are connected to before a block is
|
|
19408
|
-
* placed by a player.
|
|
19409
|
-
*/
|
|
19410
|
-
export class PlayerPlaceBlockBeforeEventSignal {
|
|
19411
|
-
private constructor();
|
|
19412
|
-
/**
|
|
19413
|
-
* @remarks
|
|
19414
|
-
* Adds a callback that will be called before a block is placed
|
|
19415
|
-
* by a player.
|
|
19416
|
-
*
|
|
19417
|
-
* This function can't be called in restricted-execution mode.
|
|
19418
|
-
*
|
|
19419
|
-
* This function can be called in early-execution mode.
|
|
19420
|
-
*
|
|
19421
|
-
* @param callback
|
|
19422
|
-
* This closure is called with restricted-execution privilege.
|
|
19423
|
-
* @returns
|
|
19424
|
-
* Closure that is called with restricted-execution privilege.
|
|
19425
|
-
*/
|
|
19426
|
-
subscribe(
|
|
19427
|
-
callback: (arg0: PlayerPlaceBlockBeforeEvent) => void,
|
|
19428
|
-
options?: BlockEventOptions,
|
|
19429
|
-
): (arg0: PlayerPlaceBlockBeforeEvent) => void;
|
|
19430
|
-
/**
|
|
19431
|
-
* @remarks
|
|
19432
|
-
* Removes a callback from being called before an block is
|
|
19433
|
-
* placed by a player.
|
|
19434
|
-
*
|
|
19435
|
-
* This function can't be called in restricted-execution mode.
|
|
19436
|
-
*
|
|
19437
|
-
* This function can be called in early-execution mode.
|
|
19438
|
-
*
|
|
19439
|
-
* @param callback
|
|
19440
|
-
* This closure is called with restricted-execution privilege.
|
|
19441
|
-
*/
|
|
19442
|
-
unsubscribe(callback: (arg0: PlayerPlaceBlockBeforeEvent) => void): void;
|
|
19443
|
-
}
|
|
19444
|
-
|
|
19445
17801
|
/**
|
|
19446
17802
|
* An event that contains more information about a player
|
|
19447
17803
|
* spawning.
|
|
@@ -19560,114 +17916,6 @@ export class PlayerSwingStartAfterEventSignal {
|
|
|
19560
17916
|
unsubscribe(callback: (arg0: PlayerSwingStartAfterEvent) => void): void;
|
|
19561
17917
|
}
|
|
19562
17918
|
|
|
19563
|
-
/**
|
|
19564
|
-
* @beta
|
|
19565
|
-
* Contains information related to when a player successfully
|
|
19566
|
-
* names an Entity with a named Name Tag item.
|
|
19567
|
-
*/
|
|
19568
|
-
export class PlayerUseNameTagAfterEvent {
|
|
19569
|
-
private constructor();
|
|
19570
|
-
/**
|
|
19571
|
-
* @remarks
|
|
19572
|
-
* The entity that was named by the player.
|
|
19573
|
-
*
|
|
19574
|
-
* This property can't be edited in restricted-execution mode.
|
|
19575
|
-
*
|
|
19576
|
-
*/
|
|
19577
|
-
entityNamed: Entity;
|
|
19578
|
-
/**
|
|
19579
|
-
* @remarks
|
|
19580
|
-
* The new name that the player has given to the entity.
|
|
19581
|
-
*
|
|
19582
|
-
* This property can't be edited in restricted-execution mode.
|
|
19583
|
-
*
|
|
19584
|
-
*/
|
|
19585
|
-
newName: string;
|
|
19586
|
-
/**
|
|
19587
|
-
* @remarks
|
|
19588
|
-
* Handle to the player that used the name tag.
|
|
19589
|
-
*
|
|
19590
|
-
* This property can't be edited in restricted-execution mode.
|
|
19591
|
-
*
|
|
19592
|
-
*/
|
|
19593
|
-
player: Player;
|
|
19594
|
-
/**
|
|
19595
|
-
* @remarks
|
|
19596
|
-
* The previous name of the entity before the player used the
|
|
19597
|
-
* name tag. This will be undefined if the entity was not
|
|
19598
|
-
* previously named.
|
|
19599
|
-
*
|
|
19600
|
-
* This property can't be edited in restricted-execution mode.
|
|
19601
|
-
*
|
|
19602
|
-
*/
|
|
19603
|
-
previousName?: string;
|
|
19604
|
-
}
|
|
19605
|
-
|
|
19606
|
-
/**
|
|
19607
|
-
* @beta
|
|
19608
|
-
* Manages callbacks that are connected to when a player
|
|
19609
|
-
* successfully names an Entity with a named Name Tag item.
|
|
19610
|
-
*/
|
|
19611
|
-
export class PlayerUseNameTagAfterEventSignal {
|
|
19612
|
-
private constructor();
|
|
19613
|
-
/**
|
|
19614
|
-
* @remarks
|
|
19615
|
-
* Subscribes the specified callback to a player use name tag
|
|
19616
|
-
* after event.
|
|
19617
|
-
*
|
|
19618
|
-
* This function can't be called in restricted-execution mode.
|
|
19619
|
-
*
|
|
19620
|
-
* This function can be called in early-execution mode.
|
|
19621
|
-
*
|
|
19622
|
-
*/
|
|
19623
|
-
subscribe(callback: (arg0: PlayerUseNameTagAfterEvent) => void): (arg0: PlayerUseNameTagAfterEvent) => void;
|
|
19624
|
-
/**
|
|
19625
|
-
* @remarks
|
|
19626
|
-
* Removes the specified callback from a player use name tag
|
|
19627
|
-
* after event.
|
|
19628
|
-
*
|
|
19629
|
-
* This function can't be called in restricted-execution mode.
|
|
19630
|
-
*
|
|
19631
|
-
* This function can be called in early-execution mode.
|
|
19632
|
-
*
|
|
19633
|
-
*/
|
|
19634
|
-
unsubscribe(callback: (arg0: PlayerUseNameTagAfterEvent) => void): void;
|
|
19635
|
-
}
|
|
19636
|
-
|
|
19637
|
-
/**
|
|
19638
|
-
* @beta
|
|
19639
|
-
* Waypoint that tracks a player's position. Extends {@link
|
|
19640
|
-
* EntityWaypoint} with additional player-specific visibility
|
|
19641
|
-
* rules such as hidden state and spectator mode.
|
|
19642
|
-
*/
|
|
19643
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
19644
|
-
export class PlayerWaypoint extends EntityWaypoint {
|
|
19645
|
-
/**
|
|
19646
|
-
* @remarks
|
|
19647
|
-
* The {@link PlayerVisibilityRules} that control when the
|
|
19648
|
-
* waypoint is shown based on the player's state (e.g., hidden,
|
|
19649
|
-
* spectator mode, spectator viewing another spectator).
|
|
19650
|
-
*
|
|
19651
|
-
* @throws This property can throw when used.
|
|
19652
|
-
*
|
|
19653
|
-
* {@link InvalidWaypointError}
|
|
19654
|
-
*
|
|
19655
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
19656
|
-
*/
|
|
19657
|
-
readonly playerRules: PlayerVisibilityRules;
|
|
19658
|
-
/**
|
|
19659
|
-
* @throws This function can throw errors.
|
|
19660
|
-
*
|
|
19661
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
19662
|
-
*/
|
|
19663
|
-
constructor(
|
|
19664
|
-
player: Player,
|
|
19665
|
-
textureSelector: WaypointTextureSelector,
|
|
19666
|
-
playerRules: PlayerVisibilityRules,
|
|
19667
|
-
color?: RGB,
|
|
19668
|
-
);
|
|
19669
|
-
}
|
|
19670
|
-
|
|
19671
17919
|
/**
|
|
19672
17920
|
* Represents how the potion effect is delivered.
|
|
19673
17921
|
*/
|
|
@@ -19750,10 +17998,10 @@ export class Potions {
|
|
|
19750
17998
|
*
|
|
19751
17999
|
* {@link InvalidPotionEffectTypeError}
|
|
19752
18000
|
*/
|
|
19753
|
-
static resolve
|
|
19754
|
-
|
|
19755
|
-
|
|
19756
|
-
|
|
18001
|
+
static resolve(
|
|
18002
|
+
potionEffectType: PotionEffectType | string,
|
|
18003
|
+
potionDeliveryType: PotionDeliveryType | string,
|
|
18004
|
+
): ItemStack;
|
|
19757
18005
|
}
|
|
19758
18006
|
|
|
19759
18007
|
/**
|
|
@@ -19769,248 +18017,103 @@ export class PressurePlatePopAfterEvent extends BlockEvent {
|
|
|
19769
18017
|
* popped.
|
|
19770
18018
|
*
|
|
19771
18019
|
*/
|
|
19772
|
-
readonly previousRedstonePower: number;
|
|
19773
|
-
/**
|
|
19774
|
-
* @remarks
|
|
19775
|
-
* The redstone power of the pressure plate at the time of the
|
|
19776
|
-
* pop.
|
|
19777
|
-
*
|
|
19778
|
-
*/
|
|
19779
|
-
readonly redstonePower: number;
|
|
19780
|
-
}
|
|
19781
|
-
|
|
19782
|
-
/**
|
|
19783
|
-
* Manages callbacks that are connected to when a pressure
|
|
19784
|
-
* plate is popped.
|
|
19785
|
-
*/
|
|
19786
|
-
export class PressurePlatePopAfterEventSignal {
|
|
19787
|
-
private constructor();
|
|
19788
|
-
/**
|
|
19789
|
-
* @remarks
|
|
19790
|
-
* Adds a callback that will be called when a pressure plate is
|
|
19791
|
-
* popped.
|
|
19792
|
-
*
|
|
19793
|
-
* This function can't be called in restricted-execution mode.
|
|
19794
|
-
*
|
|
19795
|
-
* This function can be called in early-execution mode.
|
|
19796
|
-
*
|
|
19797
|
-
*/
|
|
19798
|
-
subscribe(callback: (arg0: PressurePlatePopAfterEvent) => void): (arg0: PressurePlatePopAfterEvent) => void;
|
|
19799
|
-
/**
|
|
19800
|
-
* @remarks
|
|
19801
|
-
* Removes a callback from being called when a pressure plate
|
|
19802
|
-
* is popped.
|
|
19803
|
-
*
|
|
19804
|
-
* This function can't be called in restricted-execution mode.
|
|
19805
|
-
*
|
|
19806
|
-
* This function can be called in early-execution mode.
|
|
19807
|
-
*
|
|
19808
|
-
*/
|
|
19809
|
-
unsubscribe(callback: (arg0: PressurePlatePopAfterEvent) => void): void;
|
|
19810
|
-
}
|
|
19811
|
-
|
|
19812
|
-
/**
|
|
19813
|
-
* Contains information related to changes to a pressure plate
|
|
19814
|
-
* push.
|
|
19815
|
-
*/
|
|
19816
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
19817
|
-
export class PressurePlatePushAfterEvent extends BlockEvent {
|
|
19818
|
-
private constructor();
|
|
19819
|
-
/**
|
|
19820
|
-
* @remarks
|
|
19821
|
-
* The redstone power of the pressure plate before it was
|
|
19822
|
-
* pushed.
|
|
19823
|
-
*
|
|
19824
|
-
*/
|
|
19825
|
-
readonly previousRedstonePower: number;
|
|
19826
|
-
/**
|
|
19827
|
-
* @remarks
|
|
19828
|
-
* The redstone power of the pressure plate at the time of the
|
|
19829
|
-
* push.
|
|
19830
|
-
*
|
|
19831
|
-
*/
|
|
19832
|
-
readonly redstonePower: number;
|
|
19833
|
-
/**
|
|
19834
|
-
* @remarks
|
|
19835
|
-
* Source that triggered the pressure plate push.
|
|
19836
|
-
*
|
|
19837
|
-
*/
|
|
19838
|
-
readonly source: Entity;
|
|
19839
|
-
}
|
|
19840
|
-
|
|
19841
|
-
/**
|
|
19842
|
-
* Manages callbacks that are connected to when a pressure
|
|
19843
|
-
* plate is pushed.
|
|
19844
|
-
*/
|
|
19845
|
-
export class PressurePlatePushAfterEventSignal {
|
|
19846
|
-
private constructor();
|
|
19847
|
-
/**
|
|
19848
|
-
* @remarks
|
|
19849
|
-
* Adds a callback that will be called when a pressure plate is
|
|
19850
|
-
* pushed.
|
|
19851
|
-
*
|
|
19852
|
-
* This function can't be called in restricted-execution mode.
|
|
19853
|
-
*
|
|
19854
|
-
* This function can be called in early-execution mode.
|
|
19855
|
-
*
|
|
19856
|
-
*/
|
|
19857
|
-
subscribe(callback: (arg0: PressurePlatePushAfterEvent) => void): (arg0: PressurePlatePushAfterEvent) => void;
|
|
19858
|
-
/**
|
|
19859
|
-
* @remarks
|
|
19860
|
-
* Removes a callback from being called when a pressure plate
|
|
19861
|
-
* is pushed.
|
|
19862
|
-
*
|
|
19863
|
-
* This function can't be called in restricted-execution mode.
|
|
19864
|
-
*
|
|
19865
|
-
* This function can be called in early-execution mode.
|
|
19866
|
-
*
|
|
19867
|
-
*/
|
|
19868
|
-
unsubscribe(callback: (arg0: PressurePlatePushAfterEvent) => void): void;
|
|
19869
|
-
}
|
|
19870
|
-
|
|
19871
|
-
/**
|
|
19872
|
-
* @beta
|
|
19873
|
-
* The base class for a text primitive. Represents an object in
|
|
19874
|
-
* the world and its base properties.
|
|
19875
|
-
*/
|
|
19876
|
-
export class PrimitiveShape {
|
|
19877
|
-
private constructor();
|
|
19878
|
-
/**
|
|
19879
|
-
* @remarks
|
|
19880
|
-
* The entity this shape is attached to. When set, this shape
|
|
19881
|
-
* will copy the root location of the attached entity and the
|
|
19882
|
-
* shape's position will be used as an offset.
|
|
19883
|
-
*
|
|
19884
|
-
*/
|
|
19885
|
-
attachedTo?: Entity;
|
|
19886
|
-
/**
|
|
19887
|
-
* @remarks
|
|
19888
|
-
* The color of the shape.
|
|
19889
|
-
*
|
|
19890
|
-
*/
|
|
19891
|
-
color: RGBA;
|
|
19892
|
-
/**
|
|
19893
|
-
* @remarks
|
|
19894
|
-
* The dimension the shape is visible within. If the dimension
|
|
19895
|
-
* is undefined, it will display in all dimensions.
|
|
19896
|
-
*
|
|
19897
|
-
*/
|
|
19898
|
-
readonly dimension: Dimension;
|
|
19899
|
-
/**
|
|
19900
|
-
* @remarks
|
|
19901
|
-
* Returns true if the shape has a limited time span before
|
|
19902
|
-
* being removed.
|
|
19903
|
-
*
|
|
19904
|
-
*/
|
|
19905
|
-
readonly hasDuration: boolean;
|
|
19906
|
-
/**
|
|
19907
|
-
* @remarks
|
|
19908
|
-
* The location of the shape.
|
|
19909
|
-
*
|
|
19910
|
-
*/
|
|
19911
|
-
readonly location: Vector3;
|
|
19912
|
-
/**
|
|
19913
|
-
* @remarks
|
|
19914
|
-
* If defined, this distance will be used to determine how far
|
|
19915
|
-
* away this primitive will be rendered for each client. By
|
|
19916
|
-
* default the distance will match the client's render distance
|
|
19917
|
-
* setting.
|
|
19918
|
-
*
|
|
19919
|
-
* Minimum Value: 0
|
|
19920
|
-
*/
|
|
19921
|
-
maximumRenderDistance?: number;
|
|
19922
|
-
/**
|
|
19923
|
-
* @remarks
|
|
19924
|
-
* The rotation of the shape (Euler angles - [Pitch, Yaw,
|
|
19925
|
-
* Roll]).
|
|
19926
|
-
*
|
|
19927
|
-
*/
|
|
19928
|
-
rotation: Vector3;
|
|
18020
|
+
readonly previousRedstonePower: number;
|
|
19929
18021
|
/**
|
|
19930
18022
|
* @remarks
|
|
19931
|
-
* The
|
|
18023
|
+
* The redstone power of the pressure plate at the time of the
|
|
18024
|
+
* pop.
|
|
19932
18025
|
*
|
|
19933
|
-
* Bounds: [-1000, 1000]
|
|
19934
18026
|
*/
|
|
19935
|
-
|
|
18027
|
+
readonly redstonePower: number;
|
|
18028
|
+
}
|
|
18029
|
+
|
|
18030
|
+
/**
|
|
18031
|
+
* Manages callbacks that are connected to when a pressure
|
|
18032
|
+
* plate is popped.
|
|
18033
|
+
*/
|
|
18034
|
+
export class PressurePlatePopAfterEventSignal {
|
|
18035
|
+
private constructor();
|
|
19936
18036
|
/**
|
|
19937
18037
|
* @remarks
|
|
19938
|
-
*
|
|
19939
|
-
*
|
|
19940
|
-
*
|
|
18038
|
+
* Adds a callback that will be called when a pressure plate is
|
|
18039
|
+
* popped.
|
|
18040
|
+
*
|
|
18041
|
+
* This function can't be called in restricted-execution mode.
|
|
18042
|
+
*
|
|
18043
|
+
* This function can be called in early-execution mode.
|
|
19941
18044
|
*
|
|
19942
18045
|
*/
|
|
19943
|
-
|
|
18046
|
+
subscribe(callback: (arg0: PressurePlatePopAfterEvent) => void): (arg0: PressurePlatePopAfterEvent) => void;
|
|
19944
18047
|
/**
|
|
19945
18048
|
* @remarks
|
|
19946
|
-
*
|
|
19947
|
-
*
|
|
19948
|
-
*
|
|
18049
|
+
* Removes a callback from being called when a pressure plate
|
|
18050
|
+
* is popped.
|
|
18051
|
+
*
|
|
18052
|
+
* This function can't be called in restricted-execution mode.
|
|
18053
|
+
*
|
|
18054
|
+
* This function can be called in early-execution mode.
|
|
19949
18055
|
*
|
|
19950
18056
|
*/
|
|
19951
|
-
|
|
18057
|
+
unsubscribe(callback: (arg0: PressurePlatePopAfterEvent) => void): void;
|
|
18058
|
+
}
|
|
18059
|
+
|
|
18060
|
+
/**
|
|
18061
|
+
* Contains information related to changes to a pressure plate
|
|
18062
|
+
* push.
|
|
18063
|
+
*/
|
|
18064
|
+
// @ts-ignore Class inheritance allowed for native defined classes
|
|
18065
|
+
export class PressurePlatePushAfterEvent extends BlockEvent {
|
|
18066
|
+
private constructor();
|
|
19952
18067
|
/**
|
|
19953
18068
|
* @remarks
|
|
19954
|
-
* The
|
|
19955
|
-
*
|
|
18069
|
+
* The redstone power of the pressure plate before it was
|
|
18070
|
+
* pushed.
|
|
19956
18071
|
*
|
|
19957
18072
|
*/
|
|
19958
|
-
|
|
18073
|
+
readonly previousRedstonePower: number;
|
|
19959
18074
|
/**
|
|
19960
18075
|
* @remarks
|
|
19961
|
-
*
|
|
19962
|
-
*
|
|
18076
|
+
* The redstone power of the pressure plate at the time of the
|
|
18077
|
+
* push.
|
|
19963
18078
|
*
|
|
19964
18079
|
*/
|
|
19965
|
-
|
|
18080
|
+
readonly redstonePower: number;
|
|
19966
18081
|
/**
|
|
19967
18082
|
* @remarks
|
|
19968
|
-
*
|
|
19969
|
-
* dimension is undefined, it will display in all dimensions.
|
|
18083
|
+
* Source that triggered the pressure plate push.
|
|
19970
18084
|
*
|
|
19971
18085
|
*/
|
|
19972
|
-
|
|
18086
|
+
readonly source: Entity;
|
|
19973
18087
|
}
|
|
19974
18088
|
|
|
19975
18089
|
/**
|
|
19976
|
-
*
|
|
19977
|
-
*
|
|
19978
|
-
* text primitives to the world.
|
|
18090
|
+
* Manages callbacks that are connected to when a pressure
|
|
18091
|
+
* plate is pushed.
|
|
19979
18092
|
*/
|
|
19980
|
-
export class
|
|
18093
|
+
export class PressurePlatePushAfterEventSignal {
|
|
19981
18094
|
private constructor();
|
|
19982
18095
|
/**
|
|
19983
18096
|
* @remarks
|
|
19984
|
-
*
|
|
19985
|
-
*
|
|
19986
|
-
*/
|
|
19987
|
-
readonly maxShapes: number;
|
|
19988
|
-
/**
|
|
19989
|
-
* @remarks
|
|
19990
|
-
* Adds a new text primitive to the world.
|
|
18097
|
+
* Adds a callback that will be called when a pressure plate is
|
|
18098
|
+
* pushed.
|
|
19991
18099
|
*
|
|
19992
|
-
*
|
|
19993
|
-
* The text primitive to be added.
|
|
19994
|
-
* @throws This function can throw errors.
|
|
18100
|
+
* This function can't be called in restricted-execution mode.
|
|
19995
18101
|
*
|
|
19996
|
-
*
|
|
18102
|
+
* This function can be called in early-execution mode.
|
|
19997
18103
|
*
|
|
19998
|
-
* {@link PrimitiveShapeError}
|
|
19999
18104
|
*/
|
|
20000
|
-
|
|
18105
|
+
subscribe(callback: (arg0: PressurePlatePushAfterEvent) => void): (arg0: PressurePlatePushAfterEvent) => void;
|
|
20001
18106
|
/**
|
|
20002
18107
|
* @remarks
|
|
20003
|
-
* Removes
|
|
18108
|
+
* Removes a callback from being called when a pressure plate
|
|
18109
|
+
* is pushed.
|
|
20004
18110
|
*
|
|
20005
|
-
|
|
20006
|
-
|
|
20007
|
-
|
|
20008
|
-
* @remarks
|
|
20009
|
-
* Removes an instance of a text primitive from the world. This
|
|
20010
|
-
* is equivalent to calling remove on the text itself.
|
|
18111
|
+
* This function can't be called in restricted-execution mode.
|
|
18112
|
+
*
|
|
18113
|
+
* This function can be called in early-execution mode.
|
|
20011
18114
|
*
|
|
20012
18115
|
*/
|
|
20013
|
-
|
|
18116
|
+
unsubscribe(callback: (arg0: PressurePlatePushAfterEvent) => void): void;
|
|
20014
18117
|
}
|
|
20015
18118
|
|
|
20016
18119
|
/**
|
|
@@ -20962,38 +19065,6 @@ export class Seat {
|
|
|
20962
19065
|
readonly seatRotation: number;
|
|
20963
19066
|
}
|
|
20964
19067
|
|
|
20965
|
-
/**
|
|
20966
|
-
* @beta
|
|
20967
|
-
* Manages callbacks that are message passing to a server. This
|
|
20968
|
-
* event is not currently fully implemented, and should not be
|
|
20969
|
-
* used.
|
|
20970
|
-
*/
|
|
20971
|
-
export class ServerMessageAfterEventSignal {
|
|
20972
|
-
private constructor();
|
|
20973
|
-
/**
|
|
20974
|
-
* @remarks
|
|
20975
|
-
* Adds a callback that will be called when an internal message
|
|
20976
|
-
* is passed.
|
|
20977
|
-
*
|
|
20978
|
-
* This function can't be called in restricted-execution mode.
|
|
20979
|
-
*
|
|
20980
|
-
* This function can be called in early-execution mode.
|
|
20981
|
-
*
|
|
20982
|
-
*/
|
|
20983
|
-
subscribe(callback: (arg0: MessageReceiveAfterEvent) => void): (arg0: MessageReceiveAfterEvent) => void;
|
|
20984
|
-
/**
|
|
20985
|
-
* @remarks
|
|
20986
|
-
* Removes a callback from being called when an internal
|
|
20987
|
-
* message is passed.
|
|
20988
|
-
*
|
|
20989
|
-
* This function can't be called in restricted-execution mode.
|
|
20990
|
-
*
|
|
20991
|
-
* This function can be called in early-execution mode.
|
|
20992
|
-
*
|
|
20993
|
-
*/
|
|
20994
|
-
unsubscribe(callback: (arg0: MessageReceiveAfterEvent) => void): void;
|
|
20995
|
-
}
|
|
20996
|
-
|
|
20997
19068
|
/**
|
|
20998
19069
|
* Loot item function that modifies the trim on a dropped armor
|
|
20999
19070
|
* item.
|
|
@@ -21022,21 +19093,6 @@ export class SetArmorTrimFunction extends LootItemFunction {
|
|
|
21022
19093
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
21023
19094
|
export class SetBannerDetailsFunction extends LootItemFunction {
|
|
21024
19095
|
private constructor();
|
|
21025
|
-
/**
|
|
21026
|
-
* @beta
|
|
21027
|
-
* @remarks
|
|
21028
|
-
* The base color for the dropped banner.
|
|
21029
|
-
*
|
|
21030
|
-
*/
|
|
21031
|
-
readonly baseColor: string;
|
|
21032
|
-
/**
|
|
21033
|
-
* @beta
|
|
21034
|
-
* @remarks
|
|
21035
|
-
* An array of {@link BannerPattern} objects used to decorate
|
|
21036
|
-
* the banner, including color and pattern type.
|
|
21037
|
-
*
|
|
21038
|
-
*/
|
|
21039
|
-
readonly patterns: BannerPattern[];
|
|
21040
19096
|
/**
|
|
21041
19097
|
* @remarks
|
|
21042
19098
|
* The type of banner to drop.
|
|
@@ -21331,13 +19387,6 @@ export class StartupEvent {
|
|
|
21331
19387
|
*
|
|
21332
19388
|
*/
|
|
21333
19389
|
readonly customCommandRegistry: CustomCommandRegistry;
|
|
21334
|
-
/**
|
|
21335
|
-
* @beta
|
|
21336
|
-
* @remarks
|
|
21337
|
-
* This property can be read in early-execution mode.
|
|
21338
|
-
*
|
|
21339
|
-
*/
|
|
21340
|
-
readonly dimensionRegistry: DimensionRegistry;
|
|
21341
19390
|
/**
|
|
21342
19391
|
* @remarks
|
|
21343
19392
|
* This property can be read in early-execution mode.
|
|
@@ -21587,7 +19636,7 @@ export class StructureManager {
|
|
|
21587
19636
|
*/
|
|
21588
19637
|
get(identifier: string): Structure | undefined;
|
|
21589
19638
|
/**
|
|
21590
|
-
* @
|
|
19639
|
+
* @rc
|
|
21591
19640
|
* @remarks
|
|
21592
19641
|
* Returns a list of all structures contained in behavior
|
|
21593
19642
|
* packs. Does not include structures saved to the world or in
|
|
@@ -21995,19 +20044,6 @@ export class SystemBeforeEvents {
|
|
|
21995
20044
|
*
|
|
21996
20045
|
*/
|
|
21997
20046
|
readonly startup: StartupBeforeEventSignal;
|
|
21998
|
-
/**
|
|
21999
|
-
* @beta
|
|
22000
|
-
* @remarks
|
|
22001
|
-
* Fires when the scripting watchdog shuts down the server. The
|
|
22002
|
-
* can be due to using too much memory, or by causing
|
|
22003
|
-
* significant slowdown or hang.
|
|
22004
|
-
* To prevent shutdown, set the event's cancel property to
|
|
22005
|
-
* true.
|
|
22006
|
-
*
|
|
22007
|
-
* This property can be read in early-execution mode.
|
|
22008
|
-
*
|
|
22009
|
-
*/
|
|
22010
|
-
readonly watchdogTerminate: WatchdogTerminateBeforeEventSignal;
|
|
22011
20047
|
}
|
|
22012
20048
|
|
|
22013
20049
|
/**
|
|
@@ -22086,73 +20122,6 @@ export class TargetBlockHitAfterEventSignal {
|
|
|
22086
20122
|
unsubscribe(callback: (arg0: TargetBlockHitAfterEvent) => void): void;
|
|
22087
20123
|
}
|
|
22088
20124
|
|
|
22089
|
-
/**
|
|
22090
|
-
* @beta
|
|
22091
|
-
* A primitive shape class that represents a text label in the
|
|
22092
|
-
* world with a background.
|
|
22093
|
-
*/
|
|
22094
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
22095
|
-
export class TextPrimitive extends PrimitiveShape {
|
|
22096
|
-
/**
|
|
22097
|
-
* @remarks
|
|
22098
|
-
* If set to true, the text primitive will render the back-face
|
|
22099
|
-
* of the background. Defaults to true but will always be false
|
|
22100
|
-
* if 'useRotation' is set to false.
|
|
22101
|
-
*
|
|
22102
|
-
*/
|
|
22103
|
-
backfaceVisible: boolean;
|
|
22104
|
-
/**
|
|
22105
|
-
* @remarks
|
|
22106
|
-
* The color of the background plate of the text. If set to
|
|
22107
|
-
* undefined, it will use the default color.
|
|
22108
|
-
*
|
|
22109
|
-
*/
|
|
22110
|
-
backgroundColorOverride?: RGBA;
|
|
22111
|
-
/**
|
|
22112
|
-
* @remarks
|
|
22113
|
-
* If set to true, the text will be hidden behind blocks or
|
|
22114
|
-
* entities. By default this is set to false (will always
|
|
22115
|
-
* render).
|
|
22116
|
-
*
|
|
22117
|
-
*/
|
|
22118
|
-
depthTest: boolean;
|
|
22119
|
-
/**
|
|
22120
|
-
* @remarks
|
|
22121
|
-
* Get the text of the debug text shape. Returns the RawText of
|
|
22122
|
-
* the debug text if `setText` was called with a RawMessage or
|
|
22123
|
-
* a RawText object, otherwise returns a string.
|
|
22124
|
-
*
|
|
22125
|
-
*/
|
|
22126
|
-
readonly text: RawMessage | string;
|
|
22127
|
-
/**
|
|
22128
|
-
* @remarks
|
|
22129
|
-
* If set to true, the text primitive will render the back-face
|
|
22130
|
-
* of the text. Defaults to true but will always be false if
|
|
22131
|
-
* 'useRotation' is set to false.
|
|
22132
|
-
*
|
|
22133
|
-
*/
|
|
22134
|
-
textBackfaceVisible: boolean;
|
|
22135
|
-
/**
|
|
22136
|
-
* @remarks
|
|
22137
|
-
* If set to true, the text will not face the camera and
|
|
22138
|
-
* instead will use the rotation from the shape.
|
|
22139
|
-
*
|
|
22140
|
-
*/
|
|
22141
|
-
useRotation: boolean;
|
|
22142
|
-
constructor(location: DimensionLocation | Vector3, text: RawMessage | string);
|
|
22143
|
-
/**
|
|
22144
|
-
* @remarks
|
|
22145
|
-
* Sets the text to display.
|
|
22146
|
-
*
|
|
22147
|
-
* @throws This function can throw errors.
|
|
22148
|
-
*
|
|
22149
|
-
* {@link minecraftcommon.ArgumentOutOfBoundsError}
|
|
22150
|
-
*
|
|
22151
|
-
* {@link RawMessageError}
|
|
22152
|
-
*/
|
|
22153
|
-
setText(text: RawMessage | string): void;
|
|
22154
|
-
}
|
|
22155
|
-
|
|
22156
20125
|
/**
|
|
22157
20126
|
* This manager is used to add, remove or query temporary
|
|
22158
20127
|
* ticking areas to a dimension. These ticking areas are
|
|
@@ -22394,151 +20363,6 @@ export class TripWireTripAfterEventSignal {
|
|
|
22394
20363
|
unsubscribe(callback: (arg0: TripWireTripAfterEvent) => void): void;
|
|
22395
20364
|
}
|
|
22396
20365
|
|
|
22397
|
-
/**
|
|
22398
|
-
* @beta
|
|
22399
|
-
* Contains information related to a script watchdog
|
|
22400
|
-
* termination.
|
|
22401
|
-
*/
|
|
22402
|
-
export class WatchdogTerminateBeforeEvent {
|
|
22403
|
-
private constructor();
|
|
22404
|
-
/**
|
|
22405
|
-
* @remarks
|
|
22406
|
-
* If set to true, cancels the termination of the script
|
|
22407
|
-
* runtime. Note that depending on server configuration
|
|
22408
|
-
* settings, cancellation of the termination may not be
|
|
22409
|
-
* allowed.
|
|
22410
|
-
*
|
|
22411
|
-
*/
|
|
22412
|
-
cancel: boolean;
|
|
22413
|
-
/**
|
|
22414
|
-
* @remarks
|
|
22415
|
-
* Contains the reason why a script runtime is to be
|
|
22416
|
-
* terminated.
|
|
22417
|
-
*
|
|
22418
|
-
*/
|
|
22419
|
-
readonly terminateReason: WatchdogTerminateReason;
|
|
22420
|
-
}
|
|
22421
|
-
|
|
22422
|
-
/**
|
|
22423
|
-
* @beta
|
|
22424
|
-
* Manages callbacks that are connected to a callback that will
|
|
22425
|
-
* be called when a script runtime is being terminated due to a
|
|
22426
|
-
* violation of the performance watchdog system.
|
|
22427
|
-
*/
|
|
22428
|
-
export class WatchdogTerminateBeforeEventSignal {
|
|
22429
|
-
private constructor();
|
|
22430
|
-
/**
|
|
22431
|
-
* @remarks
|
|
22432
|
-
* Adds a callback that will be called when a script runtime is
|
|
22433
|
-
* being terminated due to a violation of the performance
|
|
22434
|
-
* watchdog system.
|
|
22435
|
-
*
|
|
22436
|
-
* This function can't be called in restricted-execution mode.
|
|
22437
|
-
*
|
|
22438
|
-
* This function can be called in early-execution mode.
|
|
22439
|
-
*
|
|
22440
|
-
* @param callback
|
|
22441
|
-
* This closure is called with restricted-execution privilege.
|
|
22442
|
-
* @returns
|
|
22443
|
-
* Closure that is called with restricted-execution privilege.
|
|
22444
|
-
*/
|
|
22445
|
-
subscribe(callback: (arg0: WatchdogTerminateBeforeEvent) => void): (arg0: WatchdogTerminateBeforeEvent) => void;
|
|
22446
|
-
/**
|
|
22447
|
-
* @remarks
|
|
22448
|
-
* Removes a callback from being called when a script runtime
|
|
22449
|
-
* is being terminated due to a violation of the performance
|
|
22450
|
-
* watchdog system.
|
|
22451
|
-
*
|
|
22452
|
-
* This function can't be called in restricted-execution mode.
|
|
22453
|
-
*
|
|
22454
|
-
* This function can be called in early-execution mode.
|
|
22455
|
-
*
|
|
22456
|
-
* @param callback
|
|
22457
|
-
* This closure is called with restricted-execution privilege.
|
|
22458
|
-
*/
|
|
22459
|
-
unsubscribe(callback: (arg0: WatchdogTerminateBeforeEvent) => void): void;
|
|
22460
|
-
}
|
|
22461
|
-
|
|
22462
|
-
/**
|
|
22463
|
-
* @beta
|
|
22464
|
-
* Base class for waypoints displayed on the player's locator
|
|
22465
|
-
* bar. Waypoints can track locations or entities and are
|
|
22466
|
-
* rendered with customizable textures and colors.
|
|
22467
|
-
*
|
|
22468
|
-
* Waypoints act as shared handles that can be added to
|
|
22469
|
-
* multiple players' locator bars. When you modify a waypoint's
|
|
22470
|
-
* properties (such as color, texture, or enabled state), the
|
|
22471
|
-
* changes are reflected for all players who have that waypoint
|
|
22472
|
-
* in their locator bar. This allows you to efficiently manage
|
|
22473
|
-
* waypoints across multiple players without creating separate
|
|
22474
|
-
* instances for each player.
|
|
22475
|
-
*/
|
|
22476
|
-
export class Waypoint {
|
|
22477
|
-
private constructor();
|
|
22478
|
-
/**
|
|
22479
|
-
* @remarks
|
|
22480
|
-
* Optional {@link RGB} color tint applied to the waypoint
|
|
22481
|
-
* icon. If not specified, the waypoint uses its default color.
|
|
22482
|
-
*
|
|
22483
|
-
* This property can't be edited in restricted-execution mode.
|
|
22484
|
-
*
|
|
22485
|
-
*/
|
|
22486
|
-
color?: RGB;
|
|
22487
|
-
/**
|
|
22488
|
-
* @remarks
|
|
22489
|
-
* Controls whether the waypoint is currently displayed on the
|
|
22490
|
-
* player's screen. When disabled, the waypoint is hidden but
|
|
22491
|
-
* remains valid.
|
|
22492
|
-
*
|
|
22493
|
-
* This property can't be edited in restricted-execution mode.
|
|
22494
|
-
*
|
|
22495
|
-
*/
|
|
22496
|
-
isEnabled: boolean;
|
|
22497
|
-
/**
|
|
22498
|
-
* @remarks
|
|
22499
|
-
* Returns whether the waypoint is currently valid. A waypoint
|
|
22500
|
-
* becomes invalid when its tracked entity is no longer valid.
|
|
22501
|
-
*
|
|
22502
|
-
*/
|
|
22503
|
-
readonly isValid: boolean;
|
|
22504
|
-
/**
|
|
22505
|
-
* @remarks
|
|
22506
|
-
* The {@link WaypointTextureSelector} that determines which
|
|
22507
|
-
* icon texture is displayed for the waypoint based on distance
|
|
22508
|
-
* or other criteria.
|
|
22509
|
-
*
|
|
22510
|
-
* This property can't be edited in restricted-execution mode.
|
|
22511
|
-
*
|
|
22512
|
-
*/
|
|
22513
|
-
textureSelector: WaypointTextureSelector;
|
|
22514
|
-
/**
|
|
22515
|
-
* @remarks
|
|
22516
|
-
* Gets the current {@link DimensionLocation} of the waypoint.
|
|
22517
|
-
* For entity waypoints, this returns the entity's current
|
|
22518
|
-
* position. For location waypoints, this returns the stored
|
|
22519
|
-
* location.
|
|
22520
|
-
*
|
|
22521
|
-
* This function can't be called in restricted-execution mode.
|
|
22522
|
-
*
|
|
22523
|
-
* @throws This function can throw errors.
|
|
22524
|
-
*
|
|
22525
|
-
* {@link InvalidWaypointError}
|
|
22526
|
-
*
|
|
22527
|
-
* {@link InvalidWaypointTextureSelectorError}
|
|
22528
|
-
*/
|
|
22529
|
-
getDimensionLocation(): DimensionLocation;
|
|
22530
|
-
/**
|
|
22531
|
-
* @remarks
|
|
22532
|
-
* Removes the waypoint from all locator bars it has been added
|
|
22533
|
-
* to. This affects all players who have this waypoint in their
|
|
22534
|
-
* locator bar.
|
|
22535
|
-
*
|
|
22536
|
-
* This function can't be called in restricted-execution mode.
|
|
22537
|
-
*
|
|
22538
|
-
*/
|
|
22539
|
-
remove(): void;
|
|
22540
|
-
}
|
|
22541
|
-
|
|
22542
20366
|
/**
|
|
22543
20367
|
* Contains information related to changes in weather in the
|
|
22544
20368
|
* environment.
|
|
@@ -22675,15 +20499,6 @@ export class World {
|
|
|
22675
20499
|
*
|
|
22676
20500
|
*/
|
|
22677
20501
|
readonly afterEvents: WorldAfterEvents;
|
|
22678
|
-
/**
|
|
22679
|
-
* @beta
|
|
22680
|
-
* @remarks
|
|
22681
|
-
* Enables or disables cheats.
|
|
22682
|
-
*
|
|
22683
|
-
* This property can't be edited in restricted-execution mode.
|
|
22684
|
-
*
|
|
22685
|
-
*/
|
|
22686
|
-
allowCheats: boolean;
|
|
22687
20502
|
/**
|
|
22688
20503
|
* @remarks
|
|
22689
20504
|
* Contains a set of events that are applicable to the entirety
|
|
@@ -22728,14 +20543,6 @@ export class World {
|
|
|
22728
20543
|
*/
|
|
22729
20544
|
readonly gameRules: GameRules;
|
|
22730
20545
|
readonly isHardcore: boolean;
|
|
22731
|
-
/**
|
|
22732
|
-
* @beta
|
|
22733
|
-
* @remarks
|
|
22734
|
-
* Manager for adding and removing primitive text objects in
|
|
22735
|
-
* the world.
|
|
22736
|
-
*
|
|
22737
|
-
*/
|
|
22738
|
-
readonly primitiveShapesManager: PrimitiveShapesManager;
|
|
22739
20546
|
/**
|
|
22740
20547
|
* @remarks
|
|
22741
20548
|
* Returns the general global scoreboard that applies to the
|
|
@@ -22761,21 +20568,7 @@ export class World {
|
|
|
22761
20568
|
* ticking areas.
|
|
22762
20569
|
*
|
|
22763
20570
|
*/
|
|
22764
|
-
readonly tickingAreaManager: TickingAreaManager;
|
|
22765
|
-
/**
|
|
22766
|
-
* @beta
|
|
22767
|
-
* @remarks
|
|
22768
|
-
* A method that is internal-only, used for broadcasting
|
|
22769
|
-
* specific messages between client and server.
|
|
22770
|
-
*
|
|
22771
|
-
* This function can't be called in restricted-execution mode.
|
|
22772
|
-
*
|
|
22773
|
-
* @param id
|
|
22774
|
-
* The message identifier.
|
|
22775
|
-
* @param value
|
|
22776
|
-
* The message.
|
|
22777
|
-
*/
|
|
22778
|
-
broadcastClientMessage(id: string, value: string): void;
|
|
20571
|
+
readonly tickingAreaManager: TickingAreaManager;
|
|
22779
20572
|
/**
|
|
22780
20573
|
* @remarks
|
|
22781
20574
|
* Clears the set of dynamic properties declared for this
|
|
@@ -22969,15 +20762,6 @@ export class World {
|
|
|
22969
20762
|
*
|
|
22970
20763
|
*/
|
|
22971
20764
|
getMoonPhase(): MoonPhase;
|
|
22972
|
-
/**
|
|
22973
|
-
* @beta
|
|
22974
|
-
* @remarks
|
|
22975
|
-
* Returns a map of pack setting name and value pairs.
|
|
22976
|
-
*
|
|
22977
|
-
* This function can be called in early-execution mode.
|
|
22978
|
-
*
|
|
22979
|
-
*/
|
|
22980
|
-
getPackSettings(): Record<string, boolean | number | string>;
|
|
22981
20765
|
/**
|
|
22982
20766
|
* @remarks
|
|
22983
20767
|
* Returns a set of players based on a set of conditions
|
|
@@ -23233,7 +21017,7 @@ export class World {
|
|
|
23233
21017
|
export class WorldAfterEvents {
|
|
23234
21018
|
private constructor();
|
|
23235
21019
|
/**
|
|
23236
|
-
* @
|
|
21020
|
+
* @rc
|
|
23237
21021
|
* @remarks
|
|
23238
21022
|
* This event fires when a block container is closed.
|
|
23239
21023
|
*
|
|
@@ -23242,7 +21026,7 @@ export class WorldAfterEvents {
|
|
|
23242
21026
|
*/
|
|
23243
21027
|
readonly blockContainerClosed: BlockContainerClosedAfterEventSignal;
|
|
23244
21028
|
/**
|
|
23245
|
-
* @
|
|
21029
|
+
* @rc
|
|
23246
21030
|
* @remarks
|
|
23247
21031
|
* This event fires when a block container is opened.
|
|
23248
21032
|
*
|
|
@@ -23268,16 +21052,6 @@ export class WorldAfterEvents {
|
|
|
23268
21052
|
*
|
|
23269
21053
|
*/
|
|
23270
21054
|
readonly buttonPush: ButtonPushAfterEventSignal;
|
|
23271
|
-
/**
|
|
23272
|
-
* @beta
|
|
23273
|
-
* @remarks
|
|
23274
|
-
* This event is triggered after a chat message has been
|
|
23275
|
-
* broadcast or sent to players.
|
|
23276
|
-
*
|
|
23277
|
-
* This property can be read in early-execution mode.
|
|
23278
|
-
*
|
|
23279
|
-
*/
|
|
23280
|
-
readonly chatSend: ChatSendAfterEventSignal;
|
|
23281
21055
|
/**
|
|
23282
21056
|
* @remarks
|
|
23283
21057
|
* This event is fired when an entity event has been triggered
|
|
@@ -23298,7 +21072,7 @@ export class WorldAfterEvents {
|
|
|
23298
21072
|
*/
|
|
23299
21073
|
readonly effectAdd: EffectAddAfterEventSignal;
|
|
23300
21074
|
/**
|
|
23301
|
-
* @
|
|
21075
|
+
* @rc
|
|
23302
21076
|
* @remarks
|
|
23303
21077
|
* This event fires when an entity container is closed.
|
|
23304
21078
|
*
|
|
@@ -23307,7 +21081,7 @@ export class WorldAfterEvents {
|
|
|
23307
21081
|
*/
|
|
23308
21082
|
readonly entityContainerClosed: EntityContainerClosedAfterEventSignal;
|
|
23309
21083
|
/**
|
|
23310
|
-
* @
|
|
21084
|
+
* @rc
|
|
23311
21085
|
* @remarks
|
|
23312
21086
|
* This event fires when an entity container is opened.
|
|
23313
21087
|
*
|
|
@@ -23493,25 +21267,6 @@ export class WorldAfterEvents {
|
|
|
23493
21267
|
*
|
|
23494
21268
|
*/
|
|
23495
21269
|
readonly leverAction: LeverActionAfterEventSignal;
|
|
23496
|
-
/**
|
|
23497
|
-
* @beta
|
|
23498
|
-
* @remarks
|
|
23499
|
-
* This event is an internal implementation detail, and is
|
|
23500
|
-
* otherwise not currently functional.
|
|
23501
|
-
*
|
|
23502
|
-
* This property can be read in early-execution mode.
|
|
23503
|
-
*
|
|
23504
|
-
*/
|
|
23505
|
-
readonly messageReceive: ServerMessageAfterEventSignal;
|
|
23506
|
-
/**
|
|
23507
|
-
* @beta
|
|
23508
|
-
* @remarks
|
|
23509
|
-
* This event is triggered when a pack setting is changed.
|
|
23510
|
-
*
|
|
23511
|
-
* This property can be read in early-execution mode.
|
|
23512
|
-
*
|
|
23513
|
-
*/
|
|
23514
|
-
readonly packSettingChange: PackSettingChangeAfterEventSignal;
|
|
23515
21270
|
/**
|
|
23516
21271
|
* @remarks
|
|
23517
21272
|
* This event fires when a piston expands or retracts.
|
|
@@ -23648,16 +21403,6 @@ export class WorldAfterEvents {
|
|
|
23648
21403
|
*
|
|
23649
21404
|
*/
|
|
23650
21405
|
readonly playerSwingStart: PlayerSwingStartAfterEventSignal;
|
|
23651
|
-
/**
|
|
23652
|
-
* @beta
|
|
23653
|
-
* @remarks
|
|
23654
|
-
* An event for when a player uses a named name tag on an
|
|
23655
|
-
* entity.
|
|
23656
|
-
*
|
|
23657
|
-
* This property can be read in early-execution mode.
|
|
23658
|
-
*
|
|
23659
|
-
*/
|
|
23660
|
-
readonly playerUseNameTag: PlayerUseNameTagAfterEventSignal;
|
|
23661
21406
|
/**
|
|
23662
21407
|
* @remarks
|
|
23663
21408
|
* A pressure plate has popped back up (i.e., there are no
|
|
@@ -23734,43 +21479,6 @@ export class WorldAfterEvents {
|
|
|
23734
21479
|
*/
|
|
23735
21480
|
export class WorldBeforeEvents {
|
|
23736
21481
|
private constructor();
|
|
23737
|
-
/**
|
|
23738
|
-
* @beta
|
|
23739
|
-
* @remarks
|
|
23740
|
-
* This event is triggered after a chat message has been
|
|
23741
|
-
* broadcast or sent to players.
|
|
23742
|
-
*
|
|
23743
|
-
* This property can be read in early-execution mode.
|
|
23744
|
-
*
|
|
23745
|
-
* @example customCommand.ts
|
|
23746
|
-
* ```typescript
|
|
23747
|
-
* import { world, DimensionLocation } from '@minecraft/server';
|
|
23748
|
-
*
|
|
23749
|
-
* function customCommand(targetLocation: DimensionLocation) {
|
|
23750
|
-
* const chatCallback = world.beforeEvents.chatSend.subscribe(eventData => {
|
|
23751
|
-
* if (eventData.message.includes('cancel')) {
|
|
23752
|
-
* // Cancel event if the message contains "cancel"
|
|
23753
|
-
* eventData.cancel = true;
|
|
23754
|
-
* } else {
|
|
23755
|
-
* const args = eventData.message.split(' ');
|
|
23756
|
-
*
|
|
23757
|
-
* if (args.length > 0) {
|
|
23758
|
-
* switch (args[0].toLowerCase()) {
|
|
23759
|
-
* case 'echo':
|
|
23760
|
-
* // Send a modified version of chat message
|
|
23761
|
-
* world.sendMessage(`Echo '${eventData.message.substring(4).trim()}'`);
|
|
23762
|
-
* break;
|
|
23763
|
-
* case 'help':
|
|
23764
|
-
* world.sendMessage(`Available commands: echo <message>`);
|
|
23765
|
-
* break;
|
|
23766
|
-
* }
|
|
23767
|
-
* }
|
|
23768
|
-
* }
|
|
23769
|
-
* });
|
|
23770
|
-
* }
|
|
23771
|
-
* ```
|
|
23772
|
-
*/
|
|
23773
|
-
readonly chatSend: ChatSendBeforeEventSignal;
|
|
23774
21482
|
/**
|
|
23775
21483
|
* @remarks
|
|
23776
21484
|
* This event is triggered after an event has been added to an
|
|
@@ -23864,15 +21572,6 @@ export class WorldBeforeEvents {
|
|
|
23864
21572
|
*
|
|
23865
21573
|
*/
|
|
23866
21574
|
readonly playerLeave: PlayerLeaveBeforeEventSignal;
|
|
23867
|
-
/**
|
|
23868
|
-
* @beta
|
|
23869
|
-
* @remarks
|
|
23870
|
-
* This event fires before a block is placed by a player.
|
|
23871
|
-
*
|
|
23872
|
-
* This property can be read in early-execution mode.
|
|
23873
|
-
*
|
|
23874
|
-
*/
|
|
23875
|
-
readonly playerPlaceBlock: PlayerPlaceBlockBeforeEventSignal;
|
|
23876
21575
|
/**
|
|
23877
21576
|
* @remarks
|
|
23878
21577
|
* This property can be read in early-execution mode.
|
|
@@ -23950,27 +21649,13 @@ export interface BiomeFilter {
|
|
|
23950
21649
|
includeTags?: string[];
|
|
23951
21650
|
}
|
|
23952
21651
|
|
|
23953
|
-
/**
|
|
23954
|
-
* @beta
|
|
23955
|
-
* Contains additional options for searches for the
|
|
23956
|
-
* dimension.findNearestBiome API.
|
|
23957
|
-
*/
|
|
23958
|
-
export interface BiomeSearchOptions {
|
|
23959
|
-
/**
|
|
23960
|
-
* @remarks
|
|
23961
|
-
* Bounding volume size to look within.
|
|
23962
|
-
*
|
|
23963
|
-
*/
|
|
23964
|
-
boundingSize?: Vector3;
|
|
23965
|
-
}
|
|
23966
|
-
|
|
23967
21652
|
/**
|
|
23968
21653
|
* A BlockBoundingBox is an interface to an object which
|
|
23969
21654
|
* represents an AABB aligned rectangle.
|
|
23970
21655
|
* The BlockBoundingBox assumes that it was created in a valid
|
|
23971
21656
|
* state (min <= max) but cannot guarantee it (unless it was
|
|
23972
|
-
* created using the associated {@link
|
|
23973
|
-
* utility functions.
|
|
21657
|
+
* created using the associated {@link
|
|
21658
|
+
* @minecraft/server.BlockBoundingBoxUtils} utility functions.
|
|
23974
21659
|
* The min/max coordinates represent the diametrically opposite
|
|
23975
21660
|
* corners of the rectangle.
|
|
23976
21661
|
* The BlockBoundingBox is not a representation of blocks - it
|
|
@@ -23998,7 +21683,7 @@ export interface BlockBoundingBox {
|
|
|
23998
21683
|
}
|
|
23999
21684
|
|
|
24000
21685
|
/**
|
|
24001
|
-
* @
|
|
21686
|
+
* @rc
|
|
24002
21687
|
* Options used to filter block container access events.
|
|
24003
21688
|
*/
|
|
24004
21689
|
export interface BlockContainerAccessEventOptions {
|
|
@@ -24030,10 +21715,6 @@ export interface BlockCustomComponent {
|
|
|
24030
21715
|
*
|
|
24031
21716
|
*/
|
|
24032
21717
|
beforeOnPlayerPlace?: (arg0: BlockComponentPlayerPlaceBeforeEvent, arg1: CustomComponentParameters) => void;
|
|
24033
|
-
/**
|
|
24034
|
-
* @beta
|
|
24035
|
-
*/
|
|
24036
|
-
onBlockStateChange?: (arg0: BlockComponentBlockStateChangeEvent, arg1: CustomComponentParameters) => void;
|
|
24037
21718
|
/**
|
|
24038
21719
|
* @remarks
|
|
24039
21720
|
* This function will be called when a specific block is
|
|
@@ -24422,41 +22103,7 @@ export interface CameraTargetOptions {
|
|
|
24422
22103
|
}
|
|
24423
22104
|
|
|
24424
22105
|
/**
|
|
24425
|
-
* @
|
|
24426
|
-
* This interface defines an entry into the {@link
|
|
24427
|
-
* CompoundBlockVolume} which represents a volume of positive
|
|
24428
|
-
* or negative space.
|
|
24429
|
-
*
|
|
24430
|
-
*/
|
|
24431
|
-
export interface CompoundBlockVolumeItem {
|
|
24432
|
-
/**
|
|
24433
|
-
* @remarks
|
|
24434
|
-
* The 'action' defines how the block volume is represented in
|
|
24435
|
-
* the compound block volume stack.
|
|
24436
|
-
* 'Add' creates a block volume which is positively selected
|
|
24437
|
-
* 'Subtract' creates a block volume which represents a hole or
|
|
24438
|
-
* negative space in the overall compound block volume.
|
|
24439
|
-
*
|
|
24440
|
-
*/
|
|
24441
|
-
action?: CompoundBlockVolumeAction;
|
|
24442
|
-
/**
|
|
24443
|
-
* @remarks
|
|
24444
|
-
* The relativity enumeration determines whether the
|
|
24445
|
-
* BlockVolume specified is positioned relative to the parent
|
|
24446
|
-
* compound block volume origin, or in absolute world space.
|
|
24447
|
-
*
|
|
24448
|
-
*/
|
|
24449
|
-
locationRelativity?: CompoundBlockVolumePositionRelativity;
|
|
24450
|
-
/**
|
|
24451
|
-
* @remarks
|
|
24452
|
-
* The volume of space
|
|
24453
|
-
*
|
|
24454
|
-
*/
|
|
24455
|
-
volume: BlockVolume;
|
|
24456
|
-
}
|
|
24457
|
-
|
|
24458
|
-
/**
|
|
24459
|
-
* @beta
|
|
22106
|
+
* @rc
|
|
24460
22107
|
* Represents the source of a container access.
|
|
24461
22108
|
*/
|
|
24462
22109
|
export interface ContainerAccessSource {
|
|
@@ -24469,7 +22116,7 @@ export interface ContainerAccessSource {
|
|
|
24469
22116
|
}
|
|
24470
22117
|
|
|
24471
22118
|
/**
|
|
24472
|
-
* @
|
|
22119
|
+
* @rc
|
|
24473
22120
|
* Options for use when filtering container access sources.
|
|
24474
22121
|
*/
|
|
24475
22122
|
export interface ContainerAccessSourceFilter {
|
|
@@ -24566,15 +22213,6 @@ export interface CustomCommand {
|
|
|
24566
22213
|
* command.
|
|
24567
22214
|
*/
|
|
24568
22215
|
export interface CustomCommandParameter {
|
|
24569
|
-
/**
|
|
24570
|
-
* @beta
|
|
24571
|
-
* @remarks
|
|
24572
|
-
* Can be used to reference the enum name when {@link
|
|
24573
|
-
* CustomCommandParamType} is 'Enum'. Allows the parameter name
|
|
24574
|
-
* to be different from the enum name.
|
|
24575
|
-
*
|
|
24576
|
-
*/
|
|
24577
|
-
enumName?: string;
|
|
24578
22216
|
/**
|
|
24579
22217
|
* @remarks
|
|
24580
22218
|
* The name of parameter as it appears on the command line.
|
|
@@ -24608,35 +22246,6 @@ export interface CustomCommandResult {
|
|
|
24608
22246
|
status: CustomCommandStatus;
|
|
24609
22247
|
}
|
|
24610
22248
|
|
|
24611
|
-
/**
|
|
24612
|
-
* @beta
|
|
24613
|
-
*/
|
|
24614
|
-
export interface CustomTexture {
|
|
24615
|
-
/**
|
|
24616
|
-
* @remarks
|
|
24617
|
-
* The height of the icon, in relative units. Value must be
|
|
24618
|
-
* between 0.0 and 1.0, inclusive.
|
|
24619
|
-
*
|
|
24620
|
-
* Bounds: [0, 1]
|
|
24621
|
-
*/
|
|
24622
|
-
iconHeight: number;
|
|
24623
|
-
/**
|
|
24624
|
-
* @remarks
|
|
24625
|
-
* The width of the icon, in relative units. Value must be
|
|
24626
|
-
* between 0.0 and 1.0, inclusive.
|
|
24627
|
-
*
|
|
24628
|
-
* Bounds: [0, 1]
|
|
24629
|
-
*/
|
|
24630
|
-
iconWidth: number;
|
|
24631
|
-
/**
|
|
24632
|
-
* @remarks
|
|
24633
|
-
* The resource path to the custom texture. This should be a
|
|
24634
|
-
* valid string path to a texture asset.
|
|
24635
|
-
*
|
|
24636
|
-
*/
|
|
24637
|
-
path: string;
|
|
24638
|
-
}
|
|
24639
|
-
|
|
24640
22249
|
/**
|
|
24641
22250
|
* Contains a set of updates to the component definition state
|
|
24642
22251
|
* of an entity.
|
|
@@ -24656,14 +22265,6 @@ export interface DefinitionModifier {
|
|
|
24656
22265
|
*
|
|
24657
22266
|
*/
|
|
24658
22267
|
removedComponentGroups: string[];
|
|
24659
|
-
/**
|
|
24660
|
-
* @beta
|
|
24661
|
-
* @remarks
|
|
24662
|
-
* The list of entity definition events that will be fired via
|
|
24663
|
-
* this update.
|
|
24664
|
-
*
|
|
24665
|
-
*/
|
|
24666
|
-
triggers: Trigger[];
|
|
24667
22268
|
}
|
|
24668
22269
|
|
|
24669
22270
|
/**
|
|
@@ -24773,7 +22374,7 @@ export interface EntityApplyDamageOptions {
|
|
|
24773
22374
|
}
|
|
24774
22375
|
|
|
24775
22376
|
/**
|
|
24776
|
-
* @
|
|
22377
|
+
* @rc
|
|
24777
22378
|
* Options used to filter entity container access events.
|
|
24778
22379
|
*/
|
|
24779
22380
|
export interface EntityContainerAccessEventOptions {
|
|
@@ -25465,37 +23066,6 @@ export interface EntityRaycastOptions extends EntityFilter {
|
|
|
25465
23066
|
maxDistance?: number;
|
|
25466
23067
|
}
|
|
25467
23068
|
|
|
25468
|
-
/**
|
|
25469
|
-
* @beta
|
|
25470
|
-
* Controls when a waypoint is visible based on the state of
|
|
25471
|
-
* the entity it tracks. These rules allow filtering waypoint
|
|
25472
|
-
* visibility by entity conditions like sneaking, invisibility,
|
|
25473
|
-
* and death state.
|
|
25474
|
-
*/
|
|
25475
|
-
export interface EntityVisibilityRules {
|
|
25476
|
-
/**
|
|
25477
|
-
* @remarks
|
|
25478
|
-
* Controls whether the waypoint is shown when the tracked
|
|
25479
|
-
* entity is dead. If undefined, defaults to true.
|
|
25480
|
-
*
|
|
25481
|
-
*/
|
|
25482
|
-
showDead?: boolean;
|
|
25483
|
-
/**
|
|
25484
|
-
* @remarks
|
|
25485
|
-
* Controls whether the waypoint is shown when the tracked
|
|
25486
|
-
* entity is invisible. If undefined, defaults to true.
|
|
25487
|
-
*
|
|
25488
|
-
*/
|
|
25489
|
-
showInvisible?: boolean;
|
|
25490
|
-
/**
|
|
25491
|
-
* @remarks
|
|
25492
|
-
* Controls whether the waypoint is shown when the tracked
|
|
25493
|
-
* entity is sneaking. If undefined, defaults to true.
|
|
25494
|
-
*
|
|
25495
|
-
*/
|
|
25496
|
-
showSneaking?: boolean;
|
|
25497
|
-
}
|
|
25498
|
-
|
|
25499
23069
|
/**
|
|
25500
23070
|
* Equal to operator.
|
|
25501
23071
|
*/
|
|
@@ -25902,27 +23472,6 @@ export interface NotEqualsComparison {
|
|
|
25902
23472
|
notEquals: boolean | number | string;
|
|
25903
23473
|
}
|
|
25904
23474
|
|
|
25905
|
-
/**
|
|
25906
|
-
* @beta
|
|
25907
|
-
* Contains information about a player's party membership. This
|
|
25908
|
-
* object is a snapshot of the player's party state at the time
|
|
25909
|
-
* it was retrieved and is not kept up to date.
|
|
25910
|
-
*/
|
|
25911
|
-
export interface PartyInfo {
|
|
25912
|
-
/**
|
|
25913
|
-
* @remarks
|
|
25914
|
-
* Whether this player is the leader of their party.
|
|
25915
|
-
*
|
|
25916
|
-
*/
|
|
25917
|
-
isLeader: boolean;
|
|
25918
|
-
/**
|
|
25919
|
-
* @remarks
|
|
25920
|
-
* The unique identifier of the party this player belongs to.
|
|
25921
|
-
*
|
|
25922
|
-
*/
|
|
25923
|
-
partyId: string;
|
|
25924
|
-
}
|
|
25925
|
-
|
|
25926
23475
|
/**
|
|
25927
23476
|
* Contains additional options for how an animation is played.
|
|
25928
23477
|
*/
|
|
@@ -26042,39 +23591,6 @@ export interface PlayerSwingEventOptions {
|
|
|
26042
23591
|
swingSource?: EntitySwingSource;
|
|
26043
23592
|
}
|
|
26044
23593
|
|
|
26045
|
-
/**
|
|
26046
|
-
* @beta
|
|
26047
|
-
* Controls when a waypoint is visible based on player-specific
|
|
26048
|
-
* states. Extends {@link EntityVisibilityRules} with
|
|
26049
|
-
* additional rules for player-only states like hidden mode and
|
|
26050
|
-
* spectator mode.
|
|
26051
|
-
*/
|
|
26052
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
26053
|
-
export interface PlayerVisibilityRules extends EntityVisibilityRules {
|
|
26054
|
-
/**
|
|
26055
|
-
* @remarks
|
|
26056
|
-
* Controls whether the waypoint is shown when the tracked
|
|
26057
|
-
* player is hidden. If undefined, defaults to true.
|
|
26058
|
-
*
|
|
26059
|
-
*/
|
|
26060
|
-
showHidden?: boolean;
|
|
26061
|
-
/**
|
|
26062
|
-
* @remarks
|
|
26063
|
-
* Controls whether the waypoint is shown when the tracked
|
|
26064
|
-
* player is in spectator mode. If undefined, defaults to true.
|
|
26065
|
-
*
|
|
26066
|
-
*/
|
|
26067
|
-
showSpectator?: boolean;
|
|
26068
|
-
/**
|
|
26069
|
-
* @remarks
|
|
26070
|
-
* Controls whether the waypoint is shown when a spectator is
|
|
26071
|
-
* viewing another spectator player. If undefined, defaults to
|
|
26072
|
-
* true.
|
|
26073
|
-
*
|
|
26074
|
-
*/
|
|
26075
|
-
showSpectatorToSpectator?: boolean;
|
|
26076
|
-
}
|
|
26077
|
-
|
|
26078
23594
|
/**
|
|
26079
23595
|
* Key frame that holds the progress of the camera animation.
|
|
26080
23596
|
*/
|
|
@@ -26771,60 +24287,6 @@ export interface VectorXZ {
|
|
|
26771
24287
|
z: number;
|
|
26772
24288
|
}
|
|
26773
24289
|
|
|
26774
|
-
/**
|
|
26775
|
-
* @beta
|
|
26776
|
-
* Defines a texture and the distance range in which it should
|
|
26777
|
-
* be displayed. Used within a {@link WaypointTextureSelector}
|
|
26778
|
-
* to create distance-based texture switching.
|
|
26779
|
-
*/
|
|
26780
|
-
export interface WaypointTextureBounds {
|
|
26781
|
-
/**
|
|
26782
|
-
* @remarks
|
|
26783
|
-
* The lower distance bound for this texture. The texture is
|
|
26784
|
-
* displayed when the distance to the waypoint is greater than
|
|
26785
|
-
* this value. Value must be greater than or equal to 0.
|
|
26786
|
-
*
|
|
26787
|
-
* Minimum Value: 0
|
|
26788
|
-
*/
|
|
26789
|
-
lowerBound: number;
|
|
26790
|
-
/**
|
|
26791
|
-
* @remarks
|
|
26792
|
-
* The {@link WaypointTexture} or {@link CustomTexture} to
|
|
26793
|
-
* display within this distance range.
|
|
26794
|
-
*
|
|
26795
|
-
*/
|
|
26796
|
-
texture: CustomTexture | WaypointTexture;
|
|
26797
|
-
/**
|
|
26798
|
-
* @remarks
|
|
26799
|
-
* The upper distance bound for this texture. The texture is
|
|
26800
|
-
* displayed when the distance to the waypoint is less than or
|
|
26801
|
-
* equal to this value. If undefined, there is no upper limit.
|
|
26802
|
-
* Value must be greater than or equal to 0.
|
|
26803
|
-
*
|
|
26804
|
-
* Minimum Value: 0
|
|
26805
|
-
*/
|
|
26806
|
-
upperBound?: number;
|
|
26807
|
-
}
|
|
26808
|
-
|
|
26809
|
-
/**
|
|
26810
|
-
* @beta
|
|
26811
|
-
* Defines how waypoint textures change based on distance.
|
|
26812
|
-
* Contains a list of texture bounds that determine which
|
|
26813
|
-
* texture is displayed at different distance ranges.
|
|
26814
|
-
*/
|
|
26815
|
-
export interface WaypointTextureSelector {
|
|
26816
|
-
/**
|
|
26817
|
-
* @remarks
|
|
26818
|
-
* An array of {@link WaypointTextureBounds} that define which
|
|
26819
|
-
* textures are displayed at different distance ranges. The
|
|
26820
|
-
* system evaluates these bounds to determine the appropriate
|
|
26821
|
-
* texture based on the current distance to the waypoint. The
|
|
26822
|
-
* list has a maximum size limit of 16.
|
|
26823
|
-
*
|
|
26824
|
-
*/
|
|
26825
|
-
textureBoundsList: WaypointTextureBounds[];
|
|
26826
|
-
}
|
|
26827
|
-
|
|
26828
24290
|
/**
|
|
26829
24291
|
* Contains additional options for a playSound occurrence.
|
|
26830
24292
|
*/
|
|
@@ -26960,48 +24422,6 @@ export class CustomComponentNameError extends Error {
|
|
|
26960
24422
|
readonly reason: CustomComponentNameErrorReason;
|
|
26961
24423
|
}
|
|
26962
24424
|
|
|
26963
|
-
/**
|
|
26964
|
-
* @beta
|
|
26965
|
-
* Thrown when trying to register a custom dimension with a
|
|
26966
|
-
* name that has already been registered.
|
|
26967
|
-
*/
|
|
26968
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
26969
|
-
export class CustomDimensionAlreadyRegisteredError extends Error {
|
|
26970
|
-
private constructor();
|
|
26971
|
-
}
|
|
26972
|
-
|
|
26973
|
-
/**
|
|
26974
|
-
* @beta
|
|
26975
|
-
* Thrown when trying to register a custom dimension outside of
|
|
26976
|
-
* the system startup event.
|
|
26977
|
-
*/
|
|
26978
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
26979
|
-
export class CustomDimensionInvalidRegistryError extends Error {
|
|
26980
|
-
private constructor();
|
|
26981
|
-
}
|
|
26982
|
-
|
|
26983
|
-
/**
|
|
26984
|
-
* @beta
|
|
26985
|
-
* Thrown when trying to register a custom dimension with a
|
|
26986
|
-
* name that contains invalid characters.
|
|
26987
|
-
*/
|
|
26988
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
26989
|
-
export class CustomDimensionNameError extends Error {
|
|
26990
|
-
private constructor();
|
|
26991
|
-
}
|
|
26992
|
-
|
|
26993
|
-
/**
|
|
26994
|
-
* @beta
|
|
26995
|
-
* Thrown after using the /reload command when trying to
|
|
26996
|
-
* register a custom dimension that was not previously
|
|
26997
|
-
* registered. New custom dimensions cannot be added during a
|
|
26998
|
-
* reload.
|
|
26999
|
-
*/
|
|
27000
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27001
|
-
export class CustomDimensionReloadNewDimensionError extends Error {
|
|
27002
|
-
private constructor();
|
|
27003
|
-
}
|
|
27004
|
-
|
|
27005
24425
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27006
24426
|
export class EnchantmentLevelOutOfBoundsError extends Error {
|
|
27007
24427
|
private constructor();
|
|
@@ -27126,25 +24546,6 @@ export class InvalidStructureError extends Error {
|
|
|
27126
24546
|
private constructor();
|
|
27127
24547
|
}
|
|
27128
24548
|
|
|
27129
|
-
/**
|
|
27130
|
-
* @beta
|
|
27131
|
-
* Error thrown when attempting to perform operations on an
|
|
27132
|
-
* invalid waypoint. A waypoint becomes invalid when it is
|
|
27133
|
-
* removed or when the entity it tracks is no longer valid.
|
|
27134
|
-
*/
|
|
27135
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27136
|
-
export class InvalidWaypointError extends Error {
|
|
27137
|
-
private constructor();
|
|
27138
|
-
}
|
|
27139
|
-
|
|
27140
|
-
/**
|
|
27141
|
-
* @beta
|
|
27142
|
-
*/
|
|
27143
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27144
|
-
export class InvalidWaypointTextureSelectorError extends Error {
|
|
27145
|
-
private constructor();
|
|
27146
|
-
}
|
|
27147
|
-
|
|
27148
24549
|
/**
|
|
27149
24550
|
* Thrown when trying to register an item custom component with
|
|
27150
24551
|
* a name that has already been registered.
|
|
@@ -27201,25 +24602,6 @@ export class LocationOutOfWorldBoundariesError extends Error {
|
|
|
27201
24602
|
private constructor();
|
|
27202
24603
|
}
|
|
27203
24604
|
|
|
27204
|
-
/**
|
|
27205
|
-
* @beta
|
|
27206
|
-
* Error thrown when a locator bar operation fails. Contains a
|
|
27207
|
-
* reason code indicating the specific cause of the error.
|
|
27208
|
-
*/
|
|
27209
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27210
|
-
export class LocatorBarError extends Error {
|
|
27211
|
-
private constructor();
|
|
27212
|
-
/**
|
|
27213
|
-
* @remarks
|
|
27214
|
-
* The {@link LocatorBarErrorReason} code that indicates why
|
|
27215
|
-
* the locator bar operation failed.
|
|
27216
|
-
*
|
|
27217
|
-
* This property can be read in early-execution mode.
|
|
27218
|
-
*
|
|
27219
|
-
*/
|
|
27220
|
-
readonly reason: LocatorBarErrorReason;
|
|
27221
|
-
}
|
|
27222
|
-
|
|
27223
24605
|
/**
|
|
27224
24606
|
* Thrown when a name requires a namespace and an error occurs
|
|
27225
24607
|
* when validating that namespace
|
|
@@ -27240,14 +24622,6 @@ export class PlaceJigsawError extends Error {
|
|
|
27240
24622
|
private constructor();
|
|
27241
24623
|
}
|
|
27242
24624
|
|
|
27243
|
-
/**
|
|
27244
|
-
* @beta
|
|
27245
|
-
*/
|
|
27246
|
-
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27247
|
-
export class PrimitiveShapeError extends Error {
|
|
27248
|
-
private constructor();
|
|
27249
|
-
}
|
|
27250
|
-
|
|
27251
24625
|
// @ts-ignore Class inheritance allowed for native defined classes
|
|
27252
24626
|
export class RawMessageError extends Error {
|
|
27253
24627
|
private constructor();
|