@minecraft/server-editor 0.1.0-beta.1.21.100-preview.22 → 0.1.0-beta.1.21.100-preview.24

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 +102 -10
  2. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -927,6 +927,27 @@ export declare enum LayoutDirection {
927
927
  Horizontal = 1,
928
928
  }
929
929
 
930
+ export enum LogChannel {
931
+ /**
932
+ * @remarks
933
+ * Regular message channel.
934
+ *
935
+ */
936
+ Message = 1,
937
+ /**
938
+ * @remarks
939
+ * Toast channel.
940
+ *
941
+ */
942
+ Toast = 2,
943
+ /**
944
+ * @remarks
945
+ * Regular message and toast channels.
946
+ *
947
+ */
948
+ All = 3,
949
+ }
950
+
930
951
  /**
931
952
  * Mouse device action categories
932
953
  */
@@ -1235,6 +1256,11 @@ export type ActivationFunctionType<PerPlayerStorageType> = (
1235
1256
  uiSession: IPlayerUISession<PerPlayerStorageType>,
1236
1257
  ) => IDisposable[];
1237
1258
 
1259
+ export type AudioSettingsPropertyTypeMap = {
1260
+ [AudioSettingsProperty.IsMusicMuted]?: boolean;
1261
+ [AudioSettingsProperty.AreSoundsMuted]?: boolean;
1262
+ };
1263
+
1238
1264
  /**
1239
1265
  * Possible tooltip types
1240
1266
  */
@@ -1487,22 +1513,22 @@ export type UnregisterInputBindingCallback = () => void;
1487
1513
 
1488
1514
  export class AudioSettings {
1489
1515
  private constructor();
1490
- get(property: AudioSettingsProperty): boolean | number | undefined;
1491
- getAll(): Record<string, boolean | number>;
1516
+ get<T extends keyof AudioSettingsPropertyTypeMap>(property: T): AudioSettingsPropertyTypeMap[T] | undefined;
1517
+ getAll(): AudioSettingsPropertyTypeMap;
1492
1518
  /**
1493
1519
  * @remarks
1494
1520
  * This function can't be called in read-only mode.
1495
1521
  *
1496
1522
  * @throws This function can throw errors.
1497
1523
  */
1498
- set(property: AudioSettingsProperty, value: boolean | number): void;
1524
+ set<T extends keyof AudioSettingsPropertyTypeMap>(property: T, value: AudioSettingsPropertyTypeMap[T]): void;
1499
1525
  /**
1500
1526
  * @remarks
1501
1527
  * This function can't be called in read-only mode.
1502
1528
  *
1503
1529
  * @throws This function can throw errors.
1504
1530
  */
1505
- setAll(properties: Record<string, boolean | number>): void;
1531
+ setAll(properties: AudioSettingsPropertyTypeMap): void;
1506
1532
  }
1507
1533
 
1508
1534
  /**
@@ -2034,7 +2060,16 @@ export declare class ConeBrushShape extends BrushShape {
2034
2060
  * Constructs a new instance of the `ConeBrushShape` class
2035
2061
  *
2036
2062
  */
2037
- constructor(settings?: { uniform?: boolean; radius?: number; width?: number; height?: number; depth?: number });
2063
+ constructor(settings?: {
2064
+ uniform?: boolean;
2065
+ radius?: number;
2066
+ width?: number;
2067
+ height?: number;
2068
+ depth?: number;
2069
+ xRotation?: number;
2070
+ yRotation?: number;
2071
+ zRotation?: number;
2072
+ });
2038
2073
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2039
2074
  createShape(): RelativeVolumeListBlockVolume;
2040
2075
  }
@@ -2053,6 +2088,9 @@ export declare class CuboidBrushShape extends BrushShape {
2053
2088
  height?: number;
2054
2089
  depth?: number;
2055
2090
  minLength?: number;
2091
+ xRotation?: number;
2092
+ yRotation?: number;
2093
+ zRotation?: number;
2056
2094
  });
2057
2095
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2058
2096
  createShape(): RelativeVolumeListBlockVolume;
@@ -2283,6 +2321,9 @@ export declare class CylinderBrushShape extends BrushShape {
2283
2321
  height?: number;
2284
2322
  depth?: number;
2285
2323
  minRadius?: number;
2324
+ xRotation?: number;
2325
+ yRotation?: number;
2326
+ zRotation?: number;
2286
2327
  });
2287
2328
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2288
2329
  createShape(): RelativeVolumeListBlockVolume;
@@ -2415,6 +2456,9 @@ export declare class EllipsoidBrushShape extends BrushShape {
2415
2456
  height?: number;
2416
2457
  depth?: number;
2417
2458
  minRadius?: number;
2459
+ xRotation?: number;
2460
+ yRotation?: number;
2461
+ zRotation?: number;
2418
2462
  });
