Merge pull request #3 from mdingena/refactor-component-types

mdingena · web-flow · commit 5d630426bd01 · 2021-08-05T11:50:12.000+08:00
Refactor component types
diff --git a/src/components/index.ts b/src/components/index.ts
@@ -1,25 +1,38 @@
 import * as transcoders from './transcoders';
 
-export { ComponentVersion } from './ComponentVersion';
-
 export type ComponentName = keyof typeof transcoders;
 
+export type BasicDecay = transcoders.BasicDecay.BasicDecay;
+export type DurabilityModule = transcoders.DurabilityModule.DurabilityModule;
+export type HeatSourceBase = transcoders.HeatSourceBase.HeatSourceBase;
+export type LiquidContainer = transcoders.LiquidContainer.LiquidContainer;
+export type NetworkRigidbody = transcoders.NetworkRigidbody.NetworkRigidbody;
+export type PhysicalMaterialPart = transcoders.PhysicalMaterialPart.PhysicalMaterialPart;
+export type Pickup = transcoders.Pickup.Pickup;
+export type PickupDock = transcoders.PickupDock.PickupDock;
+export type PopulationSpawnArea = transcoders.PopulationSpawnArea.PopulationSpawnArea;
+export type SpawnArea = transcoders.SpawnArea.SpawnArea;
+export type StatManager = transcoders.StatManager.StatManager;
+export type WoodcutTree = transcoders.WoodcutTree.WoodcutTree;
+
 export type KnownComponent =
-  | transcoders.BasicDecay.Component
-  | transcoders.DurabilityModule.Component
-  | transcoders.HeatSourceBase.Component
-  | transcoders.LiquidContainer.Component
-  | transcoders.NetworkRigidbody.Component
-  | transcoders.PhysicalMaterialPart.Component
-  | transcoders.Pickup.Component
-  | transcoders.PickupDock.Component
-  | transcoders.PopulationSpawnArea.Component
-  | transcoders.SpawnArea.Component
-  | transcoders.StatManager.Component
-  | transcoders.WoodcutTree.Component;
+  | BasicDecay
+  | DurabilityModule
+  | HeatSourceBase
+  | LiquidContainer
+  | NetworkRigidbody
+  | PhysicalMaterialPart
+  | Pickup
+  | PickupDock
+  | PopulationSpawnArea
+  | SpawnArea
+  | StatManager
+  | WoodcutTree;
 
 export type UnknownComponent = { hash: number; data: string };
 
 export type Component = KnownComponent | UnknownComponent[];
 
+export { ComponentVersion } from './ComponentVersion';
+
 export { transcoders };
diff --git a/src/components/transcoders/basicDecay.ts b/src/components/transcoders/basicDecay.ts
@@ -1,22 +1,19 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.BasicDecay;
-export const VERSION = 3;
-
 const HUNDRED_YEARS_TICKS = 31557600000000000;
 
