@minecraft/server-editor 0.1.0-beta.1.21.20-preview.22 → 0.1.0-beta.1.21.3-stable

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +154 -1294
  2. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -14,7 +14,7 @@
14
14
  * ```json
15
15
  * {
16
16
  * "module_name": "@minecraft/server-editor",
17
- * "version": "0.1.0-beta"
17
+ * "version": "0.1.0-beta.1.21.3-stable"
18
18
  * }
19
19
  * ```
20
20
  *
@@ -36,28 +36,6 @@ export enum BlockPaletteItemType {
36
36
  Probability = 1,
37
37
  }
38
38
 
39
- export enum BrushPipelineOperationType {
40
- Include = 0,
41
- Exclude = 1,
42
- }
43
-
44
- /**
45
- * The possible variants of a color picker.
46
- */
47
- export declare enum ColorPickerVariant {
48
- Default = 0,
49
- Inline = 1,
50
- Expanded = 2,
51
- }
52
-
53
- /**
54
- * Predefined action bar items
55
- */
56
- export declare enum CoreActionBarItemType {
57
- Redo = 'editor:actionBarItem:redo',
58
- Undo = 'editor:actionBarItem:undo',
59
- }
60
-
61
39
  /**
62
40
  * Predefined top level menus for core editor
63
41
  */
@@ -137,21 +115,13 @@ export enum CursorTargetMode {
137
115
  Face = 1,
138
116
  }
139
117
 
140
- export enum DaylightCycle {
141
- Normal = 0,
142
- AlwaysDay = 1,
143
- LockTime = 2,
144
- }
145
-
146
118
  /**
147
119
  * Type of item that can be added to the property pane
148
120
  */
