@minecraft/server-editor 0.1.0-beta.1.21.10-preview.23 → 0.1.0-beta.1.21.2-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 +10 -637
  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.1.21.10-preview.23"
17
+ * "version": "0.1.0-beta.1.21.2-stable"
18
18
  * }
19
19
  * ```
20
20
  *
@@ -36,19 +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
- * Predefined action bar items
46
- */
47
- export declare enum CoreActionBarItemType {
48
- Redo = 'editor:actionBarItem:redo',
49
- Undo = 'editor:actionBarItem:undo',
50
- }
51
-
52
39
  /**
53
40
  * Predefined top level menus for core editor
54
41
  */
@@ -135,7 +122,6 @@ export declare enum EDITOR_PANE_PROPERTY_ITEM_TYPE {
135
122
  Action = 'editorUI:Action',
136
123
  BlockPicker = 'editorUI:BlockPicker',
137
124
  Boolean = 'editorUI:Boolean',
138
- ColorPicker = 'editorUI:ColorPicker',
139
125
  Divider = 'editorUI:Divider',
140
126
  Dropdown = 'editorUI:Dropdown',
141
127
  Image = 'editorUI:Image',
@@ -502,7 +488,6 @@ export type IPlayerUISession<PerPlayerStorage = Record<string, never>> = {
502
488
  readonly actionManager: ActionManager;
503
489
  readonly inputManager: IGlobalInputManager;
504
490
  readonly menuBar: IMenuContainer;
505
- readonly actionBar: IActionBar;
506
491
  readonly toolRail: IModalToolContainer;
507
492
  readonly log: IPlayerLogger;
508
493
  readonly extensionContext: ExtensionContext;
@@ -714,52 +699,17 @@ export class BlockPalette {
714
699
 
715
700
  export class BlockPaletteManager {
716
701
  private constructor();
717
- /**
718
- * @remarks
719
- * This function can't be called in read-only mode.
720
- *
721
- */
722
- addOrReplacePalette(paletteId: string, palette: BlockPalette): void;
723
- getPalette(paletteId: string): BlockPalette | undefined;
724
- getPaletteIdList(): string[];
725
- /**
726
- * @throws This function can throw errors.
727
- */
728
- getPaletteItem(paletteId: string, index: number): IBlockPaletteItem;
729
- getPrimaryPalette(): BlockPalette;
730
702
  /**
731
703
  * @throws This function can throw errors.
732
704
  */
733
705
  getSelectedBlockType(): minecraftserver.BlockType;
734
- getSelectedItem(): IBlockPaletteItem;
735
- /**
736
- * @remarks
737
- * This function can't be called in read-only mode.
738
- *
739
- * @throws This function can throw errors.
740
- */
741
- removePalette(paletteId: string): void;
742
706
  /**
743
707
  * @remarks
744
708
  * This function can't be called in read-only mode.
745
709
  *
746
710
  * @throws This function can throw errors.
747
711
  */
748
- setPaletteItem(paletteId: string, index: number, item: IBlockPaletteItem): void;
749
- /**
750
- * @remarks
751
- * This function can't be called in read-only mode.
752
- *
753
- * @throws This function can throw errors.
754
- */
755
- setPrimaryPalette(paletteId: string): void;
756
- /**
757
- * @remarks
758
- * This function can't be called in read-only mode.
759
- *
760
- * @throws This function can throw errors.
761
- */
762
- setSelectedItem(item: IBlockPaletteItem): void;
712
+ setSelectedBlockType(block: minecraftserver.BlockType): void;
763
713
  }
764
714
 
765
715
  export class BrushShapeManager {
@@ -774,15 +724,6 @@ export class BrushShapeManager {
774
724
  * @throws This function can throw errors.
775
725
  */
776
726
  activateBrushShape(name: string): minecraftserver.CompoundBlockVolume;
777
- /**
778
- * @remarks
779
- * This function can't be called in read-only mode.
780
- *
781
- */
782
- getBrushVolume(
783
- origin: minecraftserver.Vector3,
784
- pipeline: BrushPipelineOperation[],
785
- ): minecraftserver.CompoundBlockVolume | undefined;
786
727
  /**
787
728
  * @remarks
788
729
  * This function can't be called in read-only mode.
@@ -811,28 +752,6 @@ export class BrushShapeManager {
811
752
  uiSettingValueChanged(elementName: string, newValue: boolean | number | string | minecraftserver.Vector3): boolean;
812
753
  }
813
754
 
814
- export class ClipboardChangeAfterEvent {
815
- private constructor();
816
- readonly isPrimary: boolean;
817
- readonly itemId: string;
818
- }
819
-
820
- export class ClipboardChangeAfterEventSignal {
821
- private constructor();
822
- /**
823
- * @remarks
824
- * This function can't be called in read-only mode.
825
- *
826
- */
827
- subscribe(callback: (arg: ClipboardChangeAfterEvent) => void): (arg: ClipboardChangeAfterEvent) => void;
828
- /**
829
- * @remarks
830
- * This function can't be called in read-only mode.
831
- *
832
- */
833
- unsubscribe(callback: (arg: ClipboardChangeAfterEvent) => void): void;
834
- }
835
-
836
755
  /**
837
756
  * A ClipboardItem is a handle to an object which represents a
838
757
  * set of blocks in a contained bounding area (most likely
@@ -1047,27 +966,6 @@ export class Cursor {
1047
966
  * @throws This property can throw when used.
1048
967
  */
1049
968
  readonly isVisible: boolean;
1050
- /**
1051
- * @remarks
1052
- * This function can't be called in read-only mode.
1053
- *
1054
- * @throws This function can throw errors.
1055
- */
1056
- attachClipboardItem(item: ClipboardItem): void;
1057
- /**
1058
- * @remarks
1059
- * This function can't be called in read-only mode.
1060
- *
1061
- * @throws This function can throw errors.
1062
- */
1063
- clearAttachment(): void;
1064
- /**
1065
- * @remarks
1066
- * This function can't be called in read-only mode.
1067
- *
1068
- * @throws This function can throw errors.
1069
- */
1070
- getAttachmentProperties(): CursorAttachmentProperties;
1071
969
  /**
1072
970
  * @remarks
1073
971
  * Get the world position of the 3D block cursor
@@ -1124,13 +1022,6 @@ export class Cursor {
1124
1022
  * @throws This function can throw errors.
1125
1023
  */
1126
1024
  resetToDefaultState(): void;
1127
- /**
1128
- * @remarks
1129
- * This function can't be called in read-only mode.
1130
- *
1131
- * @throws This function can throw errors.
1132
- */
1133
- setAttachmentProperties(properties: CursorAttachmentProperties): void;
1134
1025
  /**
1135
1026
  * @remarks
1136
1027
  * Set the 3D block cursor properties to a given state
@@ -1154,29 +1045,6 @@ export class Cursor {
1154
1045
  show(): void;
1155
1046
  }
1156
1047
 
1157
- export class CursorAttachmentPropertiesChangeAfterEvent {
1158
- private constructor();
1159
- readonly properties: CursorAttachmentProperties;
1160
- }
1161
-
1162
- export class CursorAttachmentPropertyChangeAfterEventSignal {
1163
- private constructor();
1164
- /**
1165
- * @remarks
1166
- * This function can't be called in read-only mode.
1167
- *
1168
- */
1169
- subscribe(
1170
- callback: (arg: CursorAttachmentPropertiesChangeAfterEvent) => void,
1171
- ): (arg: CursorAttachmentPropertiesChangeAfterEvent) => void;
1172
- /**
1173
- * @remarks
1174
- * This function can't be called in read-only mode.
1175
- *
1176
- */
1177
- unsubscribe(callback: (arg: CursorAttachmentPropertiesChangeAfterEvent) => void): void;
1178
- }
1179
-
1180
1048
  export class CursorPropertiesChangeAfterEvent {
1181
1049
  private constructor();
1182
1050
  readonly properties: CursorProperties;
@@ -1381,8 +1249,6 @@ export class ExtensionContext {
1381
1249
  */
1382
1250
  export class ExtensionContextAfterEvents {
1383
1251
  private constructor();
1384
- readonly clipboardChange: ClipboardChangeAfterEventSignal;
1385
- readonly cursorAttachmentPropertyChange: CursorAttachmentPropertyChangeAfterEventSignal;
1386
1252
  readonly cursorPropertyChange: CursorPropertyChangeAfterEventSignal;
1387
1253
  /**
1388
1254
  * @remarks
@@ -1928,14 +1794,18 @@ export class SettingsManager {
1928
1794
 
1929
1795
  export class SettingsUIElement {
1930
1796
  readonly initialValue: boolean | number | string | minecraftserver.Vector3;
1797
+ readonly max?: number;
1798
+ readonly min?: number;
1931
1799
  readonly name: string;
1932
- readonly onChange: (arg: boolean | number | string | minecraftserver.Vector3) => void;
1933
- readonly options: SettingsUIElementOptions;
1800
+ readonly onChange: (arg: boolean | number | string | minecraftserver.Vector3) => boolean;
1801
+ readonly options?: string[];
1934
1802
  constructor(
1935
1803
  name: string,
1936
1804
  initialValue: boolean | number | string | minecraftserver.Vector3,
1937
- onChange: (arg: boolean | number | string | minecraftserver.Vector3) => void,
1938
- options?: SettingsUIElementOptions,
1805
+ onChange: (arg: boolean | number | string | minecraftserver.Vector3) => boolean,
1806
+ min?: number,
1807
+ max?: number,
1808
+ options?: string[],
1939
1809
  );
1940
1810
  }
1941
1811
 
@@ -1951,37 +1821,9 @@ export class SimpleBlockPaletteItem extends IBlockPaletteItem {
1951
1821
  * how to use this class and the wrapper framework
1952
1822
  */
1953
1823
  export declare class SimpleToolWrapper implements IDisposable {
1954
- /**
1955
- * @remarks
1956
- * The player UI session that the tool is running in Use this
1957
- * to access the player UI session, or any of the session's
1958
- * components
1959
- *
1960
- */
1961
1824
  get session(): IPlayerUISession;
1962
- /**
1963
- * @remarks
1964
- * The simple tool instance that is created and managed by the
1965
- * wrapper Use this to access any of the tools components, or
1966
- * mess with the tools window visibility
1967
- *
1968
- */
1969
1825
  get simpleTool(): ISimpleTool;
1970
- /**
1971
- * @remarks
1972
- * Setup the simple tool instance with the given options This
1973
- * will create and initialize the simple tool instance
1974
- *
1975
- */
1976
1826
  setupSimpleTool(session: IPlayerUISession, options: ISimpleToolOptions): void;
1977
- /**
1978
- * @remarks
1979
- * Teardown the simple tool instance This will call the
1980
- * teardown function on the simple tool instance This function
1981
- * is automatically invoked by the Editor Extension system when
1982
- * the editor is shutting down
1983
- *
1984
- */
1985
1827
  teardown(): void;
1986
1828
  }
1987
1829
 
@@ -2396,11 +2238,6 @@ export class WidgetStateChangeEventData {
2396
2238
  readonly widget: Widget;
2397
2239
  }
2398
2240
 
2399
- export interface BrushPipelineOperation {
2400
- blockTypes: minecraftserver.BlockType[];
2401
- operation: BrushPipelineOperationType;
2402
- }
2403
-
2404
2241
  export interface BrushShape {
2405
2242
  icon: string;
2406
2243
  name: string;
@@ -2452,18 +2289,6 @@ export interface ClipboardWriteOptions {
2452
2289
  rotation?: minecraftserver.StructureRotation;
2453
2290
  }
2454
2291
 
2455
- export interface CursorAttachmentProperties {
2456
- boundsFillColor?: minecraftserver.RGBA;
2457
- boundsVisible?: boolean;
2458
- boundsWireframeColor?: minecraftserver.RGBA;
2459
- contentsFillColor?: minecraftserver.RGBA;
2460
- contentsWireframeColor?: minecraftserver.RGBA;
2461
- mirror?: minecraftserver.StructureMirrorAxis;
2462
- offset?: minecraftserver.Vector3;
2463
- origin?: minecraftserver.Vector3;
2464
- rotation?: minecraftserver.StructureRotation;
2465
- }
2466
-
2467
2292
  /**
2468
2293
  * The CursorProperties interface is used to describe the
2469
2294
  * properties of the Editor 3D block cursor construct.
@@ -2497,7 +2322,6 @@ export interface CursorProperties {
2497
2322
  *
2498
2323
  */
2499
2324
  controlMode?: CursorControlMode;
2500
- fillColor?: minecraftserver.RGBA;
2501
2325
  /**
2502
2326
  * @remarks
2503
2327
  * The fixed distance from the players feet at which the cursor
@@ -2630,13 +2454,6 @@ export interface ProjectExportOptions {
2630
2454
  initialTimOfDay?: number;
2631
2455
  }
2632
2456
 
2633
- export interface SettingsUIElementOptions {
2634
- dropdownItems?: string[];
2635
- max?: number;
2636
- min?: number;
2637
- refreshOnChange?: boolean;
2638
- }
2639
-
2640
2457
  export interface WidgetCreateOptions {
2641
2458
  initialVisibility?: boolean;
2642
2459
  isSelectable?: boolean;
@@ -2730,103 +2547,6 @@ export declare interface EventSink<T> {
2730
2547
  subscribe(handler: EventHandler<T>): IEventToken;
2731
2548
  }
2732
2549
 
2733
- /**
2734
- * Manager for IActionBarItem objects.
2735
- */
2736
- export interface IActionBar {
2737
- /**
2738
- * @remarks
2739
- * Add a new action bar item to the collection.
2740
- *
2741
- * @param id
2742
- * Unique item identifier.
2743
- * @param action
2744
- * Action to be invoked.
2745
- * @param props
2746
- * Configuration for the item to create.
2747
- */
2748
- registerItem(
2749
- id: string,
2750
- action: RegisteredAction<NoArgsAction>,
2751
- props: IActionBarItemCreationParams,
2752
- ): IActionBarItem;
2753
- /**
2754
- * @remarks
2755
- * Remove an action item from the collection.
2756
- *
2757
- * @param id
2758
- * Unique item identifier.
2759
- */
2760
- unregisterItem(id: string): void;
2761
- }
2762
-
2763
- /**
2764
- * Registered item handle in the Action Bar collection.
2765
- */
2766
- export interface IActionBarItem {
2767
- /**
2768
- * @remarks
2769
- * Returns the current enabled state of the item.
2770
- *
2771
- */
2772
- getEnabled: () => boolean;
2773
- /**
2774
- * @remarks
2775
- * Unique identifier of the item.
2776
- *
2777
- */
2778
- readonly id: string;
2779
- /**
2780
- * @remarks
2781
- * Text label of the item.
2782
- *
2783
- */
2784
- readonly label: string;
2785
- /**
2786
- * @remarks
2787
- * Modify enabled state of the item.
2788
- *
2789
- */
2790
- setEnabled: (enabled: boolean) => void;
2791
- }
2792
-
2793
- /**
2794
- * Properties required to create an Action Bar item.
2795
- */
2796
- export interface IActionBarItemCreationParams {
2797
- /**
2798
- * @remarks
2799
- * Initial enabled state of the item. If not defined, default
2800
- * is true.
2801
- *
2802
- */
2803
- enabled?: boolean;
2804
- /**
2805
- * @remarks
2806
- * Icon resource for the item.
2807
- *
2808
- */
2809
- icon: string;
2810
- /**
2811
- * @remarks
2812
- * Text label for item.
2813
- *
2814
- */
2815
- label: string;
2816
- /**
2817
- * @remarks
2818
- * Tooltip description for the item.
2819
- *
2820
- */
2821
- tooltipDescription?: string;
2822
- /**
2823
- * @remarks
2824
- * Tooltip title for the item.
2825
- *
2826
- */
2827
- tooltipTitle?: string;
2828
- }
2829
-
2830
2550
  /**
2831
2551
  * Simple abstraction for disposable objects.
2832
2552
  */
@@ -2904,12 +2624,6 @@ export interface IMenu {
2904
2624
  *
2905
2625
  */
2906
2626
  checked?: boolean;
2907
- /**
2908
- * @remarks
2909
- * The menu will be in either an enabled or disabled state
2910
- *
2911
- */
2912
- enabled: boolean;
2913
2627
  /**
2914
2628
  * @remarks
2915
2629
  * Unique ID for the menu
@@ -2968,12 +2682,6 @@ export interface IMenuCreationParams {
2968
2682
  *
2969
2683
  */
2970
2684
  displayStringId?: string;
2971
- /**
2972
- * @remarks
2973
- * Whether the menu should be enabled or disabled
2974
- *
2975
- */
2976
- enabled?: boolean;
2977
2685
  /**
2978
2686
  * @remarks
2979
2687
  * The name of the menu
@@ -3177,11 +2885,6 @@ export interface IPropertyItemOptionsButton extends IPropertyItemOptions {
3177
2885
  variant?: ButtonVariant;
3178
2886
  }
3179
2887
 
3180
- // @ts-ignore Class inheritance allowed for native defined classes
3181
- export interface IPropertyItemOptionsColorPicker extends IPropertyItemOptions {
3182
- showAlpha?: boolean;
3183
- }
3184
-
3185
2888
  // @ts-ignore Class inheritance allowed for native defined classes
3186
2889
  export interface IPropertyItemOptionsDataPicker extends IPropertyItemOptions {
3187
2890
  /**
@@ -3391,16 +3094,6 @@ export interface IPropertyPane {
3391
3094
  },
3392
3095
  'EMPTY'
3393
3096
  >;
3394
- /**
3395
- * @remarks
3396
- * Adds a color picker item to the pane.
3397
- *
3398
- */
3399
- addColorPicker<T extends PropertyBag, Prop extends keyof T & string>(
3400
- obj: T,
3401
- property: Prop,
3402
- options?: IPropertyItemOptionsColorPicker,
3403
- ): IPropertyItem<T, Prop>;
3404
3097
  /**
3405
3098
  * @remarks
3406
3099
  * Adds an divider item to the pane.
@@ -3610,127 +3303,46 @@ export interface IRegisterExtensionOptionalParameters {
3610
3303
  * the editor evolves.
3611
3304
  */
3612
3305
  export interface ISimpleTool {
3613
- /**
3614
- * @remarks
3615
- * Get a reference to the menu component that was automatically
3616
- * created for the tool This generally only happens if the tool
3617
- * is a global tool (i.e. has a pane and does not have a tool
3618
- * rail component) In this case a menu item is automatically
3619
- * created and some visibility controls are inserted. If you
3620
- * have additional menu options you want to add, this is the
3621
- * ideal control to add children to
3622
- *
3623
- */
3624
3306
  get menu(): IMenu | undefined;
3625
- /**
3626
- * @remarks
3627
- * Get the tool name
3628
- *
3629
- */
3630
3307
  get name(): string;
3631
- /**
3632
- * @remarks
3633
- * Get a reference to the root (primary) property pane
3634
- * component - if no component was requested, this function
3635
- * will throw an error
3636
- *
3637
- */
3638
3308
  get pane(): ISimpleToolPaneComponent;
3639
- /**
3640
- * @remarks
3641
- * Get a reference to the IPlayerUISession. This is the primary
3642
- * interface to the editor UI and all of the editor extension
3643
- * controls
3644
- *
3645
- */
3646
3309
  get session(): IPlayerUISession;
3647
- /**
3648
- * @remarks
3649
- * Get a reference to the status bar component - if no
3650
- * component was requested, this function will throw an error
3651
- *
3652
- */
3653
3310
  get statusBar(): ISimpleToolStatusBarComponent;
3654
- /**
3655
- * @remarks
3656
- * Get a reference to the tool rail component - if no component
3657
- * was requested, this function will throw an error
3658
- *
3659
- */
3660
3311
  get toolRail(): ISimpleToolRailComponent;
3661
3312
  /**
3662
3313
  * @remarks
3663
- * Find a pane or subpane by it's unique ID.
3664
- *
3665
3314
  */
3666
3315
  findPane(idString: string): ISimpleToolPaneComponent | undefined;
3667
3316
  /**
3668
3317
  * @remarks
3669
- * Hide a particular pane or subpane by it's unique ID. If no
3670
- * ID is provided (or cannot be found) the function will throw
3671
- * an error Although the parent pane is used to execute the
3672
- * visibility request, the hidePane function will NOT affect
3673
- * the visibility of any sibling panes -- so it is possible to
3674
- * hide all of the child panes of a parent using this function
3675
- *
3676
3318
  */
3677
3319
  hidePane(idString?: string): void;
3678
3320
  /**
3679
3321
  * @remarks
3680
- * Send a tagged Debug log message to the console. The tag will
3681
- * contain the tool name
3682
- *
3683
3322
  */
3684
3323
  logDebug(message: string): void;
3685
3324
  /**
3686
3325
  * @remarks
3687
- * Send a tagged Error log message to the console. The tag will
3688
- * contain the tool name
3689
- *
3690
3326
  */
3691
3327
  logError(message: string): void;
3692
3328
  /**
3693
3329
  * @remarks
3694
- * Send a tagged Informational log message to the console. The
3695
- * tag will contain the tool name
3696
- *
3697
3330
  */
3698
3331
  logInfo(message: string): void;
3699
3332
  /**
3700
3333
  * @remarks
3701
- * Send a tagged Warning log message to the console. The tag
3702
- * will contain the tool name
3703
- *
3704
3334
  */
3705
3335
  logWarn(message: string): void;
3706
3336
  /**
3707
3337
  * @remarks
3708
- * Show a particular pane or subpane by it's unique ID. If no
3709
- * ID is provided (or cannot be found) the function will throw
3710
- * an error Note that the showPane function (when used with a
3711
- * child pane) will use the parent pane to execute the
3712
- * visibility request. In this case, if the child panes are
3713
- * marked as mututally exclusive, then the siblings of the
3714
- * requested pane will be hidden
3715
- *
3716
3338
  */
3717
3339
  showPane(idString?: string): void;
3718
3340
  /**
3719
3341
  * @remarks
3720
- * Much like the showPane function, but will hide all other
3721
- * panes that are not the requested pane irrespective of the
3722
- * exclusivity setting
3723
- *
3724
3342
  */
3725
3343
  showPaneExclusively(idString: string): void;
3726
3344
  /**
3727
3345
  * @remarks
3728
- * A teardown function implemented by the ISimpleTool
3729
- * implementation, and is called by the system during editor
3730
- * extension shutdown. Don't override this function - instead,
3731
- * implement the onTeardown event in the ISimpleToolOptions
3732
- * structure
3733
- *
3734
3346
  */
3735
3347
  teardown(): void;
3736
3348
  }
@@ -3749,61 +3361,12 @@ export interface ISimpleToolKeyPair {
3749
3361
  * simple tool, and the optional components that are desired.
3750
3362
  */
3751
3363
  export interface ISimpleToolOptions {
3752
- /**
3753
- * @remarks
3754
- * A key binding that will activate the tool. Note that if the
3755
- * tool is a modal tool, then the key binding will be tied to
3756
- * the tool rail activation, and appear as a tooltip on the
3757
- * tool rail button. If the tool is a global tool, then the key
3758
- * binding will be tied to a menu item in the View menu, and
3759
- * appear as a stateful menu item which will control the pane
3760
- * visibility. If there's no pane required, then the key
3761
- * binding is ignored
3762
- *
3763
- */
3764
3364
  activationKeyBinding?: ISimpleToolKeyPair;
3765
- /**
3766
- * @remarks
3767
- * The name of the tool. This will be used to identify the tool
3768
- * in the UI and logs and will be used in the View \> [Tool
3769
- * Name] menu item (if it's a global tool)
3770
- *
3771
- */
3772
3365
  name: string;
3773
- /**
3774
- * @remarks
3775
- * The finalize function is executed after each of the
3776
- * components have been created and finalized during
3777
- * construction
3778
- *
3779
- */
3780
3366
  onFinalize?: (tool: ISimpleTool) => void;
3781
- /**
3782
- * @remarks
3783
- * The teardown function is executed when the tool is being
3784
- * torn down and only after the individual components have
3785
- * executed their own teardown functions
3786
- *
3787
- */
3788
3367
  onTeardown?: (tool: ISimpleTool) => void;
3789
- /**
3790
- * @remarks
3791
- * The options structure for an optional property pane
3792
- * component
3793
- *
3794
- */
3795
3368
  propertyPaneOptions?: ISimpleToolPaneOptions;
3796
- /**
3797
- * @remarks
3798
- * The options structure for an optional status bar component
3799
- *
3800
- */
3801
3369
  statusBarOptions?: ISimpleToolStatusBarOptions;
3802
- /**
3803
- * @remarks
3804
- * The options structure for an optional tool rail component
3805
- *
3806
- */
3807
3370
  toolRailOptions?: ISimpleToolRailOptions;
3808
3371
  }
3809
3372
 
@@ -3822,83 +3385,26 @@ export interface ISimpleToolOptions {
3822
3385
  * to the creator/user)
3823
3386
  */
3824
3387
  export interface ISimpleToolPaneComponent {
3825
- /**
3826
- * @remarks
3827
- * Get a list of the unique ID's of all of the child panes
3828
- *
3829
- */
3830
3388
  get childPaneList(): string[];
3831
- /**
3832
- * @remarks
3833
- * Get the unique ID of the pane
3834
- *
3835
- */
3836
3389
  get id(): string;
3837
- /**
3838
- * @remarks
3839
- * Check the visibility of the pane
3840
- *
3841
- */
3842
3390
  get isVisible(): boolean;
3843
- /**
3844
- * @remarks
3845
- * Get a reference to actual property pane implementation that
3846
- * was constructed by the tool. This reference is used to
3847
- * construct the UI components that are displayed in the pane.
3848
- *
3849
- */
3850
3391
  get pane(): IPropertyPane;
3851
- /**
3852
- * @remarks
3853
- * Get a reference to the IPlayerUISession. This is the primary
3854
- * interface to the editor UI and all of the editor extension
3855
- * controls
3856
- *
3857
- */
3858
3392
  get session(): IPlayerUISession;
3859
- /**
3860
- * @remarks
3861
- * Get a reference to the parent tool.
3862
- *
3863
- */
3864
3393
  get simpleTool(): ISimpleTool;
3865
3394
  /**
3866
3395
  * @remarks
3867
- * Find a pane reference by unique ID
3868
- *
3869
3396
  */
3870
3397
  findPane(idString: string): ISimpleToolPaneComponent | undefined;
3871
3398
  /**
3872
3399
  * @remarks
3873
- * Hide the pane. Although the parent pane is used to execute
3874
- * the visibility request, the hidePane function will NOT
3875
- * affect the visibility of any sibling panes -- so it is
3876
- * possible to hide all of the child panes of a parent using
3877
- * this function
3878
- *
3879
3400
  */
3880
3401
  hidePane(): void;
3881
3402
  /**
3882
3403
  * @remarks
3883
- * This causes the reconstruction of the pane (and the child
3884
- * panes) as if the tool was being constructed for the first
3885
- * time. This is unfortunately necessary until such time that
3886
- * all of our UI components are able to communicate dynamically
3887
- * with their client counterparts. Certain controls require a
3888
- * full teardown and reconstruction to properly update their
3889
- * state. This is undergoing code changes and should become
3890
- * unnecessary in the future.
3891
- *
3892
3404
  */
3893
3405
  reconstructPane(): void;
3894
3406
  /**
3895
3407
  * @remarks
3896
- * Show the pane. Note, if this is a sub-pane, then this
3897
- * function will ask the parent for permission to show, and may
3898
- * result in the visibility of any sibling panes to change as a
3899
- * result (depending on the `mutually exclusive visibility`
3900
- * flag)
3901
- *
3902
3408
  */
3903
3409
  showPane(): void;
3904
3410
  }
@@ -3920,85 +3426,22 @@ export interface ISimpleToolPaneComponent {
3920
3426
  * pane to finalize itself.
3921
3427
  */
3922
3428
  export interface ISimpleToolPaneOptions {
3923
- /**
3924
- * @remarks
3925
- * The id of the child pane that should be visible when the
3926
- * parent pane is first shown, or the editor tool is
3927
- * constructed and finalized
3928
- *
3929
- */
3930
3429
  childPaneInitiallyVisible?: string;
3931
- /**
3932
- * @remarks
3933
- * An optional array of child panes. These panes are set up
3934
- * exactly the same as the top level pane, but are displayed as
3935
- * children inside the parent pane.
3936
- *
3937
- */
3938
3430
  childPanes?: ISimpleToolPaneOptions[];
3939
- /**
3940
- * @remarks
3941
- * An optional flag to indicate whether the child panes are
3942
- * mutually exclusive. If this is true, then only one child
3943
- * pane can be visible at a time. If this is false, then
3944
- * multiple child panes can be visible at the same time.
3945
- * Visibility is controlled either through `showPane` or
3946
- * `hidePane` functions of the `ISimpleToolPaneComponent` or
3947
- * through the visibility methods in the top level tool
3948
- * (`ISimpleTool`)
3949
- *
3950
- */
3951
3431
  childPanesMutuallyExclusive?: boolean;
3952
- /**
3953
- * @remarks
3954
- * The unique identifier for this pane. This is used to
3955
- * identify the pane in the tool's pane hierarchy.
3956
- *
3957
- */
3958
3432
  id: string;
3959
3433
  onBeginFinalize?: (pane: ISimpleToolPaneComponent) => void;
3960
3434
  onEndFinalize?: (pane: ISimpleToolPaneComponent) => void;
3961
3435
  onHide?: (pane: ISimpleToolPaneComponent) => void;
3962
3436
  onShow?: (pane: ISimpleToolPaneComponent) => void;
3963
3437
  onTeardown?: (pane: ISimpleToolPaneComponent) => void;
3964
- /**
3965
- * @remarks
3966
- * The title of the pane. This will be displayed in the title
3967
- * bar of the pane.
3968
- *
3969
- */
3970
3438
  titleAltText: string;
3971
- /**
3972
- * @remarks
3973
- * The string id of the title of the pane. This will be
3974
- * displayed in the title bar of the pane if it exists in the
3975
- * language file, otherwise the titleAltText will be used.
3976
- *
3977
- */
3978
3439
  titleStringId?: string;
3979
3440
  }
3980
3441
 
3981
3442
  export interface ISimpleToolRailComponent {
3982
- /**
3983
- * @remarks
3984
- * Get a reference to the IPlayerUISession. This is the primary
3985
- * interface to the editor UI and all of the editor extension
3986
- * controls
3987
- *
3988
- */
3989
3443
  get session(): IPlayerUISession;
3990
- /**
3991
- * @remarks
3992
- * Get a reference to the parent tool.
3993
- *
3994
- */
3995
3444
  get simpleTool(): ISimpleTool;
3996
- /**
3997
- * @remarks
3998
- * Get the implementation interface of the underlying tool rail
3999
- * component
4000
- *
4001
- */
4002
3445
  get toolRail(): IModalTool;
4003
3446
  }
4004
3447
 
@@ -4016,47 +3459,14 @@ export interface ISimpleToolRailComponent {
4016
3459
  * gameplay interaction
4017
3460
  */
4018
3461
  export interface ISimpleToolRailOptions {
4019
- /**
4020
- * @remarks
4021
- * The text for the tool description
4022
- *
4023
- */
4024
3462
  displayAltText: string;
4025
- /**
4026
- * @remarks
4027
- * The string ID for the tool description if it is in the
4028
- * localization language file.
4029
- *
4030
- */
4031
3463
  displayStringId?: string;
4032
- /**
4033
- * @remarks
4034
- * The icon for the tool rail button. This is generally a URL
4035
- * to an image file in the editor extension resource pack e.g.
4036
- * `pack://textures/my-tool-icon.png`
4037
- *
4038
- */
4039
3464
  icon: string;
