brs-js 2.0.4 → 2.0.7

package/src/types.ts

@@ -23,6 +23,22 @@ export type UnrealType =
   | UnrealByte
   | UnrealRotator;
 
+type UnrealTypeFromString<T> = T extends 'Class'
+  ? UnrealClass
+  : T extends 'Object'
+  ? UnrealObject
+  : T extends 'Boolean'
+  ? UnrealBoolean
+  : T extends 'Float'
+  ? UnrealFloat
+  : T extends 'Color'
+  ? UnrealColor
+  : T extends 'Byte'
+  ? UnrealByte
+  : T extends 'Rotator'
+  ? UnrealRotator
+  : UnrealType;
+
 export interface User {
   id: Uuid;
   name: string;
@@ -61,10 +77,18 @@ export interface AppliedComponent {
   [property: string]: UnrealType;
 }
 
-export interface DefinedComponents {
-  BCD_SpotLight?: {
+export interface UnknownComponents {
+  [component_name: string]: {
+    version: number;
+    brick_indices?: number[];
+    properties: { [property: string]: string };
+  };
+}
+
+export type KnownComponents = {
+  BCD_SpotLight: {
     version: 1;
-    brick_indices: number[];
+    brick_indices?: number[];
     properties: {
       Rotation: 'Rotator';
       InnerConeAngle: 'Float';
@@ -76,9 +100,9 @@ export interface DefinedComponents {
       bCastShadows: 'Boolean';
     };
   };
-  BCD_PointLight?: {
+  BCD_PointLight: {
     version: 1;
-    brick_indices: number[];
+    brick_indices?: number[];
     properties: {
       bMatchBrickShape: 'Boolean';
       Brightness: 'Float';
@@ -88,9 +112,9 @@ export interface DefinedComponents {
       bCastShadows: 'Boolean';
     };
   };
-  BCD_ItemSpawn?: {
+  BCD_ItemSpawn: {
     version: 1;
-    brick_indices: number[];
+    brick_indices?: number[];
     properties: {
       PickupClass: 'Class';
       bPickupEnabled: 'Boolean';
@@ -111,14 +135,14 @@ export interface DefinedComponents {
       PickupAnimationPhase: 'Float';
     };
   };
-  BCD_Interact?: {
+  BCD_Interact: {
     version: 1;
-    brick_indices: number[];
+    brick_indices?: number[];
     properties: { bPlayInteractSound: 'Boolean' };
   };
-  BCD_AudioEmitter?: {
+  BCD_AudioEmitter: {
     version: 1;
-    brick_indices: number[];
+    brick_indices?: number[];
     properties: {
       AudioDescriptor: 'Object';
       VolumeMultiplier: 'Float';
@@ -128,64 +152,19 @@ export interface DefinedComponents {
       bSpatialization: 'Boolean';
     };
   };
-  [component_name: string]: {
-    version: number;
-    brick_indices: number[];
-    properties: { [property: string]: string };
-  };
-}
+};
 
-export interface Components {
-  BCD_SpotLight?: {
-    Rotation: UnrealRotator;
-    InnerConeAngle: UnrealFloat;
-    OuterConeAngle: UnrealFloat;
-    Brightness: UnrealFloat;
-    Radius: UnrealFloat;
-    Color: UnrealColor;
-    bUseBrickColor: UnrealBoolean;
-    bCastShadows: UnrealBoolean;
-  };
-  BCD_PointLight?: {
-    bMatchBrickShape: UnrealBoolean;
-    Brightness: UnrealFloat;
-    Radius: UnrealFloat;
-    Color: UnrealColor;
-    bUseBrickColor: UnrealBoolean;
-    bCastShadows: UnrealBoolean;
-  };
-  BCD_ItemSpawn?: {
-    PickupClass: UnrealClass;
-    bPickupEnabled: UnrealBoolean;
-    bPickupRespawnOnMinigameReset: UnrealBoolean;
-    PickupMinigameResetRespawnDelay: UnrealFloat;
-    bPickupAutoDisableOnPickup: UnrealBoolean;
-    PickupRespawnTime: UnrealFloat;
-    PickupOffsetDirection: UnrealByte;
-    PickupOffsetDistance: UnrealFloat;
-    PickupRotation: UnrealRotator;
-    PickupScale: UnrealFloat;
-    bPickupAnimationEnabled: UnrealBoolean;
-    PickupAnimationAxis: UnrealByte;
-    bPickupAnimationAxisLocal: UnrealBoolean;
-    PickupSpinSpeed: UnrealFloat;
-    PickupBobSpeed: UnrealFloat;
-    PickupBobHeight: UnrealFloat;
-    PickupAnimationPhase: UnrealFloat;
-  };
-  BCD_Interact?: {
-    bPlayInteractSound: UnrealBoolean;
-  };
-  BCD_AudioEmitter?: {
-    AudioDescriptor: UnrealObject;
-    VolumeMultiplier: UnrealFloat;
-    PitchMultiplier: UnrealFloat;
-    InnerRadius: UnrealFloat;
-    MaxDistance: UnrealFloat;
-    bSpatialization: UnrealBoolean;
+export interface DefinedComponents
+  extends UnknownComponents,
+    Partial<KnownComponents> {}
+
+export type Components<C extends DefinedComponents> = {
+  [T in keyof C]: {
+    [V in keyof C[T]['properties']]: UnrealTypeFromString<
+      C[T]['properties'][V]
+    >;
   };
-  [component_name: string]: AppliedComponent;
-}
+} & { [component_name: string]: AppliedComponent };
 
 export type Vector = [number, number, number];
 
@@ -209,7 +188,7 @@ export interface BrickV3 extends BrickV2 {
 }
 
 export interface BrickV8 extends BrickV3 {
-  components: Components;
+  components: Components<DefinedComponents>;
 }
 
 export type BrickV9 = Modify<
@@ -322,7 +301,7 @@ export interface Brick {
   material_intensity?: number;
   color?: ColorRgb | number;
   owner_index?: number;
-  components?: Components;
+  components?: Components<DefinedComponents>;
 }
 
 // save a user can write

package/src/write.ts

@@ -1,9 +1,80 @@
-import { MAGIC, LATEST_VERSION, MAX_INT, DEFAULT_UUID } from './constants';
-import { Brick, Owner, WriteOptions, WriteSaveObject } from './types';
-import { write, isEqual, concat } from './utils';
+import { DEFAULT_UUID, LATEST_VERSION, MAGIC, MAX_INT } from './constants';
+import {
+  Brick,
+  DefinedComponents,
+  KnownComponents,
+  Owner,
+  WriteOptions,
+  WriteSaveObject,
+} from './types';
+import { concat, isEqual, write } from './utils';
 
 const EMPTY_ARR = new Uint8Array([]);
 
+export const DEFAULT_COMPONENTS: DefinedComponents = {
+  BCD_SpotLight: {
+    version: 1,
+    properties: {
+      Rotation: 'Rotator',
+      InnerConeAngle: 'Float',
+      OuterConeAngle: 'Float',
+      Brightness: 'Float',
+      Radius: 'Float',
+      Color: 'Color',
+      bUseBrickColor: 'Boolean',
+      bCastShadows: 'Boolean',
+    },
+  },
+  BCD_PointLight: {
+    version: 1,
+    properties: {
+      bMatchBrickShape: 'Boolean',
+      Brightness: 'Float',
+      Radius: 'Float',
+      Color: 'Color',
+      bUseBrickColor: 'Boolean',
+      bCastShadows: 'Boolean',
+    },
+  },
+  BCD_ItemSpawn: {
+    version: 1,
+    properties: {
+      PickupClass: 'Class',
+      bPickupEnabled: 'Boolean',
+      bPickupRespawnOnMinigameReset: 'Boolean',
+      PickupMinigameResetRespawnDelay: 'Float',
+      bPickupAutoDisableOnPickup: 'Boolean',
+      PickupRespawnTime: 'Float',
+      PickupOffsetDirection: 'Byte',
+      PickupOffsetDistance: 'Float',
+      PickupRotation: 'Rotator',
+      PickupScale: 'Float',
+      bPickupAnimationEnabled: 'Boolean',
+      PickupAnimationAxis: 'Byte',
+      bPickupAnimationAxisLocal: 'Boolean',
+      PickupSpinSpeed: 'Float',
+      PickupBobSpeed: 'Float',
+      PickupBobHeight: 'Float',
+      PickupAnimationPhase: 'Float',
+    },
+  },
+  BCD_Interact: {
+    version: 1,
+    properties: { bPlayInteractSound: 'Boolean' },
+  },
+  BCD_AudioEmitter: {
+    version: 1,
+    properties: {
+      AudioDescriptor: 'Object',
+      VolumeMultiplier: 'Float',
+      PitchMultiplier: 'Float',
+      InnerRadius: 'Float',
+      MaxDistance: 'Float',
+      bSpatialization: 'Boolean',
+    },
+  },
+};
+
 export default function writeBrs(
   save: WriteSaveObject,
   options: WriteOptions = {}
@@ -160,7 +231,7 @@ export default function writeBrs(
     // write components section
     compress(
       write.array(
-        Object.keys(save.components ?? {}).filter(
+        Object.keys(save.components ?? DEFAULT_COMPONENTS).filter(
           name => componentBrickOwnership[name]
         ),
         name =>
@@ -169,7 +240,8 @@ export default function writeBrs(
             write
               .bits()
               .self(function () {
-                const component = save.components[name];
+                const component =
+                  save.components?.[name] ?? DEFAULT_COMPONENTS[name];
                 const brick_indices = componentBrickOwnership[name];
                 const properties = Object.entries(component.properties);
 
@@ -190,7 +262,7 @@ export default function writeBrs(
                 // read brick indices
                 for (const i of brick_indices) {
                   for (const [prop, type] of properties) {
-                    if (!(prop in save.bricks[i].components[name])) {
+                    if (!(prop in (save.bricks[i].components?.[name] ?? {}))) {
                       throw new Error(
                         `Expected save.bricks[${i}].components[${name}] to have property '${prop}' of type '${type}'`
                       );