149
121
  export declare enum EDITOR_PANE_PROPERTY_ITEM_TYPE {
150
122
  Action = 'editorUI:Action',
151
- BlockList = 'editorUI:BlockList',
152
123
  BlockPicker = 'editorUI:BlockPicker',
153
124
  Boolean = 'editorUI:Boolean',
154
- ColorPicker = 'editorUI:ColorPicker',
155
125
  Divider = 'editorUI:Divider',
156
126
  Dropdown = 'editorUI:Dropdown',
157
127
  Image = 'editorUI:Image',
@@ -196,11 +166,6 @@ export declare enum EditorStatusBarAlignment {
196
166
  Left = 1,
197
167
  }
198
168
 
199
- export enum EntityOperationType {
200
- Create = 0,
201
- Delete = 1,
202
- }
203
-
204
169
  export enum ExportResult {
205
170
  ValidWorldExport = 0,
206
171
  LevelFetchFailed = 1,
@@ -212,14 +177,6 @@ export enum ExportResult {
212
177
  EditorSystemFailure = 7,
213
178
  }
214
179
 
215
- export enum GamePublishSetting {
216
- NoMultiPlay = 0,
217
- InviteOnly = 1,
218
- FriendsOnly = 2,
219
- FriendsOfFriends = 3,
220
- Public = 4,
221
- }
222
-
223
180
  /**
224
181
  * Enumeration representing identifiers for graphics settings
225
182
  * properties.
@@ -250,559 +207,116 @@ export declare enum InputModifier {
250
207
  * Keyboard key
251
208
  */
252
209
  export declare enum KeyboardKey {
253
- UNDEFINED = 0,
254
- /**
255
- * @remarks
256
- * KeyboardEvent.DOM_VK_BACK_SPACE
257
- *
258
- */
259
210
  BACKSPACE = 8,
260
- /**
261
- * @remarks
262
- * KeyboardEvent.DOM_VK_TAB
263
- *
264
- */
265
211
  TAB = 9,
266
- /**
267
- * @remarks
268
- * KeyboardEvent.DOM_VK_RETURN
269
- *
270
- */
271
212
  ENTER = 13,
272
- /**
273
- * @remarks
274
- * KeyboardEvent.DOM_VK_SHIFT
275
- *
276
- */
277
213
  SHIFT = 16,
278
- /**
279
- * @remarks
280
- * KeyboardEvent.DOM_VK_CONTROL
281
- *
282
- */
283
214
  CTRL = 17,
284
- /**
285
- * @remarks
286
- * KeyboardEvent.DOM_VK_ALT
287
- *
288
- */
289
215
  ALT = 18,
290
- /**
291
- * @remarks
292
- * KeyboardEvent.DOM_VK_CAPS_LOCK
293
- *
294
- */
295
216
  CAPS_LOCK = 20,
296
- /**
297
- * @remarks
298
- * KeyboardEvent.DOM_VK_ESCAPE
299
- *
300
- */
301
217
  ESCAPE = 27,
302
- /**
303
- * @remarks
304
- * KeyboardEvent.DOM_VK_SPACE
305
- *
306
- */
307
218
  SPACE = 32,
308
- /**
309
- * @remarks
310
- * KeyboardEvent.DOM_VK_PAGE_UP
311
- *
312
- */
313
219
  PAGE_UP = 33,
314
- /**
315
- * @remarks
316
- * KeyboardEvent.DOM_VK_PAGE_DOWN
317
- *
318
- */
319
220
  PAGE_DOWN = 34,
320
- /**
321
- * @remarks
322
- * KeyboardEvent.DOM_VK_END
323
- *
324
- */
325
221
  END = 35,
326
- /**
327
- * @remarks
328
- * KeyboardEvent.DOM_VK_HOME
329
- *
330
- */
331
222
  HOME = 36,
332
- /**
333
- * @remarks
334
- * KeyboardEvent.DOM_VK_LEFT
335
- *
336
- */
337
223
  LEFT = 37,
338
- /**
339
- * @remarks
340
- * KeyboardEvent.DOM_VK_UP
341
- *
342
- */
343
224
  UP = 38,
344
- /**
345
- * @remarks
346
- * KeyboardEvent.DOM_VK_RIGHT
347
- *
348
- */
349
225
  RIGHT = 39,
350
- /**
351
- * @remarks
352
- * KeyboardEvent.DOM_VK_DOWN
353
- *
354
- */
355
226
  DOWN = 40,
356
- /**
357
- * @remarks
358
- * KeyboardEvent.DOM_VK_PRINTSCREEN
359
- *
360
- */
361
227
  PRINT_SCREEN = 44,
362
- /**
363
- * @remarks
364
- * KeyboardEvent.DOM_VK_INSERT
365
- *
366
- */
367
228
  INSERT = 45,
368
- /**
369
- * @remarks
370
- * KeyboardEvent.DOM_VK_DELETE
371
- *
372
- */
373
229
  DELETE = 46,
374
- /**
375
- * @remarks
376
- * KeyboardEvent.DOM_VK_0
377
- *
378
- */
379
230
  KEY_0 = 48,
380
- /**
381
- * @remarks
382
- * KeyboardEvent.DOM_VK_1
383
- *
384
- */
385
231
  KEY_1 = 49,
386
- /**
387
- * @remarks
388
- * KeyboardEvent.DOM_VK_2
389
- *
390
- */
391
232
  KEY_2 = 50,
392
- /**
393
- * @remarks
394
- * KeyboardEvent.DOM_VK_3
395
- *
396
- */
397
233
  KEY_3 = 51,
398
- /**
399
- * @remarks
400
- * KeyboardEvent.DOM_VK_4
401
- *
402
- */
403
234
  KEY_4 = 52,
404
- /**
405
- * @remarks
406
- * KeyboardEvent.DOM_VK_5
407
- *
408
- */
409
235
  KEY_5 = 53,
410
- /**
411
- * @remarks
412
- * KeyboardEvent.DOM_VK_6
413
- *
414
- */
415
236
  KEY_6 = 54,
416
- /**
417
- * @remarks
418
- * KeyboardEvent.DOM_VK_7
419
- *
420
- */
421
237
  KEY_7 = 55,
422
- /**
423
- * @remarks
424
- * KeyboardEvent.DOM_VK_8
425
- *
426
- */
427
238
  KEY_8 = 56,
428
- /**
429
- * @remarks
430
- * KeyboardEvent.DOM_VK_9
431
- *
432
- */
433
239
  KEY_9 = 57,
434
- /**
435
- * @remarks
436
- * KeyboardEvent.DOM_VK_A
437
- *
438
- */
439
240
  KEY_A = 65,
440
- /**
441
- * @remarks
442
- * KeyboardEvent.DOM_VK_B
443
- *
444
- */
445
241
  KEY_B = 66,
446
- /**
447
- * @remarks
448
- * KeyboardEvent.DOM_VK_C
449
- *
450
- */
451
242
  KEY_C = 67,
452
- /**
453
- * @remarks
454
- * KeyboardEvent.DOM_VK_D
455
- *
456
- */
457
243
  KEY_D = 68,
458
- /**
459
- * @remarks
460
- * KeyboardEvent.DOM_VK_E
461
- *
462
- */
463
244
  KEY_E = 69,
464
- /**
465
- * @remarks
466
- * KeyboardEvent.DOM_VK_F
467
- *
468
- */
469
245
  KEY_F = 70,
470
- /**
471
- * @remarks
472
- * KeyboardEvent.DOM_VK_G
473
- *
474
- */
475
246
  KEY_G = 71,
476
- /**
477
- * @remarks
478
- * KeyboardEvent.DOM_VK_H
479
- *
480
- */
481
247
  KEY_H = 72,
482
- /**
483
- * @remarks
484
- * KeyboardEvent.DOM_VK_I
485
- *
486
- */
487
248
  KEY_I = 73,
488
- /**
489
- * @remarks
490
- * KeyboardEvent.DOM_VK_J
491
- *
492
- */
493
249
  KEY_J = 74,
494
- /**
495
- * @remarks
496
- * KeyboardEvent.DOM_VK_K
497
- *
498
- */
499
250
  KEY_K = 75,
500
- /**
501
- * @remarks
502
- * KeyboardEvent.DOM_VK_L
503
- *
504
- */
505
251
  KEY_L = 76,
506
- /**
507
- * @remarks
508
- * KeyboardEvent.DOM_VK_M
509
- *
510
- */
511
252
  KEY_M = 77,
512
- /**
513
- * @remarks
514
- * KeyboardEvent.DOM_VK_N
515
- *
516
- */
517
253
  KEY_N = 78,
518
- /**
519
- * @remarks
520
- * KeyboardEvent.DOM_VK_O
521
- *
522
- */
523
254
  KEY_O = 79,
524
- /**
525
- * @remarks
526
- * KeyboardEvent.DOM_VK_P
527
- *
528
- */
529
255
  KEY_P = 80,
530
- /**
531
- * @remarks
532
- * KeyboardEvent.DOM_VK_Q
533
- *
534
- */
535
256
  KEY_Q = 81,
536
- /**
537
- * @remarks
538
- * KeyboardEvent.DOM_VK_R
539
- *
540
- */
541
257
  KEY_R = 82,
542
- /**
543
- * @remarks
544
- * KeyboardEvent.DOM_VK_S
545
- *
546
- */
547
258
  KEY_S = 83,
548
- /**
549
- * @remarks
550
- * KeyboardEvent.DOM_VK_T
551
- *
552
- */
553
259
  KEY_T = 84,
554
- /**
555
- * @remarks
556
- * KeyboardEvent.DOM_VK_U
557
- *
558
- */
559
260
  KEY_U = 85,
560
- /**
561
- * @remarks
562
- * KeyboardEvent.DOM_VK_V
563
- *
564
- */
565
261
  KEY_V = 86,
566
- /**
567
- * @remarks
568
- * KeyboardEvent.DOM_VK_W
569
- *
570
- */
571
262
  KEY_W = 87,
572
- /**
573
- * @remarks
574
- * KeyboardEvent.DOM_VK_X
575
- *
576
- */
577
263
  KEY_X = 88,
578
- /**
579
- * @remarks
580
- * KeyboardEvent.DOM_VK_Y
581
- *
582
- */
583
264
  KEY_Y = 89,
584
- /**
585
- * @remarks
586
- * KeyboardEvent.DOM_VK_Z
587
- *
588
- */
589
265
  KEY_Z = 90,
590
- /**
591
- * @remarks
592
- * KeyboardEvent.DOM_VK_NUMPAD0
593
- *
594
- */
595
266
  NUMPAD_0 = 96,
596
- /**
597
- * @remarks
598
- * KeyboardEvent.DOM_VK_NUMPAD1
599
- *
600
- */
601
267
  NUMPAD_1 = 97,
602
- /**
603
- * @remarks
604
- * KeyboardEvent.DOM_VK_NUMPAD2
605
- *
606
- */
607
268
  NUMPAD_2 = 98,
608
- /**
609
- * @remarks
610
- * KeyboardEvent.DOM_VK_NUMPAD3
611
- *
612
- */
613
269
  NUMPAD_3 = 99,
614
- /**
615
- * @remarks
616
- * KeyboardEvent.DOM_VK_NUMPAD4
617
- *
618
- */
619
270
  NUMPAD_4 = 100,
620
- /**
621
- * @remarks
622
- * KeyboardEvent.DOM_VK_NUMPAD5
623
- *
624
- */
625
271
  NUMPAD_5 = 101,
626
- /**
627
- * @remarks
628
- * KeyboardEvent.DOM_VK_NUMPAD6
629
- *
630
- */
631
272
  NUMPAD_6 = 102,
632
- /**
633
- * @remarks
634
- * KeyboardEvent.DOM_VK_NUMPAD7
635
- *
636
- */
637
273
  NUMPAD_7 = 103,
638
- /**
639
- * @remarks
640
- * KeyboardEvent.DOM_VK_NUMPAD8
641
- *
642
- */
643
274
  NUMPAD_8 = 104,
644
- /**
645
- * @remarks
646
- * KeyboardEvent.DOM_VK_NUMPAD9
647
- *
648
- */
649
275
  NUMPAD_9 = 105,
650
- /**
651
- * @remarks
652
- * KeyboardEvent.DOM_VK_MULTIPLY
653
- *
654
- */
655
276
  NUMPAD_MULTIPLY = 106,
656
- /**
657
- * @remarks
658
- * KeyboardEvent.DOM_VK_ADD
659
- *
660
- */
661
277
  NUMPAD_ADD = 107,
662
- /**
663
- * @remarks
664
- * KeyboardEvent.DOM_VK_SEPARATOR
665
- *
666
- */
667
278
  NUMPAD_SEPARATOR = 108,
668
- /**
669
- * @remarks
670
- * KeyboardEvent.DOM_VK_SUBTRACT
671
- *
672
- */
673
279
  NUMPAD_SUBTRACT = 109,
674
- /**
675
- * @remarks
676
- * KeyboardEvent.DOM_VK_DECIMAL
677
- *
678
- */
679
280
  NUMPAD_DECIMAL = 110,
680
- /**
681
- * @remarks
682
- * KeyboardEvent.DOM_VK_DIVIDE
683
- *
684
- */
685
281
  NUMPAD_DIVIDE = 111,
686
- /**
687
- * @remarks
688
- * KeyboardEvent.DOM_VK_F1
689
- *
690
- */
691
282
  F1 = 112,
692
- /**
693
- * @remarks
694
- * KeyboardEvent.DOM_VK_F2
695
- *
696
- */
697
283
  F2 = 113,
698
- /**
699
- * @remarks
700
- * KeyboardEvent.DOM_VK_F3
701
- *
702
- */
703
284
  F3 = 114,
704
- /**
705
- * @remarks
706
- * KeyboardEvent.DOM_VK_F4
707
- *
708
- */
709
285
  F4 = 115,
710
- /**
711
- * @remarks
712
- * KeyboardEvent.DOM_VK_F5
713
- *
714
- */
715
286
  F5 = 116,
716
- /**
717
- * @remarks
718
- * KeyboardEvent.DOM_VK_F6
719
- *
720
- */
721
287
  F6 = 117,
722
- /**
723
- * @remarks
724
- * KeyboardEvent.DOM_VK_F7
725
- *
726
- */
727
288
  F7 = 118,
728
- /**
729
- * @remarks
730
- * KeyboardEvent.DOM_VK_F8
731
- *
732
- */
733
289
  F8 = 119,
734
- /**
735
- * @remarks
736
- * KeyboardEvent.DOM_VK_F9
737
- *
738
- */
739
290
  F9 = 120,
740
- /**
741
- * @remarks
742
- * KeyboardEvent.DOM_VK_F10
743
- *
744
- */
745
291
  F10 = 121,
746
- /**
747
- * @remarks
748
- * KeyboardEvent.DOM_VK_F11
749
- *
750
- */
751
292
  F11 = 122,
752
- /**
753
- * @remarks
754
- * KeyboardEvent.DOM_VK_F12
755
- *
756
- */
757
293
  F12 = 123,
758
- /**
759
- * @remarks
760
- * KeyboardEvent.DOM_VK_COMMA, ie. ','
761
- *
762
- */
763
294
  COMMA = 188,
764
- /**
765
- * @remarks
766
- * KeyboardEvent.DOM_VK_PERIOD, ie. '.'
767
- *
768
- */
769
295
  PERIOD = 190,
770
- /**
771
- * @remarks
772
- * KeyboardEvent.DOM_VK_SLASH, ie. '/'
773
- *
774
- */
775
296
  SLASH = 191,
776
- /**
777
- * @remarks
778
- * KeyboardEvent.DOM_VK_BACK_QUOTE, ie. '`'
779
- *
780
- */
781
297
  BACK_QUOTE = 192,
782
- /**
783
- * @remarks
784
- * KeyboardEvent.DOM_VK_OPEN_BRACKET, ie. '['
785
- *
786
- */
787
298
  BRACKET_OPEN = 219,
788
- /**
789
- * @remarks
790
- * KeyboardEvent.DOM_VK_BACK_SLASH, ie. '\'
791
- *
792
- */
793
299
  BACK_SLASH = 220,
300
+ BRACKET_CLOSE = 221,
301
+ QUOTE = 222,
302
+ }
303
+
304
+ /**
305
+ * Keyboard Key Actions
306
+ */
307
+ export declare enum KeyInputType {
794
308
  /**
795
309
  * @remarks
796
- * KeyboardEvent.DOM_VK_CLOSE_BRACKET, ie. ']'
310
+ * Button was pressed.
797
311
  *
798
312
  */
799
- BRACKET_CLOSE = 221,
313
+ Press = 1,
800
314
  /**
801
315
  * @remarks
802
- * KeyboardEvent.DOM_VK_BACK_QUOTE, ie. '"'
316
+ * Button was released.
803
317
  *
804
318
  */
805
- QUOTE = 222,
319
+ Release = 2,
806
320
  }
807
321
 
808
322
  /**
@@ -860,13 +374,6 @@ export declare enum MouseInputType {
860
374
  DragEnd = 7,
861
375
  }
862
376
 
863
- export enum PlayerPermissionLevel {
864
- Visitor = 0,
865
- Member = 1,
866
- Operator = 2,
867
- Custom = 3,
868
- }
869
-
870
377
  export enum PlaytestSessionResult {
871
378
  OK = 0,
872
379
  InvalidSessionHandle = 1,
@@ -952,13 +459,6 @@ export type IActionPropertyItem<T extends PropertyBag, Prop extends keyof T & st
952
459
  replaceBoundAction(action: RegisteredAction<NoArgsAction> | undefined): void;
953
460
  };
954
461
 
955
- /**
956
- * A property item which supports BlockList properties
957
- */
958
- export type IBlockListPropertyItem<T extends PropertyBag, Prop extends keyof T & string> = IPropertyItem<T, Prop> & {
959
- updateBlockList(newBlockList: string[]): void;
960
- };
961
-
962
462
  /**
963
463
  * A property item which supports Dropdown properties
964
464
  */
@@ -988,7 +488,6 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
988
488
  readonly actionManager: ActionManager;
989
489
  readonly inputManager: IGlobalInputManager;
990
490
  readonly menuBar: IMenuContainer;
991
- readonly actionBar: IActionBar;
992
491
  readonly toolRail: IModalToolContainer;
993
492
  readonly log: IPlayerLogger;
994
493
  readonly extensionContext: ExtensionContext;
@@ -1020,23 +519,6 @@ export type IVector3PropertyItem<T extends PropertyBag, Prop extends keyof T & s
1020
519
  }): void;