4040
3465
  onActivate?: (component: ISimpleToolRailComponent) => void;
4041
3466
  onDeactivate?: (component: ISimpleToolRailComponent) => void;
4042
3467
  onFinalize?: (component: ISimpleToolRailComponent) => void;
4043
3468
  onTeardown?: (component: ISimpleToolRailComponent) => void;
4044
- /**
4045
- * @remarks
4046
- * The tooltip string for the tool rail button. Note: if an
4047
- * activation key binding was added to `ISimpleToolOptions`,
4048
- * then the key binding will be appended to the tooltip string.
4049
- *
4050
- */
4051
3469
  tooltipAltText: string;
4052
- /**
4053
- * @remarks
4054
- * The string ID for the tooltip string if it is in the
4055
- * localization language file. Note: if an activation key
4056
- * binding was added to `ISimpleToolOptions`, then the key
4057
- * binding will be appended to the tooltip string.
4058
- *
4059
- */
4060
3470
  tooltipStringId?: string;
4061
3471
  }
4062
3472
 
@@ -4073,36 +3483,13 @@ export interface ISimpleToolStatusBarComponent {
4073
3483
  * status bar item for a simple tool.
4074
3484
  */
4075
3485
  export interface ISimpleToolStatusBarOptions {
4076
- /**
4077
- * @remarks
4078
- * The alignment of the status bar item within the parent
4079
- * status bar container
4080
- *
4081
- */
4082
3486
  alignment: EditorStatusBarAlignment;
4083
- /**
4084
- * @remarks
4085
- * The text for the status bar item
4086
- *
4087
- */
4088
3487
  displayAltText: string;
4089
3488
  onFinalize?: (statusBar: ISimpleToolStatusBarComponent) => void;
4090
3489
  onHide?: (statusBar: ISimpleToolStatusBarComponent) => void;
4091
3490
  onShow?: (statusBar: ISimpleToolStatusBarComponent) => void;
4092
3491
  onTeardown?: (statusBar: ISimpleToolStatusBarComponent) => void;
4093
- /**
4094
- * @remarks
4095
- * The size of the status bar item within the parent status bar
4096
- * container
4097
- *
4098
- */
4099
3492
  size: number;
4100
- /**
4101
- * @remarks
4102
- * Determine the status bar visibility based on the existence
4103
- * and visibility of the tool's root property pane
4104
- *
4105
- */
4106
3493
  visibility?: SimpleToolStatusBarVisibility;
4107
3494
  }
4108
3495
 
@@ -4189,20 +3576,6 @@ export declare function executeLargeOperation(
4189
3576
  selection: Selection,
4190
3577
  operation: (blockLocation: minecraftserver.Vector3) => void,
4191
3578
  ): Promise<void>;
4192
- /**
4193
- * @remarks
4194
- * Executes an operation over a BlockLocationIterator via
4195
- * chunks to allow splitting operation over multiple game ticks
4196
- *
4197
- * @param blockLocationIterator
4198
- * the selection to iterator over
4199
- * @param operation
4200
- * the operation to apply over each block location
4201
- */
4202
- export declare function executeLargeOperationFromIterator(
4203
- blockLocationIterator: minecraftserver.BlockLocationIterator,
4204
- operation: (blockLocation: minecraftserver.Vector3) => void,
4205
- ): Promise<void>;
4206
3579
  /**
4207
3580
  * @remarks
4208
3581
  * Returns a string array of the default block types for the
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-editor",
3
- "version": "0.1.0-beta.1.21.10-preview.23",
3
+ "version": "0.1.0-beta.1.21.2-stable",
4
4
  "description": "",
5
5
  "contributors": [
6
6
  {
@@ -14,7 +14,7 @@
14
14
  ],
15
15
  "dependencies": {
16
16
  "@minecraft/common": "^1.0.0",
17
- "@minecraft/server": "^1.13.0-beta.1.21.10-preview.23"
17
+ "@minecraft/server": "^1.12.0-beta.1.21.2-stable"
18
18
  },
19
19
  "license": "MIT"
20
20
  }