@minecraft/server-editor 0.1.0-beta.1.21.60-preview.24 → 0.1.0-beta.1.21.60-preview.27

package/index.d.ts

@@ -27,8 +27,10 @@ import * as minecraftserver from '@minecraft/server';
  * onExecute handler of an action.
  */
 export declare enum ActionTypes {
+    ContinuousAction = 'ContinuousAction',
     MouseRayCastAction = 'MouseRayCastAction',
     NoArgsAction = 'NoArgsAction',
+    StatefulAction = 'StatefulAction',
 }
 
 export enum Axis {
@@ -48,6 +50,15 @@ export enum BlockPaletteItemType {
     Probability = 1,
 }
 
+/**
+ * The possible operation types supported by BlockTable
+ * property item.
+ */
+export declare enum BlockTableOperationType {
+    Deselect = 'deselect',
+    Replace = 'replace',
+}
+
 /**
  * The possible variants of a bool.
  */
@@ -84,11 +95,24 @@ export declare enum ComboBoxPropertyItemDataType {
     Entity = 2,
 }
 
+/**
+ * Execution state of the continuous action
+ */
+export declare enum ContinuousActionState {
+    Begin = 0,
+    Repeat = 1,
+    End = 2,
+}
+
 /**
  * Predefined action bar items
  */
 export declare enum CoreActionBarItemType {
+    Export = 'editor:actionBarItem:export',
+    Locate = 'editor:actionBarItem:locate',
+    Playtest = 'editor:actionBarItem:playtest',
     Redo = 'editor:actionBarItem:redo',
+    Settings = 'editor:actionBarItem:settings',
     Undo = 'editor:actionBarItem:undo',
 }
 
@@ -234,6 +258,7 @@ export enum GamePublishSetting {
  * properties.
  */
 export enum GraphicsSettingsProperty {
+    NightVision = 'NightVision',
     ShowChunkBoundaries = 'ShowChunkBoundaries',
     ShowCompass = 'ShowCompass',
     /**
@@ -958,6 +983,7 @@ export enum ProjectExportType {
  */
 export declare enum PropertyItemType {
     BlockList = 'editorUI:BlockList',
+    BlockTable = 'editorUI:BlockTable',
     Boolean = 'editorUI:Boolean',
     Button = 'editorUI:Button',
     ColorPicker = 'editorUI:ColorPicker',
@@ -1091,7 +1117,7 @@ export enum WidgetMouseButtonActionType {
 /**
  * Full set of all possible raw actions
  */
-export type Action = NoArgsAction | MouseRayCastAction;
+export type Action = NoArgsAction | MouseRayCastAction | StatefulAction | ContinuousAction;
 
 /**
  * All actions have a unique identifier. Identifiers are
@@ -1111,6 +1137,16 @@ export type ActivationFunctionType<PerPlayerStorageType> = (
     uiSession: IPlayerUISession<PerPlayerStorageType>,
 ) => IDisposable[];
 
+/**
+ * An action that continues to execute after activation
+ */
+export type ContinuousAction = {
+    readonly actionType: ActionTypes.ContinuousAction;
+    readonly onExecute: (state: ContinuousActionState, repeatCount: number) => void;
+    repeatDelay?: number;
+    repeatInterval?: number;
+};
+
 /**
  * A generic handler for an event sink.
  */
@@ -1123,6 +1159,7 @@ export type GraphicsSettingsPropertyTypeMap = {
     [GraphicsSettingsProperty.ShowInvisibleBlocks]?: boolean;
     [GraphicsSettingsProperty.ShowChunkBoundaries]?: boolean;
     [GraphicsSettingsProperty.ShowCompass]?: boolean;
+    [GraphicsSettingsProperty.NightVision]?: boolean;
 };
 
 /**
@@ -1265,7 +1302,7 @@ export declare type MouseProps = {
  * from the users mouse click in the viewport.
  */
 export type MouseRayCastAction = {
-    actionType: ActionTypes.MouseRayCastAction;
+    readonly actionType: ActionTypes.MouseRayCastAction;
     readonly onExecute: (mouseRay: Ray, mouseProps: MouseProps) => void;
 };
 
@@ -1274,7 +1311,7 @@ export type MouseRayCastAction = {
  * execute
  */
 export type NoArgsAction = {
-    actionType: ActionTypes.NoArgsAction;
+    readonly actionType: ActionTypes.NoArgsAction;
     readonly onExecute: () => void;
 };
 
@@ -1330,10 +1367,21 @@ export type SpeedSettingsPropertyTypeMap = {
     [SpeedSettingsProperty.FlySpeedMultiplier]?: number;
 };
 
+/**
+ * An action which returns the activation state.
+ */
+export type StatefulAction = {
+    readonly actionType: ActionTypes.StatefulAction;
+    readonly onExecute: (active: boolean) => void;
+};
+
 /**
  * Full set of all possible keyboard actions
  */
-export type SupportedKeyboardActionTypes = RegisteredAction<NoArgsAction>;
+export type SupportedKeyboardActionTypes =
+    | RegisteredAction<NoArgsAction>
+    | RegisteredAction<StatefulAction>
+    | RegisteredAction<ContinuousAction>;
 
 /**
  * Full set of all possible mouse actions
@@ -1542,7 +1590,7 @@ export class BrushShapeManager {
      *
      * {@link Error}
      */
-    beginPainting(onComplete: (arg: PaintCompletionState) => void): void;
+    beginPainting(onComplete: (arg0: PaintCompletionState) => void): void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -1640,7 +1688,7 @@ export class BrushShapeManager {
      *
      * {@link Error}
      */
-    singlePaint(onComplete: (arg: PaintCompletionState) => void): void;
+    singlePaint(onComplete: (arg0: PaintCompletionState) => void): void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -1682,7 +1730,7 @@ export class ClipboardChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    subscribe(callback: (arg: ClipboardChangeAfterEvent) => void): (arg: ClipboardChangeAfterEvent) => void;
+    subscribe(callback: (arg0: ClipboardChangeAfterEvent) => void): (arg0: ClipboardChangeAfterEvent) => void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -1690,7 +1738,7 @@ export class ClipboardChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    unsubscribe(callback: (arg: ClipboardChangeAfterEvent) => void): void;
+    unsubscribe(callback: (arg0: ClipboardChangeAfterEvent) => void): void;
 }
 
 /**
@@ -1885,7 +1933,7 @@ export class CurrentThemeChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    subscribe(callback: (arg: CurrentThemeChangeAfterEvent) => void): (arg: CurrentThemeChangeAfterEvent) => void;
+    subscribe(callback: (arg0: CurrentThemeChangeAfterEvent) => void): (arg0: CurrentThemeChangeAfterEvent) => void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -1893,7 +1941,7 @@ export class CurrentThemeChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    unsubscribe(callback: (arg: CurrentThemeChangeAfterEvent) => void): void;
+    unsubscribe(callback: (arg0: CurrentThemeChangeAfterEvent) => void): void;
 }
 
 export class CurrentThemeColorChangeAfterEvent {
@@ -1912,8 +1960,8 @@ export class CurrentThemeColorChangeAfterEventSignal {
      *
      */
     subscribe(
-        callback: (arg: CurrentThemeColorChangeAfterEvent) => void,
-    ): (arg: CurrentThemeColorChangeAfterEvent) => void;
+        callback: (arg0: CurrentThemeColorChangeAfterEvent) => void,
+    ): (arg0: CurrentThemeColorChangeAfterEvent) => void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -1921,7 +1969,7 @@ export class CurrentThemeColorChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    unsubscribe(callback: (arg: CurrentThemeColorChangeAfterEvent) => void): void;
+    unsubscribe(callback: (arg0: CurrentThemeColorChangeAfterEvent) => void): void;
 }
 
 /**
@@ -2058,6 +2106,7 @@ export class Cursor {
 
 export class CursorPropertiesChangeAfterEvent {
     private constructor();
+    readonly position?: CursorPosition;
     readonly properties: CursorProperties;
 }
 
@@ -2071,8 +2120,8 @@ export class CursorPropertyChangeAfterEventSignal {
      *
      */
     subscribe(
-        callback: (arg: CursorPropertiesChangeAfterEvent) => void,
-    ): (arg: CursorPropertiesChangeAfterEvent) => void;
+        callback: (arg0: CursorPropertiesChangeAfterEvent) => void,
+    ): (arg0: CursorPropertiesChangeAfterEvent) => void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2080,7 +2129,7 @@ export class CursorPropertyChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    unsubscribe(callback: (arg: CursorPropertiesChangeAfterEvent) => void): void;
+    unsubscribe(callback: (arg0: CursorPropertiesChangeAfterEvent) => void): void;
 }
 
 export class EditorStructureManager {
@@ -2518,7 +2567,7 @@ export class ModeChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    subscribe(callback: (arg: ModeChangeAfterEvent) => void): (arg: ModeChangeAfterEvent) => void;
+    subscribe(callback: (arg0: ModeChangeAfterEvent) => void): (arg0: ModeChangeAfterEvent) => void;
     /**
      * @remarks
      * Removes the specified callback from an editor mode change
@@ -2529,7 +2578,7 @@ export class ModeChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    unsubscribe(callback: (arg: ModeChangeAfterEvent) => void): void;
+    unsubscribe(callback: (arg0: ModeChangeAfterEvent) => void): void;
 }
 
 /**
@@ -2600,7 +2649,7 @@ export class PrimarySelectionChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    subscribe(callback: (arg: SelectionEventAfterEvent) => void): (arg: SelectionEventAfterEvent) => void;
+    subscribe(callback: (arg0: SelectionEventAfterEvent) => void): (arg0: SelectionEventAfterEvent) => void;
     /**
      * @remarks
      * This function can't be called in read-only mode.
@@ -2608,7 +2657,7 @@ export class PrimarySelectionChangeAfterEventSignal {
      * This function can be called in early-execution mode.
      *
      */
-    unsubscribe(callback: (arg: SelectionEventAfterEvent) => void): void;
+    unsubscribe(callback: (arg0: SelectionEventAfterEvent) => void): void;
 }
 
 export class PrimarySelectionChangedEvent {
@@ -2909,12 +2958,12 @@ export class SettingsManager {
 export class SettingsUIElement {
     readonly initialValue: boolean | number | string | minecraftserver.Vector3;
     readonly name: string;
-    readonly onChange: (arg: boolean | number | string | minecraftserver.Vector3) => void;
+    readonly onChange: (arg0: boolean | number | string | minecraftserver.Vector3) => void;
     readonly options: SettingsUIElementOptions;
     constructor(
         name: string,
         initialValue: boolean | number | string | minecraftserver.Vector3,
-        onChange: (arg: boolean | number | string | minecraftserver.Vector3) => void,
+        onChange: (arg0: boolean | number | string | minecraftserver.Vector3) => void,
         options?: SettingsUIElementOptions,
     );
 }
@@ -3135,8 +3184,8 @@ export class TransactionManager {
      * @throws This function can throw errors.
      */
     createUserDefinedTransactionHandler(
-        undoClosure: (arg: string) => void,
-        redoClosure: (arg: string) => void,
+        undoClosure: (arg0: string) => void,
+        redoClosure: (arg0: string) => void,
     ): UserDefinedTransactionHandlerId;
     /**
      * @remarks
@@ -3576,7 +3625,7 @@ export class Widget {
      *
      * {@link InvalidWidgetError}
      */
-    setStateChangeEvent(eventFunction?: (arg: WidgetStateChangeEventData) => void): void;
+    setStateChangeEvent(eventFunction?: (arg0: WidgetStateChangeEventData) => void): void;
 }
 
 export class WidgetComponentBase {
@@ -3636,7 +3685,7 @@ export class WidgetComponentBase {
      *
      * {@link InvalidWidgetComponentError}
      */
-    setStateChangeEvent(eventFunction?: (arg: WidgetComponentStateChangeEventData) => void): void;
+    setStateChangeEvent(eventFunction?: (arg0: WidgetComponentStateChangeEventData) => void): void;
 }
 
 // @ts-ignore Class inheritance allowed for native defined classes
@@ -4093,6 +4142,11 @@ export interface ClipboardWriteOptions {
     rotation?: minecraftserver.StructureRotation;
 }
 
+export interface CursorPosition {
+    FaceDirection: number;
+    Position: minecraftserver.Vector3;
+}
+
 /**
  * The CursorProperties interface is used to describe the
  * properties of the Editor 3D block cursor construct.
@@ -4381,6 +4435,106 @@ export interface IActionBarItemCreationParams {
     tooltipTitle?: string;
 }
 
+/**
+ * Block Table Entry info for block table property item
+ */
+export interface IBlockTableEntryInfo {
+    /**
+     * @remarks
+     * The quantity number of the same block in the selection.
+     *
+     */
+    count?: number;
+}
+
+/**
+ * A property item which supports Block Table properties
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IBlockTablePropertyItem extends IPropertyItemBase {
+    /**
+     * @remarks
+     * Create new or update an existing entry in the block table
+     *
+     * @param block
+     * a new entry in the block table.
+     * @param blockInfo
+     * block info for the entry in the block table.
+     */
+    addOrUpdateEntry(block: string | minecraftserver.BlockType, blockInfo: IBlockTableEntryInfo): void;
+    /**
+     * @remarks
+     * Delete entry in the block table, by block name
+     *
+     * @param block
+     * an entry in the block table.
+     */
+    deleteEntry(block: string): void;
+    /**
+     * @remarks
+     * Read entry from the block table, by block name
+     *
+     * @param block
+     * an entry in the block table.
+     */
+    getEntry(block: string | minecraftserver.BlockType): IBlockTableEntryInfo | undefined;
+    /**
+     * @remarks
+     * Updates title of the property item.
+     *
+     * @param title
+     * New title.
+     */
+    setTitle(title: LocalizedString): void;
+    /**
+     * @remarks
+     * Update the block table entries
+     *
+     * @param entries
+     * The new value for the block table.
+     */
+    updateEntries(entries: Map<string, IBlockTableEntryInfo>): void;
+}
+
+/**
+ * Properties of block table item
+ */
+// @ts-ignore Class inheritance allowed for native defined classes
+export interface IBlockTablePropertyItemOptions extends IPropertyItemOptionsBase {
+    /**
+     * @remarks
+     * Map of block entries in the block table.
+     *
+     */
+    entries?: Map<string, IBlockTableEntryInfo>;
+    /**
+     * @remarks
+     * If true label text will be hidden. It will be visible by
+     * default.
+     *
+     */
+    hiddenLabel?: boolean;
+    /**
+     * @remarks
+     * This callback is called when UI control operation is
+     * selected from the UI.
+     *
+     */
+    onOperationClick?: (block: string, operation: BlockTableOperationType) => void;
+    /**
+     * @remarks
+     * Localized title of the property item.
+     *
+     */
+    title?: LocalizedString;
+    /**
+     * @remarks
+     * Tooltip description of the property item.
+     *
+     */
+    tooltip?: LocalizedString;
+}
+
 /**
  * A property item which supports Vector3 properties
  */
@@ -5490,6 +5644,12 @@ export interface IPropertyPane {
         },
         'EMPTY'
     >;
+    /**
+     * @remarks
+     * Adds a block table to the pane.
+     *
+     */
+    addBlockTable(options?: IBlockTablePropertyItemOptions): IBlockTablePropertyItem;
     /**
      * @remarks
      */
@@ -6860,7 +7020,7 @@ export interface WeightedBlock {
 export interface WidgetComponentBaseOptions {
     lockToSurface?: boolean;
     offset?: minecraftserver.Vector3;
-    stateChangeEvent?: (arg: WidgetComponentStateChangeEventData) => void;
+    stateChangeEvent?: (arg0: WidgetComponentStateChangeEventData) => void;
     visible?: boolean;
 }
 
@@ -6912,7 +7072,7 @@ export interface WidgetCreateOptions {
     lockToSurface?: boolean;
     selectable?: boolean;
     snapToBlockLocation?: boolean;
-    stateChangeEvent?: (arg: WidgetStateChangeEventData) => void;
+    stateChangeEvent?: (arg0: WidgetStateChangeEventData) => void;
     visible?: boolean;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@minecraft/server-editor",
-  "version": "0.1.0-beta.1.21.60-preview.24",
+  "version": "0.1.0-beta.1.21.60-preview.27",
   "description": "",
   "contributors": [
     {
@@ -14,7 +14,7 @@
   ],
   "dependencies": {
     "@minecraft/common": "^1.0.0",
-    "@minecraft/server": "^1.18.0-beta.1.21.60-preview.24"
+    "@minecraft/server": "^1.18.0-beta.1.21.60-preview.27"
   },
   "license": "MIT"
 }