1021
520
  };
1022
521
 
1023
- /**
1024
- * Keyboard binding properties.
1025
- */
1026
- export type KeyBinding = {
1027
- key: KeyboardKey;
1028
- modifier?: InputModifier;
1029
- };
1030
-
1031
- /**
1032
- * Additional information about key binding.
1033
- */
1034
- export type KeyBindingInfo = {
1035
- uniqueId: string;
1036
- label?: string;
1037
- tooltip?: string;
1038
- };
1039
-
1040
522
  /**
1041
523
  * Modal tool lifecycle event payload
1042
524
  */
@@ -1217,52 +699,17 @@ export class BlockPalette {
1217
699
 
1218
700
  export class BlockPaletteManager {
1219
701
  private constructor();
1220
- /**
1221
- * @remarks
1222
- * This function can't be called in read-only mode.
1223
- *
1224
- */
1225
- addOrReplacePalette(paletteId: string, palette: BlockPalette): void;
1226
- getPalette(paletteId: string): BlockPalette | undefined;
1227
- getPaletteIdList(): string[];
1228
- /**
1229
- * @throws This function can throw errors.
1230
- */
1231
- getPaletteItem(paletteId: string, index: number): IBlockPaletteItem;
1232
- getPrimaryPalette(): BlockPalette;
1233
702
  /**
1234
703
  * @throws This function can throw errors.
1235
704
  */
1236
705
  getSelectedBlockType(): minecraftserver.BlockType;
1237
- getSelectedItem(): IBlockPaletteItem;
1238
- /**
1239
- * @remarks
1240
- * This function can't be called in read-only mode.
1241
- *
1242
- * @throws This function can throw errors.
1243
- */
1244
- removePalette(paletteId: string): void;
1245
- /**
1246
- * @remarks
1247
- * This function can't be called in read-only mode.
1248
- *
1249
- * @throws This function can throw errors.
1250
- */
1251
- setPaletteItem(paletteId: string, index: number, item: IBlockPaletteItem): void;
1252
- /**
1253
- * @remarks
1254
- * This function can't be called in read-only mode.
1255
- *
1256
- * @throws This function can throw errors.
1257
- */
1258
- setPrimaryPalette(paletteId: string): void;
1259
706
  /**
1260
707
  * @remarks
1261
708
  * This function can't be called in read-only mode.
1262
709
  *
1263
710
  * @throws This function can throw errors.
1264
711
  */
1265
- setSelectedItem(item: IBlockPaletteItem): void;
712
+ setSelectedBlockType(block: minecraftserver.BlockType): void;
1266
713
  }
1267
714
 
1268
715
  export class BrushShapeManager {
@@ -1277,15 +724,6 @@ export class BrushShapeManager {
1277
724
  * @throws This function can throw errors.
1278
725
  */
1279
726
  activateBrushShape(name: string): minecraftserver.CompoundBlockVolume;
1280
- /**
1281
- * @remarks
1282
- * This function can't be called in read-only mode.
1283
- *
1284
- */
1285
- getBrushVolume(
1286
- origin: minecraftserver.Vector3,
1287
- pipeline: BrushPipelineOperation[],
1288
- ): minecraftserver.CompoundBlockVolume | undefined;
1289
727
  /**
1290
728
  * @remarks
1291
729
  * This function can't be called in read-only mode.
@@ -1314,28 +752,6 @@ export class BrushShapeManager {
1314
752
  uiSettingValueChanged(elementName: string, newValue: boolean | number | string | minecraftserver.Vector3): boolean;
1315
753
  }
1316
754
 
1317
- export class ClipboardChangeAfterEvent {
1318
- private constructor();
1319
- readonly isPrimary: boolean;
1320
- readonly itemId: string;
1321
- }
1322
-
1323
- export class ClipboardChangeAfterEventSignal {
1324
- private constructor();
1325
- /**
1326
- * @remarks
1327
- * This function can't be called in read-only mode.
1328
- *
1329
- */
1330
- subscribe(callback: (arg: ClipboardChangeAfterEvent) => void): (arg: ClipboardChangeAfterEvent) => void;
1331
- /**
1332
- * @remarks
1333
- * This function can't be called in read-only mode.
1334
- *
1335
- */
1336
- unsubscribe(callback: (arg: ClipboardChangeAfterEvent) => void): void;
1337
- }
1338
-
1339
755
  /**
1340
756
  * A ClipboardItem is a handle to an object which represents a
1341
757
  * set of blocks in a contained bounding area (most likely
@@ -1550,27 +966,6 @@ export class Cursor {
1550
966
  * @throws This property can throw when used.
1551
967
  */
1552
968
  readonly isVisible: boolean;
1553
- /**
1554
- * @remarks
1555
- * This function can't be called in read-only mode.
1556
- *
1557
- * @throws This function can throw errors.
1558
- */
1559
- attachClipboardItem(item: ClipboardItem): void;
1560
- /**
1561
- * @remarks
1562
- * This function can't be called in read-only mode.
1563
- *
1564
- * @throws This function can throw errors.
1565
- */
1566
- clearAttachment(): void;
1567
- /**
1568
- * @remarks
1569
- * This function can't be called in read-only mode.
1570
- *
1571
- * @throws This function can throw errors.
1572
- */
1573
- getAttachmentProperties(): CursorAttachmentProperties;
1574
969
  /**
1575
970
  * @remarks
1576
971
  * Get the world position of the 3D block cursor
@@ -1593,7 +988,8 @@ export class Cursor {
1593
988
  /**
1594
989
  * @remarks
1595
990
  * Hide the 3D block cursor from view until the corresponding
1596
- * {@link Cursor.show} function is called
991
+ * {@link @minecraft-server-editor.Cursor.show} function is
992
+ * called
1597
993
  *
1598
994
  * This function can't be called in read-only mode.
1599
995
  *
@@ -1603,8 +999,9 @@ export class Cursor {
1603
999
  /**
1604
1000
  * @remarks
1605
1001
  * Manually offset the 3D block cursor by given amount.
1606
- * Depending on the {@link CursorProperties.controlMode} - this
1607
- * function may have no effect
1002
+ * Depending on the {@link
1003
+ * @minecraft-server-editor.CursorProperties.CursorControlMode}
1004
+ * - this function may have no effect
1608
1005
  *
1609
1006
  * This function can't be called in read-only mode.
1610
1007
  *
@@ -1625,13 +1022,6 @@ export class Cursor {
1625
1022
  * @throws This function can throw errors.
1626
1023
  */
1627
1024
  resetToDefaultState(): void;
1628
- /**
1629
- * @remarks
1630
- * This function can't be called in read-only mode.
1631
- *
1632
- * @throws This function can throw errors.
1633
- */
1634
- setAttachmentProperties(properties: CursorAttachmentProperties): void;
1635
1025
  /**
1636
1026
  * @remarks
1637
1027
  * Set the 3D block cursor properties to a given state
@@ -1655,29 +1045,6 @@ export class Cursor {
1655
1045
  show(): void;
1656
1046
  }
1657
1047
 
1658
- export class CursorAttachmentPropertiesChangeAfterEvent {
1659
- private constructor();
1660
- readonly properties: CursorAttachmentProperties;
1661
- }
1662
-
1663
- export class CursorAttachmentPropertyChangeAfterEventSignal {
1664
- private constructor();
1665
- /**
1666
- * @remarks
1667
- * This function can't be called in read-only mode.
1668
- *
1669
- */
1670
- subscribe(
1671
- callback: (arg: CursorAttachmentPropertiesChangeAfterEvent) => void,
1672
- ): (arg: CursorAttachmentPropertiesChangeAfterEvent) => void;
1673
- /**
1674
- * @remarks
1675
- * This function can't be called in read-only mode.
1676
- *
1677
- */
1678
- unsubscribe(callback: (arg: CursorAttachmentPropertiesChangeAfterEvent) => void): void;
1679
- }
1680
-
1681
1048
  export class CursorPropertiesChangeAfterEvent {
1682
1049
  private constructor();
1683
1050
  readonly properties: CursorProperties;
@@ -1738,7 +1105,7 @@ export class ExportManager {
1738
1105
  *
1739
1106
  * @throws This function can throw errors.
1740
1107
  */
1741
- beginExportProject(options: GameOptions): Promise<ExportResult>;
1108
+ beginExportProject(options: ProjectExportOptions): Promise<ExportResult>;
1742
1109
  /**
1743
1110
  * @remarks
1744
1111
  * This function can't be called in read-only mode.
@@ -1746,21 +1113,6 @@ export class ExportManager {
1746
1113
  * @throws This function can throw errors.
1747
1114
  */
1748
1115
  canExportProject(): boolean;
1749
- /**
1750
- * @remarks
1751
- * This function can't be called in read-only mode.
1752
- *
1753
- */
1754
- getGameOptions(useDefault?: boolean): GameOptions;
1755
- /**
1756
- * @remarks
1757
- * This function can't be called in read-only mode.
1758
- *
1759
- * @throws This function can throw errors.
1760
- *
1761
- * {@link Error}
1762
- */
1763
- getGameVersion(): string;
1764
1116
  }
1765
1117
 
1766
1118
  /**
@@ -1897,8 +1249,6 @@ export class ExtensionContext {
1897
1249
  */
1898
1250
  export class ExtensionContextAfterEvents {
1899
1251
  private constructor();
1900
- readonly clipboardChange: ClipboardChangeAfterEventSignal;
1901
- readonly cursorAttachmentPropertyChange: CursorAttachmentPropertyChangeAfterEventSignal;
1902
1252
  readonly cursorPropertyChange: CursorPropertyChangeAfterEventSignal;
1903
1253
  /**
1904
1254
  * @remarks
@@ -2124,7 +1474,7 @@ export class PlaytestManager {
2124
1474
  *
2125
1475
  * @throws This function can throw errors.
2126
1476
  */
2127
- beginPlaytest(options: GameOptions): Promise<PlaytestSessionResult>;
1477
+ beginPlaytest(options: PlaytestGameOptions): Promise<PlaytestSessionResult>;
2128
1478
  /**
2129
1479
  * @remarks
2130
1480
  * This function can't be called in read-only mode.
@@ -2320,7 +1670,7 @@ export class Selection {
2320
1670
  *
2321
1671
  * @param forceRelativity
2322
1672
  * See the description for {@link
2323
- * @minecraft/server.CompoundBlockVolume.peekLastVolume}
1673
+ * @minecraft-server/CompoundBlockVolume.peekLastVolume}
2324
1674
  * @returns
2325
1675
  * Returns undefined if the stack is empty
2326
1676
  */
@@ -2360,12 +1710,12 @@ export class Selection {
2360
1710
  * This function can't be called in read-only mode.
2361
1711
  *
2362
1712
  * @param other
2363
- * {@link @minecraft/server.CompoundBlockVolume} - set the
1713
+ * {@link @minecraft-server/CompoundBlockVolume} - set the
2364
1714
  * block component part of this selection to the specified
2365
1715
  * compound block volume. This will completely replace all
2366
1716
  * block volume definitions in the selection.
2367
- * {@link Selection} - replace the selection with the specified
2368
- * selection
1717
+ * {@link @Selection} - replace the selection with the
1718
+ * specified selection
2369
1719
  * @throws This function can throw errors.
2370
1720
  */
2371
1721
  set(other: minecraftserver.CompoundBlockVolume | Selection): void;
@@ -2444,14 +1794,18 @@ export class SettingsManager {
2444
1794
 
2445
1795
  export class SettingsUIElement {
2446
1796
  readonly initialValue: boolean | number | string | minecraftserver.Vector3;
1797
+ readonly max?: number;
1798
+ readonly min?: number;
2447
1799
  readonly name: string;
2448
- readonly onChange: (arg: boolean | number | string | minecraftserver.Vector3) => void;
2449
- readonly options: SettingsUIElementOptions;
1800
+ readonly onChange: (arg: boolean | number | string | minecraftserver.Vector3) => boolean;
1801
+ readonly options?: string[];
2450
1802
  constructor(
2451
1803
  name: string,
2452
1804
  initialValue: boolean | number | string | minecraftserver.Vector3,
2453
- onChange: (arg: boolean | number | string | minecraftserver.Vector3) => void,
2454
- options?: SettingsUIElementOptions,
1805
+ onChange: (arg: boolean | number | string | minecraftserver.Vector3) => boolean,
1806
+ min?: number,
1807
+ max?: number,
1808
+ options?: string[],
2455
1809
  );
2456
1810
  }
2457
1811
 
@@ -2467,37 +1821,9 @@ export class SimpleBlockPaletteItem extends IBlockPaletteItem {
2467
1821
  * how to use this class and the wrapper framework
2468
1822
  */
2469
1823
  export declare class SimpleToolWrapper implements IDisposable {
2470
- /**
2471
- * @remarks
2472
- * The player UI session that the tool is running in Use this
2473
- * to access the player UI session, or any of the session's
2474
- * components
2475
- *
2476
- */
2477
1824
  get session(): IPlayerUISession;
2478
- /**
2479
- * @remarks
2480
- * The simple tool instance that is created and managed by the
2481
- * wrapper Use this to access any of the tools components, or
2482
- * mess with the tools window visibility
2483
- *
2484
- */
2485
1825
  get simpleTool(): ISimpleTool;
2486
- /**
2487
- * @remarks
2488
- * Setup the simple tool instance with the given options This
2489
- * will create and initialize the simple tool instance
2490
- *
2491
- */
2492
1826
  setupSimpleTool(session: IPlayerUISession, options: ISimpleToolOptions): void;
2493
- /**
2494
- * @remarks
2495
- * Teardown the simple tool instance This will call the
2496
- * teardown function on the simple tool instance This function
2497
- * is automatically invoked by the Editor Extension system when
2498
- * the editor is shutting down
2499
- *
2500
- */
2501
1827
  teardown(): void;
2502
1828
  }
2503
1829
 
@@ -2539,15 +1865,6 @@ export class SimulationState {
2539
1865
  */
2540
1866
  export class TransactionManager {
2541
1867
  private constructor();
2542
- /**
2543
- * @remarks
2544
- * This function can't be called in read-only mode.
2545
- *
2546
- * @throws This function can throw errors.
2547
- *
2548
- * {@link Error}
2549
- */
2550
- addEntityOperation(entity: minecraftserver.Entity, type: EntityOperationType): boolean;
2551
1868
  /**
2552
1869
  * @remarks
2553
1870
  * This function can't be called in read-only mode.
@@ -2683,7 +2000,7 @@ export class TransactionManager {
2683
2000
  /**
2684
2001
  * @remarks
2685
2002
  * Begin tracking block changes in an area defined by a {@link
2686
- * @minecraft/server.CompoundBlockVolume}. These will be added
2003
+ * @minecraft-server/CompoundBlockVolume}. These will be added
2687
2004
  * to a pending changes list.
2688
2005
  * The pending list will be added to the open transaction
2689
2006
  * record when a commit has been issued.
@@ -2691,7 +2008,7 @@ export class TransactionManager {
2691
2008
  * This function can't be called in read-only mode.
2692
2009
  *
2693
2010
  * @param compoundBlockVolume
2694
- * {@link @minecraft/server.CompoundBlockVolume} to track.
2011
+ * {@link @minecraft-server/CompoundBlockVolume} to track.
2695
2012
  * Only non-void block locations will be tracked -- any changes
2696
2013
  * falling into a void/negative space will not be tracked
2697
2014
  * @throws This function can throw errors.
@@ -2719,7 +2036,7 @@ export class TransactionManager {
2719
2036
  * Selection Volumes can also represent irregular shapes with
2720
2037
  * non-contiguous blocks and this tracking call will honor the
2721
2038
  * actual selected areas in the volume (and not the negative
2722
- * space) (see {@link @minecraft/server.CompoundBlockVolume}
2039
+ * space) (see {@link @minecraft-server/CompoundBlockVolume}
2723
2040
  * for more details
2724
2041
  *
2725
2042
  * This function can't be called in read-only mode.
@@ -2921,11 +2238,6 @@ export class WidgetStateChangeEventData {
2921
2238
  readonly widget: Widget;
2922
2239
  }
2923
2240
 
2924
- export interface BrushPipelineOperation {
2925
- blockTypes: minecraftserver.BlockType[];
2926
- operation: BrushPipelineOperationType;
2927
- }
2928
-
2929
2241
  export interface BrushShape {
2930
2242
  icon: string;
2931
2243
  name: string;
@@ -2977,18 +2289,6 @@ export interface ClipboardWriteOptions {
2977
2289
  rotation?: minecraftserver.StructureRotation;
2978
2290
  }
2979
2291
 
2980
- export interface CursorAttachmentProperties {
2981
- boundsFillColor?: minecraftserver.RGBA;
2982
- boundsVisible?: boolean;
2983
- boundsWireframeColor?: minecraftserver.RGBA;
2984
- contentsFillColor?: minecraftserver.RGBA;
2985
- contentsWireframeColor?: minecraftserver.RGBA;
2986
- mirror?: minecraftserver.StructureMirrorAxis;
2987
- offset?: minecraftserver.Vector3;
2988
- origin?: minecraftserver.Vector3;
2989
- rotation?: minecraftserver.StructureRotation;
2990
- }
2991
-
2992
2292
  /**
2993
2293
  * The CursorProperties interface is used to describe the
2994
2294
  * properties of the Editor 3D block cursor construct.
@@ -3022,7 +2322,6 @@ export interface CursorProperties {
3022
2322
  *
3023
2323
  */
3024
2324
  controlMode?: CursorControlMode;
3025
- fillColor?: minecraftserver.RGBA;
3026
2325
  /**
3027
2326
  * @remarks
3028
2327
  * The fixed distance from the players feet at which the cursor
@@ -3108,46 +2407,6 @@ export interface ExtensionOptionalParameters {
3108
2407
  toolGroupId?: string;
3109
2408
  }
3110
2409
 
3111
- export interface GameOptions {
3112
- bonusChest?: boolean;
3113
- cheats?: boolean;
3114
- commandBlockEnabled?: boolean;
3115
- daylightCycle?: DaylightCycle;
3116
- difficulty?: minecraftserver.Difficulty;
3117
- dimensionId?: string;
3118
- disableWeather?: boolean;
3119
- educationEdition?: boolean;
3120
- entitiesDropLoot?: boolean;
3121
- exportType?: ProjectExportType;
3122
- fireSpreads?: boolean;
3123
- friendlyFire?: boolean;
3124
- gameMode?: minecraftserver.GameMode;
3125
- immediateRespawn?: boolean;
3126
- keepInventory?: boolean;
3127
- lanVisibility?: boolean;
3128
- mobGriefing?: boolean;
3129
- mobLoot?: boolean;
3130
- mobSpawning?: boolean;
3131
- multiplayerGame?: boolean;
3132
- naturalRegeneration?: boolean;
3133
- playerAccess?: GamePublishSetting;
3134
- playerPermissions?: PlayerPermissionLevel;
3135
- randomTickSpeed?: number;
3136
- recipeUnlocking?: boolean;
3137
- respawnBlocksExplode?: boolean;
3138
- respawnRadius?: number;
3139
- showCoordinates?: boolean;
3140
- showDaysPlayed?: boolean;
3141
- simulationDistance?: number;
3142
- spawnPosition?: minecraftserver.Vector3;
3143
- startingMap?: boolean;
3144
- tileDrops?: boolean;
3145
- timeOfDay?: number;
3146
- tntExplodes?: boolean;
3147
- weather?: number;
3148
- worldName?: string;
3149
- }
3150
-
3151
2410
  /**
3152
2411
  * A properties class for the global instance of the logger
3153
2412
  * object.
@@ -3173,6 +2432,18 @@ export interface LogProperties {
3173
2432
  tags?: string[];
3174
2433
  }
3175
2434
 
2435
+ export interface PlaytestGameOptions {
2436
+ alwaysDay?: boolean;
2437
+ difficulty?: minecraftserver.Difficulty;
2438
+ dimensionId?: string;
2439
+ disableWeather?: boolean;
2440
+ gameMode?: minecraftserver.GameMode;
2441
+ showCoordinates?: boolean;
2442
+ spawnPosition?: minecraftserver.Vector3;
2443
+ timeOfDay?: number;
2444
+ weather?: number;
2445
+ }
2446
+
3176
2447
  export interface ProjectExportOptions {
3177
2448
  alwaysDay?: boolean;
3178
2449
  difficulty?: minecraftserver.Difficulty;
@@ -3183,13 +2454,6 @@ export interface ProjectExportOptions {
3183
2454
  initialTimOfDay?: number;
3184
2455
  }
3185
2456
 
3186
- export interface SettingsUIElementOptions {
3187
- dropdownItems?: string[];
3188
- max?: number;
3189
- min?: number;
3190
- refreshOnChange?: boolean;
3191
- }
3192
-
3193
2457
  export interface WidgetCreateOptions {
3194
2458
  initialVisibility?: boolean;
3195
2459
  isSelectable?: boolean;
@@ -3225,159 +2489,62 @@ export interface ActionManager {
3225
2489
 
3226
2490
  /**
3227
2491
  * Represents a UI session for a given player
3228
- */
3229
- export interface BuiltInUIManager {
3230
- /**
3231
- * @remarks
3232
- * Navigates to the documentation site.
3233
- *
3234
- */
3235
- navigateToDocumentation(): void;
3236
- /**
3237
- * @remarks
3238
- * Navigates to the feedback site
3239
- *
3240
- */
3241
- navigateToFeedback(): void;
3242
- /**
3243
- * @remarks
3244
- * Navigates to the pause screen
3245
- *
3246
- */
3247
- navigateToPauseScreen(): void;
3248
- /**
3249
- * @remarks
3250
- * Updates the visibility of the log panel
3251
- *
3252
- */
3253
- updateLogPanelVisibility(visibility: boolean): void;
3254
- /**
3255
- * @remarks
3256
- * Updates the visibility of the control demo
3257
- *
3258
- */
3259
- updateUISettingsPanelVisibility(visibility: boolean): void;
3260
- /**
3261
- * @remarks
3262
- * Updates the visibility of the welcome panel
3263
- *
3264
- */
3265
- updateWelcomePanelVisibility(visibility: boolean): void;
3266
- }
3267
-
3268
- /**
3269
- * An event that can be subscribed to. You can use the token,
3270
- * returned from the subscribe method, to clean up handlers.
3271
- */
3272
- export declare interface EventSink<T> {
3273
- /**
3274
- * @remarks
3275
- * Subscribes an event handler to a particular subscription.
3276
- *
3277
- * @param handler
3278
- * Handler function to subscribe with.
3279
- * @returns
3280
- * An event handler subscription token that can be used to
3281
- * unsubscribe and clean-up handlers.
3282
- */
3283
- subscribe(handler: EventHandler<T>): IEventToken;
3284
- }
3285
-
3286
- /**
3287
- * Manager for IActionBarItem objects.
3288
- */
3289
- export interface IActionBar {
3290
- /**
3291
- * @remarks
3292
- * Add a new action bar item to the collection.
3293
- *
3294
- * @param id
3295
- * Unique item identifier.
3296
- * @param action
3297
- * Action to be invoked.
3298
- * @param props
3299
- * Configuration for the item to create.
3300
- */
3301
- registerItem(
3302
- id: string,
3303
- action: RegisteredAction<NoArgsAction>,
3304
- props: IActionBarItemCreationParams,
3305
- ): IActionBarItem;
3306
- /**
3307
- * @remarks
3308
- * Remove an action item from the collection.
3309
- *
3310
- * @param id
3311
- * Unique item identifier.
3312
- */
3313
- unregisterItem(id: string): void;
3314
- }
3315
-
3316
- /**
3317
- * Registered item handle in the Action Bar collection.
3318
- */
3319
- export interface IActionBarItem {
3320
- /**
3321
- * @remarks
3322
- * Returns the current enabled state of the item.
3323
- *
3324
- */
3325
- getEnabled: () => boolean;
3326
- /**
3327
- * @remarks
3328
- * Unique identifier of the item.
3329
- *
3330
- */
3331
- readonly id: string;
2492
+ */
2493
+ export interface BuiltInUIManager {
3332
2494
  /**
3333
2495
  * @remarks
3334
- * Text label of the item.
2496
+ * Navigates to the documentation site.
3335
2497
  *
3336
2498
  */
3337
- readonly label: string;
2499
+ navigateToDocumentation(): void;
3338
2500
  /**
3339
2501
  * @remarks
3340
- * Modify enabled state of the item.
2502
+ * Navigates to the feedback site
3341
2503
  *
3342
2504
  */
3343
- setEnabled: (enabled: boolean) => void;
3344
- }
3345
-
3346
- /**
3347
- * Properties required to create an Action Bar item.
3348
- */
3349
- export interface IActionBarItemCreationParams {
2505
+ navigateToFeedback(): void;
3350
2506
  /**
3351
2507
  * @remarks
3352
- * Initial enabled state of the item. If not defined, default
3353
- * is true.
2508
+ * Navigates to the pause screen
3354
2509
  *
3355
2510
  */
3356
- enabled?: boolean;
2511
+ navigateToPauseScreen(): void;
3357
2512
  /**
3358
2513
  * @remarks
3359
- * Icon resource for the item.
2514
+ * Updates the visibility of the log panel
3360
2515
  *
3361
2516
  */
3362
- icon: string;
2517
+ updateLogPanelVisibility(visibility: boolean): void;
3363
2518
  /**
3364
2519
  * @remarks
3365
- * Text label for item.
2520
+ * Updates the visibility of the control demo
3366
2521
  *
3367
2522
  */
3368
- label: string;
2523
+ updateUISettingsPanelVisibility(visibility: boolean): void;
3369
2524
  /**
3370
2525
  * @remarks
3371
- * Tooltip description for the item.
2526
+ * Updates the visibility of the welcome panel
3372
2527
  *
3373
2528
  */
3374
- tooltipDescription?: string;
2529
+ updateWelcomePanelVisibility(visibility: boolean): void;
2530
+ }
2531
+
2532
+ /**
2533
+ * An event that can be subscribed to. You can use the token,
2534
+ * returned from the subscribe method, to clean up handlers.
2535
+ */
2536
+ export declare interface EventSink<T> {
3375
2537
  /**
3376
2538
  * @remarks
3377
- * Tooltip title for the item.
2539
+ * Subscribes an event handler to a particular subscription.
3378
2540
  *
2541
+ * @param handler
2542
+ * Handler function to subscribe with.
2543
+ * @returns
2544
+ * An event handler subscription token that can be used to
2545
+ * unsubscribe and clean-up handlers.
3379
2546
  */
3380
- tooltipTitle?: string;
2547
+ subscribe(handler: EventHandler<T>): IEventToken;
3381
2548
  }
3382
2549
 
3383
2550
  /**
@@ -3392,19 +2559,22 @@ export interface IDisposable {
3392
2559
  teardown(): void;
3393
2560
  }
3394
2561
 
3395
- /**
3396
- * Properties of dropdown property item children
3397
- */
3398
2562
  export interface IDropdownItem {
3399
2563
  /**
3400
2564
  * @remarks
3401
- * Localized display text of the dropdown item.
2565
+ * Fallback display text if no loc ID
2566
+ *
2567
+ */
2568
+ readonly displayAltText: string;
2569
+ /**
2570
+ * @remarks
2571
+ * Loc ID (resolved on client)
3402
2572
  *
3403
2573
  */
3404
- readonly label: string;
2574
+ readonly displayStringId: string;
3405
2575
  /**
3406
2576
  * @remarks
3407
- * The selectable value of the dropdown item.
2577
+ * The selectable value of the DropDown item.
3408
2578
  *
3409
2579
  */
3410
2580
  readonly value: number;
@@ -3441,8 +2611,8 @@ export interface IGlobalInputManager {
3441
2611
  registerKeyBinding(
3442
2612
  inputContextId: EditorInputContext,
3443
2613
  action: SupportedKeyboardActionTypes,
3444
- binding: KeyBinding,
3445
- info?: KeyBindingInfo,
2614
+ button: KeyboardKey,
2615
+ modifier?: InputModifier,
3446
2616
  ): void;
3447
2617
  }
3448
2618
 
@@ -3454,12 +2624,6 @@ export interface IMenu {
3454
2624
  *
3455
2625
  */
3456
2626
  checked?: boolean;
3457
- /**
3458
- * @remarks
3459
- * The menu will be in either an enabled or disabled state
3460
- *
3461
- */
3462
- enabled: boolean;
3463
2627
  /**
3464
2628
  * @remarks
3465
2629
  * Unique ID for the menu
@@ -3514,16 +2678,16 @@ export interface IMenuCreationParams {
3514
2678
  checked?: boolean;
3515
2679
  /**
3516
2680
  * @remarks
3517
- * Whether the menu should be enabled or disabled
2681
+ * Loc ID (resolved on client)
3518
2682
  *
3519
2683
  */
3520
- enabled?: boolean;
2684
+ displayStringId?: string;
3521
2685
  /**
3522
2686
  * @remarks
3523
- * Localized display text of the menu
2687
+ * The name of the menu
3524
2688
  *
3525
2689
  */
3526
- label: string;
2690
+ name: string;
3527
2691
  /**
3528
2692
  * @remarks
3529
2693
  * Custom unique identifier that will replace random id
@@ -3548,7 +2712,7 @@ export interface IModalTool {
3548
2712
  bindPropertyPane(pane: IPropertyPane): void;
3549
2713
  dispose(): void;
3550
2714
  hide(): void;
3551
- registerKeyBinding(action: SupportedKeyboardActionTypes, binding: KeyBinding, info?: KeyBindingInfo): void;
2715
+ registerKeyBinding(action: SupportedKeyboardActionTypes, button: KeyboardKey, modifier?: InputModifier): void;
3552
2716
  registerMouseButtonBinding(action: SupportedMouseActionTypes): void;
3553
2717
  registerMouseDragBinding(action: SupportedMouseActionTypes): void;
3554
2718
  registerMouseWheelBinding(action: SupportedMouseActionTypes): void;
@@ -3682,10 +2846,16 @@ export interface IPropertyItemOptions {
3682
2846
  onChange?: OnChangeCallback<PropertyBag, string>;
3683
2847
  /**
3684
2848
  * @remarks
3685
- * Localized title of the property item
2849
+ * Fallback display text if no loc ID
2850
+ *
2851
+ */
2852
+ titleAltText?: string;
2853
+ /**
2854
+ * @remarks
2855
+ * Loc ID (resolved on client)
3686
2856
  *
3687
2857
  */
3688
- title?: string;
2858
+ titleStringId?: string;
3689
2859
  /**
3690
2860
  * @remarks
3691
2861
  * If the item should be visible in the UI.
@@ -3694,11 +2864,6 @@ export interface IPropertyItemOptions {
3694
2864
  visible?: boolean;
3695
2865
  }
3696
2866
 
3697
- // @ts-ignore Class inheritance allowed for native defined classes
3698
- export interface IPropertyItemOptionsBlockList extends IPropertyItemOptions {
3699
- blockList: string[];
3700
- }
3701
-
3702
2867
  // @ts-ignore Class inheritance allowed for native defined classes
3703
2868
  export interface IPropertyItemOptionsBool extends IPropertyItemOptions {
3704
2869
  /**
@@ -3720,12 +2885,6 @@ export interface IPropertyItemOptionsButton extends IPropertyItemOptions {
3720
2885
  variant?: ButtonVariant;
3721
2886
  }
3722
2887
 
3723
- // @ts-ignore Class inheritance allowed for native defined classes
3724
- export interface IPropertyItemOptionsColorPicker extends IPropertyItemOptions {
3725
- showAlpha?: boolean;
3726
- variant?: ColorPickerVariant;
3727
- }
3728
-
3729
2888
  // @ts-ignore Class inheritance allowed for native defined classes
3730
2889
  export interface IPropertyItemOptionsDataPicker extends IPropertyItemOptions {
3731
2890
  /**
@@ -3754,13 +2913,6 @@ export interface IPropertyItemOptionsImage extends IPropertyItemOptions {
3754
2913
 
3755
2914
  // @ts-ignore Class inheritance allowed for native defined classes
3756
2915
  export interface IPropertyItemOptionsNumber extends IPropertyItemOptions {
3757
- /**
3758
- * @remarks
3759
- * If we should treat the number as floating point. By default
3760
- * is false
3761
- *
3762
- */
3763
- isFloat?: boolean;
3764
2916
  /**
3765
2917
  * @remarks
3766
2918
  * The min possible value for the number.
@@ -3803,8 +2955,8 @@ export interface IPropertyItemOptionsTable extends IPropertyItemOptions {
3803
2955
  */
3804
2956
  // @ts-ignore Class inheritance allowed for native defined classes
3805
2957
  export interface IPropertyItemOptionsText extends IPropertyItemOptions {
3806
- border?: boolean;
3807
- valueStringId?: string;
2958
+ border: boolean;
2959
+ valueStringId: string;
3808
2960
  }
3809
2961
 
3810
2962
  // @ts-ignore Class inheritance allowed for native defined classes
@@ -3885,33 +3037,28 @@ export interface IPropertyPane {
3885
3037
  readonly parentPaneId?: string;
3886
3038
  /**
3887
3039
  * @remarks
3888
- * Localized title of the property pane
3040
+ * Fallback display text if no loc ID
3889
3041
  *
3890
3042
  */
3891
- title: string;
3043
+ titleAltText: string;
3892
3044
  /**
3893
3045
  * @remarks
3894
- * Check visibility of the pane
3046
+ * Loc ID (resolved on client)
3895
3047
  *
3896
3048
  */
3897
- visible: boolean;
3049
+ titleStringId: string;
3898
3050
  /**
3899
3051
  * @remarks
3900
- * Width of the panel in rem.
3052
+ * Check visibility of the pane
3901
3053
  *
3902
3054
  */
3903
- width?: number;
3055
+ visible: boolean;
3904
3056
  /**
3905
3057
  * @remarks
3906
- * Adds a block list to the pane.
3058
+ * Width of the panel in rem.
3907
3059
  *
3908
3060
  */
3909
- addBlockList(options?: IPropertyItemOptionsBlockList): IBlockListPropertyItem<
3910
- {
3911
- EMPTY: undefined;
3912
- },
3913
- 'EMPTY'
3914
- >;
3061
+ width?: number;
3915
3062
  /**
3916
3063
  * @remarks
3917
3064
  * Adds a BlockPicker item to the pane.
@@ -3947,16 +3094,6 @@ export interface IPropertyPane {
3947
3094
  },
3948
3095
  'EMPTY'
3949
3096
  >;
3950
- /**
3951
- * @remarks
3952
- * Adds a color picker item to the pane.
3953
- *
3954
- */
3955
- addColorPicker<T extends PropertyBag, Prop extends keyof T & string>(
3956
- obj: T,
3957
- property: Prop,
3958
- options?: IPropertyItemOptionsColorPicker,
3959
- ): IPropertyItem<T, Prop>;
3960
3097
  /**
3961
3098
  * @remarks
3962
3099
  * Adds an divider item to the pane.
@@ -3990,8 +3127,6 @@ export interface IPropertyPane {
3990
3127
  ): IPropertyItem<T, Prop>;
3991
3128
  /**
3992
3129
  * @remarks
3993
- * Adds an image item to the pane.
3994
- *
3995
3130
  */
3996
3131
  addImage<T extends PropertyBag, Prop extends keyof T & string>(
3997
3132
  obj: T,
@@ -4100,10 +3235,23 @@ export interface IPropertyPaneOptions {
4100
3235
  direction?: LayoutDirection;
4101
3236
  /**
4102
3237
  * @remarks
4103
- * Localized title of the property pane
3238
+ * Fallback display text if no loc ID
3239
+ *
3240
+ */
3241
+ titleAltText: string;
3242
+ /**
3243
+ * @remarks
3244
+ * Loc ID (resolved on client)
3245
+ *
3246
+ */
3247
+ titleStringId: string;
3248
+ /**
3249
+ * @remarks
3250
+ * Width of the panel in rem. This property is ignored in case
3251
+ * of sub panes
4104
3252
  *
4105
3253
  */
4106
- title: string;
3254
+ width?: number;
4107
3255
  }
4108
3256
 
4109
3257
  export interface IPropertyTableCellItem {
@@ -4155,137 +3303,57 @@ export interface IRegisterExtensionOptionalParameters {
4155
3303
  * the editor evolves.
4156
3304
  */
4157
3305
  export interface ISimpleTool {
4158
- /**
4159
- * @remarks
4160
- * Get a reference to the menu component that was automatically
4161
- * created for the tool This generally only happens if the tool
4162
- * is a global tool (i.e. has a pane and does not have a tool
4163
- * rail component) In this case a menu item is automatically
4164
- * created and some visibility controls are inserted. If you
4165
- * have additional menu options you want to add, this is the
4166
- * ideal control to add children to
4167
- *
4168
- */
4169
3306
  get menu(): IMenu | undefined;
4170
- /**
4171
- * @remarks
4172
- * Get the tool name
4173
- *
4174
- */
4175
3307
  get name(): string;
4176
- /**
4177
- * @remarks
4178
- * Get a reference to the root (primary) property pane
4179
- * component - if no component was requested, this function
4180
- * will throw an error
4181
- *
4182
- */
4183
3308
  get pane(): ISimpleToolPaneComponent;
4184
- /**
4185
- * @remarks
4186
- * Get a reference to the IPlayerUISession. This is the primary
4187
- * interface to the editor UI and all of the editor extension
4188
- * controls
4189
- *
4190
- */
4191
3309
  get session(): IPlayerUISession;
4192
- /**
4193
- * @remarks
4194
- * Get a reference to the status bar component - if no
4195
- * component was requested, this function will throw an error
4196
- *
4197
- */
4198
3310
  get statusBar(): ISimpleToolStatusBarComponent;
4199
- /**
4200
- * @remarks
4201
- * Get a reference to the tool rail component - if no component
4202
- * was requested, this function will throw an error
4203
- *
4204
- */
4205
3311
  get toolRail(): ISimpleToolRailComponent;
4206
3312
  /**
4207
3313
  * @remarks
4208
- * Find a pane or subpane by it's unique ID.
4209
- *
4210
3314
  */
4211
3315
  findPane(idString: string): ISimpleToolPaneComponent | undefined;
4212
3316
  /**
4213
3317
  * @remarks
4214
- * Hide a particular pane or subpane by it's unique ID. If no
4215
- * ID is provided (or cannot be found) the function will throw
4216
- * an error Although the parent pane is used to execute the
4217
- * visibility request, the hidePane function will NOT affect
4218
- * the visibility of any sibling panes -- so it is possible to
4219
- * hide all of the child panes of a parent using this function
4220
- *
4221
3318
  */
4222
3319
  hidePane(idString?: string): void;
4223
3320
  /**
4224
3321
  * @remarks
4225
- * Send a tagged Debug log message to the console. The tag will
4226
- * contain the tool name
4227
- *
4228
3322
  */
4229
3323
  logDebug(message: string): void;
4230
3324
  /**
4231
3325
  * @remarks
4232
- * Send a tagged Error log message to the console. The tag will
4233
- * contain the tool name
4234
- *
4235
3326
  */
4236
3327
  logError(message: string): void;
4237
3328
  /**
4238
3329
  * @remarks
4239
- * Send a tagged Informational log message to the console. The
4240
- * tag will contain the tool name
4241
- *
4242
3330
  */
4243
3331
  logInfo(message: string): void;
4244
3332
  /**
4245
3333
  * @remarks
4246
- * Send a tagged Warning log message to the console. The tag
4247
- * will contain the tool name
4248
- *
4249
3334
  */
4250
3335
  logWarn(message: string): void;
4251
3336
  /**
4252
3337
  * @remarks
4253
- * Show a particular pane or subpane by it's unique ID. If no
4254
- * ID is provided (or cannot be found) the function will throw
4255
- * an error Note that the showPane function (when used with a
4256
- * child pane) will use the parent pane to execute the
4257
- * visibility request. In this case, if the child panes are
4258
- * marked as mututally exclusive, then the siblings of the
4259
- * requested pane will be hidden
4260
- *
4261
3338
  */
4262
3339
  showPane(idString?: string): void;
4263
3340
  /**
4264
3341
  * @remarks
4265
- * Much like the showPane function, but will hide all other
4266
- * panes that are not the requested pane irrespective of the
4267
- * exclusivity setting
4268
- *
4269
3342
  */
4270
3343
  showPaneExclusively(idString: string): void;
4271
3344
  /**
4272
3345
  * @remarks
4273
- * A teardown function implemented by the ISimpleTool
4274
- * implementation, and is called by the system during editor
4275
- * extension shutdown. Don't override this function - instead,
4276
- * implement the onTeardown event in the ISimpleToolOptions
4277
- * structure
4278
- *
4279
3346
  */
4280
3347
  teardown(): void;
4281
3348
  }
4282
3349
 
4283
3350
  /**
4284
- * Define a key binding for the simple tool activation
3351
+ * Define a (key & modifier) pair for the simple tool
3352
+ * activation key binding
4285
3353
  */
4286
- export interface ISimpleToolKeyBinding {
4287
- binding: KeyBinding;
4288
- info?: KeyBindingInfo;
3354
+ export interface ISimpleToolKeyPair {
3355
+ button: KeyboardKey;
3356
+ buttonModifier: InputModifier;
4289
3357
  }
4290
3358
 
4291
3359
  /**
@@ -4293,61 +3361,12 @@ export interface ISimpleToolKeyBinding {
4293
3361
  * simple tool, and the optional components that are desired.
4294
3362
  */
4295
3363
  export interface ISimpleToolOptions {
4296
- /**
4297
- * @remarks
4298
- * A key binding that will activate the tool. Note that if the
4299
- * tool is a modal tool, then the key binding will be tied to
4300
- * the tool rail activation, and appear as a tooltip on the
4301
- * tool rail button. If the tool is a global tool, then the key
4302
- * binding will be tied to a menu item in the View menu, and
4303
- * appear as a stateful menu item which will control the pane
4304
- * visibility. If there's no pane required, then the key
4305
- * binding is ignored
4306
- *
4307
- */
4308
- activationKeyBinding?: ISimpleToolKeyBinding;
4309
- /**
4310
- * @remarks
4311
- * The name of the tool. This will be used to identify the tool
4312
- * in the UI and logs and will be used in the View \> [Tool
4313
- * Name] menu item (if it's a global tool)
4314
- *
4315
- */
3364
+ activationKeyBinding?: ISimpleToolKeyPair;
4316
3365
  name: string;
4317
- /**
4318
- * @remarks
4319
- * The finalize function is executed after each of the
4320
- * components have been created and finalized during
4321
- * construction
4322
- *
4323
- */
4324
3366
  onFinalize?: (tool: ISimpleTool) => void;
4325
- /**
4326
- * @remarks
4327
- * The teardown function is executed when the tool is being
4328
- * torn down and only after the individual components have
4329
- * executed their own teardown functions
4330
- *
4331
- */
4332
3367
  onTeardown?: (tool: ISimpleTool) => void;
4333
- /**
4334
- * @remarks
4335
- * The options structure for an optional property pane
4336
- * component
4337
- *
4338
- */
4339
3368
  propertyPaneOptions?: ISimpleToolPaneOptions;
4340
- /**
4341
- * @remarks
4342
- * The options structure for an optional status bar component
4343
- *
4344
- */
4345
3369
  statusBarOptions?: ISimpleToolStatusBarOptions;
4346
- /**
4347
- * @remarks
4348
- * The options structure for an optional tool rail component
4349
- *
4350
- */
4351
3370
  toolRailOptions?: ISimpleToolRailOptions;
4352
3371
  }
4353
3372
 
@@ -4366,83 +3385,26 @@ export interface ISimpleToolOptions {
4366
3385
  * to the creator/user)
4367
3386
  */
4368
3387
  export interface ISimpleToolPaneComponent {
4369
- /**
4370
- * @remarks
4371
- * Get a list of the unique ID's of all of the child panes
4372
- *
4373
- */
4374
3388
  get childPaneList(): string[];
4375
- /**
4376
- * @remarks
4377
- * Get the unique ID of the pane
4378
- *
4379
- */
4380
3389
  get id(): string;
4381
- /**
4382
- * @remarks
4383
- * Check the visibility of the pane
4384
- *
4385
- */
4386
3390
  get isVisible(): boolean;
4387
- /**
4388
- * @remarks
4389
- * Get a reference to actual property pane implementation that
4390
- * was constructed by the tool. This reference is used to
4391
- * construct the UI components that are displayed in the pane.
4392
- *
4393
- */
4394
3391
  get pane(): IPropertyPane;
4395
- /**
4396
- * @remarks
4397
- * Get a reference to the IPlayerUISession. This is the primary
4398
- * interface to the editor UI and all of the editor extension
4399
- * controls
4400
- *
4401
- */
4402
3392
  get session(): IPlayerUISession;
4403
- /**
4404
- * @remarks
4405
- * Get a reference to the parent tool.
4406
- *
4407
- */
4408
3393
  get simpleTool(): ISimpleTool;
4409
3394
  /**
4410
3395
  * @remarks
4411
- * Find a pane reference by unique ID
4412
- *
4413
3396
  */
4414
3397
  findPane(idString: string): ISimpleToolPaneComponent | undefined;
4415
3398
  /**
4416
3399
  * @remarks
4417
- * Hide the pane. Although the parent pane is used to execute
4418
- * the visibility request, the hidePane function will NOT
4419
- * affect the visibility of any sibling panes -- so it is
4420
- * possible to hide all of the child panes of a parent using
4421
- * this function
4422
- *
4423
3400
  */
4424
3401
  hidePane(): void;
4425
3402
  /**
4426
3403
  * @remarks
4427
- * This causes the reconstruction of the pane (and the child
4428
- * panes) as if the tool was being constructed for the first
4429
- * time. This is unfortunately necessary until such time that
4430
- * all of our UI components are able to communicate dynamically
4431
- * with their client counterparts. Certain controls require a
4432
- * full teardown and reconstruction to properly update their
4433
- * state. This is undergoing code changes and should become
4434
- * unnecessary in the future.
4435
- *
4436
3404
  */
4437
3405
  reconstructPane(): void;
4438
3406
  /**
4439
3407
  * @remarks
4440
- * Show the pane. Note, if this is a sub-pane, then this
4441
- * function will ask the parent for permission to show, and may
4442
- * result in the visibility of any sibling panes to change as a
4443
- * result (depending on the `mutually exclusive visibility`
4444
- * flag)
4445
- *
4446
3408
  */
4447
3409
  showPane(): void;
4448
3410
  }
@@ -4464,77 +3426,22 @@ export interface ISimpleToolPaneComponent {
4464
3426
  * pane to finalize itself.
4465
3427
  */
4466
3428
  export interface ISimpleToolPaneOptions {
4467
- /**
4468
- * @remarks
4469
- * The id of the child pane that should be visible when the
4470
- * parent pane is first shown, or the editor tool is
4471
- * constructed and finalized
4472
- *
4473
- */
4474
3429
  childPaneInitiallyVisible?: string;
4475
- /**
4476
- * @remarks
4477
- * An optional array of child panes. These panes are set up
4478
- * exactly the same as the top level pane, but are displayed as
4479
- * children inside the parent pane.
4480
- *
4481
- */
4482
3430
  childPanes?: ISimpleToolPaneOptions[];
4483
- /**
4484
- * @remarks
4485
- * An optional flag to indicate whether the child panes are
4486
- * mutually exclusive. If this is true, then only one child
4487
- * pane can be visible at a time. If this is false, then
4488
- * multiple child panes can be visible at the same time.
4489
- * Visibility is controlled either through `showPane` or
4490
- * `hidePane` functions of the `ISimpleToolPaneComponent` or
4491
- * through the visibility methods in the top level tool
4492
- * (`ISimpleTool`)
4493
- *
4494
- */
4495
3431
  childPanesMutuallyExclusive?: boolean;
4496
- /**
4497
- * @remarks
4498
- * The unique identifier for this pane. This is used to
4499
- * identify the pane in the tool's pane hierarchy.
4500
- *
4501
- */
4502
3432
  id: string;
4503
3433
  onBeginFinalize?: (pane: ISimpleToolPaneComponent) => void;
4504
3434
  onEndFinalize?: (pane: ISimpleToolPaneComponent) => void;
4505
3435
  onHide?: (pane: ISimpleToolPaneComponent) => void;
4506
3436
  onShow?: (pane: ISimpleToolPaneComponent) => void;
4507
3437
  onTeardown?: (pane: ISimpleToolPaneComponent) => void;
4508
- /**
4509
- * @remarks
4510
- * The title of the pane. This will be displayed in the title
4511
- * bar of the pane.
4512
- *
4513
- */
4514
- title: string;
3438
+ titleAltText: string;
3439
+ titleStringId?: string;
4515
3440
  }
4516
3441
 
4517
3442
  export interface ISimpleToolRailComponent {
4518
- /**
4519
- * @remarks
4520
- * Get a reference to the IPlayerUISession. This is the primary
4521
- * interface to the editor UI and all of the editor extension
4522
- * controls
4523
- *
4524
- */
4525
3443
  get session(): IPlayerUISession;
4526
- /**
4527
- * @remarks
4528
- * Get a reference to the parent tool.
4529
- *
4530
- */
4531
3444
  get simpleTool(): ISimpleTool;
4532
- /**
4533
- * @remarks
4534
- * Get the implementation interface of the underlying tool rail
4535
- * component
4536
- *
4537
- */
4538
3445
  get toolRail(): IModalTool;
4539
3446
  }
4540
3447
 
@@ -4552,32 +3459,15 @@ export interface ISimpleToolRailComponent {
4552
3459
  * gameplay interaction
4553
3460
  */
4554
3461
  export interface ISimpleToolRailOptions {
4555
- /**
4556
- * @remarks
4557
- * The icon for the tool rail button. This is generally a URL
4558
- * to an image file in the editor extension resource pack e.g.
4559
- * `pack://textures/my-tool-icon.png`
4560
- *
4561
- */
3462
+ displayAltText: string;
3463
+ displayStringId?: string;
4562
3464
  icon: string;
4563
3465
  onActivate?: (component: ISimpleToolRailComponent) => void;
4564
3466
  onDeactivate?: (component: ISimpleToolRailComponent) => void;
4565
3467
  onFinalize?: (component: ISimpleToolRailComponent) => void;
4566
3468
  onTeardown?: (component: ISimpleToolRailComponent) => void;
4567
- /**
4568
- * @remarks
4569
- * The text for the tool title
4570
- *
4571
- */
4572
- title: string;
4573
- /**
4574
- * @remarks
4575
- * The tooltip description for the tool. Note: if an activation
4576
- * key binding was added to `ISimpleToolOptions`, then the key
4577
- * binding will be appended to the tooltip string.
4578
- *
4579
- */
4580
- tooltip: string;
3469
+ tooltipAltText: string;
3470
+ tooltipStringId?: string;
4581
3471
  }
4582
3472
 
4583
3473
  export interface ISimpleToolStatusBarComponent {
@@ -4593,36 +3483,13 @@ export interface ISimpleToolStatusBarComponent {
4593
3483
  * status bar item for a simple tool.
4594
3484
  */
4595
3485
  export interface ISimpleToolStatusBarOptions {
4596
- /**
4597
- * @remarks
4598
- * The alignment of the status bar item within the parent
4599
- * status bar container
4600
- *
4601
- */
4602
3486
  alignment: EditorStatusBarAlignment;
4603
- /**
4604
- * @remarks
4605
- * The text for the status bar item
4606
- *
4607
- */
4608
3487
  displayAltText: string;
4609
3488
  onFinalize?: (statusBar: ISimpleToolStatusBarComponent) => void;
4610
3489
  onHide?: (statusBar: ISimpleToolStatusBarComponent) => void;
4611
3490
  onShow?: (statusBar: ISimpleToolStatusBarComponent) => void;
4612
3491
  onTeardown?: (statusBar: ISimpleToolStatusBarComponent) => void;
4613
- /**
4614
- * @remarks
4615
- * The size of the status bar item within the parent status bar
4616
- * container
4617
- *
4618
- */
4619
3492
  size: number;
4620
- /**
4621
- * @remarks
4622
- * Determine the status bar visibility based on the existence
4623
- * and visibility of the tool's root property pane
4624
- *
4625
- */
4626
3493
  visibility?: SimpleToolStatusBarVisibility;
4627
3494
  }
4628
3495
 
@@ -4649,34 +3516,34 @@ export interface IStatusBarItem {
4649
3516
  export interface ModalToolCreationParameters {
4650
3517
  /**
4651
3518
  * @remarks
4652
- * Icon, if any (from resource pack on client)
3519
+ * The displayed string for the tool
4653
3520
  *
4654
3521
  */
4655
- icon?: string;
3522
+ displayAltText: string;
4656
3523
  /**
4657
3524
  * @remarks
4658
- * Modal input context identifier
3525
+ * Loc ID (resolved on client)
4659
3526
  *
4660
3527
  */
4661
- inputContextId?: string;
3528
+ displayStringId?: string;
4662
3529
  /**
4663
3530
  * @remarks
4664
- * Localized text label for modal input context
3531
+ * Icon, if any (from resource pack on client)
4665
3532
  *
4666
3533
  */
4667
- inputContextLabel?: string;
3534
+ icon?: string;
4668
3535
  /**
4669
3536
  * @remarks
4670
- * Title of the tool
3537
+ * tooltipAltText alt text, if any
4671
3538
  *
4672
3539
  */
4673
- title: string;
3540
+ tooltipAltText?: string;
4674
3541
  /**
4675
3542
  * @remarks
4676
- * Tooltip description of the toll
3543
+ * Tooltip localization string ID
4677
3544
  *
4678
3545
  */
4679
- tooltip?: string;
3546
+ tooltipStringId?: string;
4680
3547
  }
4681
3548
 
4682
3549
  /**
@@ -4709,20 +3576,6 @@ export declare function executeLargeOperation(
4709
3576
  selection: Selection,
4710
3577
  operation: (blockLocation: minecraftserver.Vector3) => void,
4711
3578
  ): Promise<void>;
4712
- /**
4713
- * @remarks
4714
- * Executes an operation over a BlockLocationIterator via
4715
- * chunks to allow splitting operation over multiple game ticks
4716
- *
4717
- * @param blockLocationIterator
4718
- * the selection to iterator over
4719
- * @param operation
4720
- * the operation to apply over each block location
4721
- */
4722
- export declare function executeLargeOperationFromIterator(
4723
- blockLocationIterator: minecraftserver.BlockLocationIterator,
4724
- operation: (blockLocation: minecraftserver.Vector3) => void,
4725
- ): Promise<void>;
4726
3579
  /**
4727
3580
  * @remarks
4728
3581
  * Returns a string array of the default block types for the
@@ -4733,6 +3586,13 @@ export declare function executeLargeOperationFromIterator(
4733
3586
  * Default allowed block list
4734
3587
  */
4735
3588
  export declare function getBlockPickerDefaultAllowBlockList(): string[];
3589
+ /**
3590
+ * @remarks
3591
+ * Adds the resource pack editor prefix and returns the full
3592
+ * localization ID
3593
+ *
3594
+ */
3595
+ export declare function getLocalizationId(locId: string): string;
4736
3596
  /**
4737
3597
  * @remarks
4738
3598
  * Registers an editor extension into Minecraft. This function