-export type Component = {
+export type BasicDecay = {
   isDisabled?: boolean;
   timelineEntry?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): BasicDecay => ({
   isDisabled: reader.boolean(),
   timelineEntry: reader.uLong()
 });
 
-export const encode = ({ isDisabled = true, timelineEntry = HUNDRED_YEARS_TICKS }: Component): string => {
+export const encode = ({ isDisabled = true, timelineEntry = HUNDRED_YEARS_TICKS }: BasicDecay): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/durabilityModule.ts b/src/components/transcoders/durabilityModule.ts
@@ -1,18 +1,15 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.DurabilityModule;
-export const VERSION = 1;
-
-export type Component = {
+export type DurabilityModule = {
   integrity?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): DurabilityModule => ({
   integrity: reader.float()
 });
 
-export const encode = ({ integrity = 1 }: Component): string => {
+export const encode = ({ integrity = 1 }: DurabilityModule): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/heatSourceBase.ts b/src/components/transcoders/heatSourceBase.ts
@@ -1,24 +1,21 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.HeatSourceBase;
-export const VERSION = 2;
-
 const HUNDRED_YEARS_TICKS = 31557600000000000;
 
-export type Component = {
+export type HeatSourceBase = {
   isLit?: boolean;
   progress?: number;
   time?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): HeatSourceBase => ({
   isLit: reader.boolean(),
   progress: reader.float(),
   time: reader.uLong()
 });
 
-export const encode = ({ isLit = true, progress = 0, time = HUNDRED_YEARS_TICKS }: Component): string => {
+export const encode = ({ isLit = true, progress = 0, time = HUNDRED_YEARS_TICKS }: HeatSourceBase): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/liquidContainer.ts b/src/components/transcoders/liquidContainer.ts
@@ -1,9 +1,6 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.LiquidContainer;
-export const VERSION = 1;
-
 type Color = {
   r: number;
   g: number;
@@ -26,7 +23,7 @@ type CustomData = {
   foodChunks: FoodChunk[];
 };
 
-export type Component = {
+export type LiquidContainer = {
   canAddTo?: boolean;
   canRemoveFrom?: boolean;
   contentLevel?: number;
@@ -36,8 +33,8 @@ export type Component = {
   customData?: null | CustomData;
 };
 
-export const decode = (reader: BinaryReader): Component => {
-  const result: Component = {
+export const decode = (reader: BinaryReader): LiquidContainer => {
+  const result: LiquidContainer = {
     canAddTo: reader.boolean(),
     canRemoveFrom: reader.boolean(),
     contentLevel: reader.int(),
@@ -105,7 +102,7 @@ export const encode = ({
   isCustom = false,
   presetHash = 0,
   customData = null
-}: Component): string => {
+}: LiquidContainer): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/networkRigidbody.ts b/src/components/transcoders/networkRigidbody.ts
@@ -1,10 +1,7 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.NetworkRigidbody;
-export const VERSION = 1;
-
-export type Component = {
+export type NetworkRigidbody = {
   position?: {
     x: number;
     y: number;
@@ -30,7 +27,7 @@ export type Component = {
   };
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): NetworkRigidbody => ({
   position: {
     x: reader.float(),
     y: reader.float(),
@@ -63,7 +60,7 @@ export const encode = ({
   isServerSleeping = false,
   velocity = { x: 0, y: 0, z: 0 },
   angularVelocity = { x: 0, y: 0, z: 0 }
-}: Component): string => {
+}: NetworkRigidbody): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/physicalMaterialPart.ts b/src/components/transcoders/physicalMaterialPart.ts
@@ -2,18 +2,15 @@ import { ComponentHash } from '../../ComponentHash';
 import { PhysicalMaterialPartHash } from '../../PhysicalMaterialPartHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.PhysicalMaterialPart;
-export const VERSION = 1;
-
-export type Component = {
+export type PhysicalMaterialPart = {
   materialHash?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): PhysicalMaterialPart => ({
   materialHash: reader.uInt()
 });
 
-export const encode = ({ materialHash = PhysicalMaterialPartHash.Iron }: Component): string => {
+export const encode = ({ materialHash = PhysicalMaterialPartHash.Iron }: PhysicalMaterialPart): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/pickup.ts b/src/components/transcoders/pickup.ts
@@ -1,18 +1,15 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.Pickup;
-export const VERSION = 1;
-
-export type Component = {
+export type Pickup = {
   lastInteractorPlayerId?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): Pickup => ({
   lastInteractorPlayerId: reader.int()
 });
 
-export const encode = ({ lastInteractorPlayerId = 0 }: Component): string => {
+export const encode = ({ lastInteractorPlayerId = 0 }: Pickup): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/pickupDock.ts b/src/components/transcoders/pickupDock.ts
@@ -1,22 +1,19 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.PickupDock;
-export const VERSION = 2;
-
-export type Component = {
+export type PickupDock = {
   dockedTypeHash?: number;
   quantity?: number;
   childIndex?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): PickupDock => ({
   dockedTypeHash: reader.uInt(),
   quantity: reader.int(),
   childIndex: reader.int()
 });
 
-export const encode = ({ dockedTypeHash = 0, quantity = 1, childIndex = 0 }: Component): string => {
+export const encode = ({ dockedTypeHash = 0, quantity = 1, childIndex = 0 }: PickupDock): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/populationSpawnArea.ts b/src/components/transcoders/populationSpawnArea.ts
@@ -2,15 +2,12 @@ import { ComponentHash } from '../../ComponentHash';
 import { PopulationDefinitionHash } from '../../PopulationDefinitionHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.PopulationSpawnArea;
-export const VERSION = 2;
-
 type PopulationSaveDataChild = {
   index: number;
   pointIndex: number;
 };
 
-export type Component = {
+export type PopulationSpawnArea = {
   definition?: number;
   isPopulationStarted?: boolean;
   children?: PopulationSaveDataChild[];
@@ -22,7 +19,7 @@ export type Component = {
   isOneOff?: boolean;
 };
 
-export const decode = (reader: BinaryReader): Component => {
+export const decode = (reader: BinaryReader): PopulationSpawnArea => {
   const definition = reader.uInt();
   const isPopulationStarted = reader.boolean();
 
@@ -66,7 +63,7 @@ export const encode = ({
   numberOfSpawnPoints = 40,
   startingPopulation = 5,
   isOneOff = false
-}: Component): string => {
+}: PopulationSpawnArea): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/spawnArea.ts b/src/components/transcoders/spawnArea.ts
@@ -1,18 +1,15 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.SpawnArea;
-export const VERSION = 1;
-
-export type Component = {
+export type SpawnArea = {
   size?: number;
   groundLayers?: number;
   avoidLayers?: number;
   isAligningNormal?: boolean;
   maxAcceptableAngleDot?: number;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): SpawnArea => ({
   size: reader.float(),
   groundLayers: reader.int(),
   avoidLayers: reader.int(),
@@ -26,7 +23,7 @@ export const encode = ({
   avoidLayers = 8721,
   isAligningNormal = false,
   maxAcceptableAngleDot = -1
-}: Component): string => {
+}: SpawnArea): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/statManager.ts b/src/components/transcoders/statManager.ts
@@ -1,9 +1,6 @@
 import { ComponentHash } from '../../ComponentHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.StatManager;
-export const VERSION = 2;
-
 type Stat = null | {
   hash: number;
   baseFlat: number;
@@ -29,13 +26,13 @@ type IndirectStatModifier = null | {
   modifiers: IndirectModifierSaveData[];
 };
 
-export type Component = {
+export type StatManager = {
   stats?: Stat[];
   modifiers?: TimedModifier[];
   indirectStatModifiers?: IndirectStatModifier[];
 };
 
-export const decode = (reader: BinaryReader): Component => {
+export const decode = (reader: BinaryReader): StatManager => {
   /* Get stats array. */
   const statsLength = reader.uInt();
   const stats: Stat[] = [];
@@ -108,7 +105,7 @@ export const decode = (reader: BinaryReader): Component => {
   return { stats, modifiers, indirectStatModifiers };
 };
 
-export const encode = ({ stats = [], modifiers = [], indirectStatModifiers = [] }: Component): string => {
+export const encode = ({ stats = [], modifiers = [], indirectStatModifiers = [] }: StatManager): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/components/transcoders/woodcutTree.ts b/src/components/transcoders/woodcutTree.ts
@@ -3,20 +3,17 @@ import { PresetHash } from '../../PresetHash';
 import { SpeciesHash } from '../../SpeciesHash';
 import { BinaryReader, createBinaryWriter } from '../../utils';
 
-export const HASH = ComponentHash.WoodcutTree;
-export const VERSION = 3;
-
-export type Component = {
+export type WoodcutTree = {
   presetHash?: 0 | PresetHash;
   speciesHash?: SpeciesHash;
 };
 
-export const decode = (reader: BinaryReader): Component => ({
+export const decode = (reader: BinaryReader): WoodcutTree => ({
   presetHash: reader.uInt(),
   speciesHash: reader.uInt()
 });
 
-export const encode = ({ presetHash = 0, speciesHash = SpeciesHash.Oak }: Component): string => {
+export const encode = ({ presetHash = 0, speciesHash = SpeciesHash.Oak }: WoodcutTree): string => {
   const writer = createBinaryWriter();
 
   /* Component hash. */
diff --git a/src/index.ts b/src/index.ts