2419
2463
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2420
2464
  createShape(): RelativeVolumeListBlockVolume;
@@ -2945,7 +2989,15 @@ export declare class PyramidBrushShape extends BrushShape {
2945
2989
  * Constructs a new instance of the `PyramidBrushShape` class
2946
2990
  *
2947
2991
  */
2948
- constructor(settings?: { uniform?: boolean; width?: number; height?: number; depth?: number });
2992
+ constructor(settings?: {
2993
+ uniform?: boolean;
2994
+ width?: number;
2995
+ height?: number;
2996
+ depth?: number;
2997
+ xRotation?: number;
2998
+ yRotation?: number;
2999
+ zRotation?: number;
3000
+ });
2949
3001
  createSettingsPane(parentPane: IPropertyPane, onSettingsChange?: () => void): ISubPanePropertyItem;
2950
3002
  createShape(): RelativeVolumeListBlockVolume;
2951
3003
  }
@@ -6402,32 +6454,58 @@ export interface IPlayerLogger {
6402
6454
  *
6403
6455
  * @param message
6404
6456
  * Message content
6457
+ * @param props
6458
+ * Optional player log properties
6405
6459
  */
6406
- debug(message: string): void;
6460
+ debug(message: string, props?: IPlayerLoggerProperties): void;
6407
6461
  /**
6408
6462
  * @remarks
6409
6463
  * Dispatch a player log message with Error log level
6410
6464
  *
6411
6465
  * @param message
6412
6466
  * Message content
6467
+ * @param props
6468
+ * Optional player log properties
6413
6469
  */
6414
- error(message: string): void;
6470
+ error(message: string, props?: IPlayerLoggerProperties): void;
6415
6471
  /**
6416
6472
  * @remarks
6417
6473
  * Dispatch a player log message with Info log level
6418
6474
  *
6419
6475
  * @param message
6420
6476
  * Message content
6477
+ * @param props
6478
+ * Optional player log properties
6421
6479
  */
6422
- info(message: string): void;
6480
+ info(message: string, props?: IPlayerLoggerProperties): void;
6423
6481
  /**
6424
6482
  * @remarks
6425
6483
  * Dispatch a player log message with Warning log level
6426
6484
  *
6427
6485
  * @param message
6428
6486
  * Message content
6487
+ * @param props
6488
+ * Optional player log properties
6489
+ */
6490
+ warning(message: string, props?: IPlayerLoggerProperties): void;
6491
+ }
6492
+
6493
+ /**
6494
+ * Player Logger Properties.
6495
+ */
6496
+ export interface IPlayerLoggerProperties {
6497
+ /**
6498
+ * @remarks
6499
+ * A log channel mask, default is Message
6500
+ *
6429
6501
  */
6430
- warning(message: string): void;
6502
+ channelMask: LogChannel;
6503
+ /**
6504
+ * @remarks
6505
+ * A player log sub message for the toast channel
6506
+ *
6507
+ */
6508
+ subMessage: string;
6431
6509
  }
6432
6510
 
6433
6511
  /**
@@ -7433,6 +7511,13 @@ export interface IVector3PropertyItemOptions extends IPropertyItemOptionsBase {
7433
7511
  * server->client messaging and broadcasts.
7434
7512
  */
7435
7513
  export interface LogProperties {
7514
+ /**
7515
+ * @remarks
7516
+ * Display the log message to a log channel. If no channel is
7517
+ * specified, default channel is regular message.
7518
+ *
7519
+ */
7520
+ channelMask?: LogChannel;
7436
7521
  /**
7437
7522
  * @remarks
7438
7523
  * Direct a log message to a specific player. If no player is
@@ -7440,6 +7525,13 @@ export interface LogProperties {
7440
7525
  *
7441
7526
  */
7442
7527
  player?: minecraftserver.Player;
7528
+ /**
7529
+ * @remarks
7530
+ * Message to be shown under the message when toast channel is
7531
+ * selected.
7532
+ *
7533
+ */
7534
+ subMessage?: string;
7443
7535
  /**
7444
7536
  * @remarks
7445
7537
  * Add additional tags to the log message which can be used by
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@minecraft/server-editor",
3
- "version": "0.1.0-beta.1.21.100-preview.22",
3
+ "version": "0.1.0-beta.1.21.100-preview.24",
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": "^2.2.0-beta.1.21.100-preview.22"
17
+ "@minecraft/server": "^2.2.0-beta.1.21.100-preview.24"
18
18
  },
19
19
  "license": "MIT"
20
20
  }