mlogjs 0.2.1 → 0.3.0

package/lib/globals.d.ts

@@ -28,6 +28,18 @@ interface Vars {
   readonly ipt: number;
   /** The unit bound to this processor */
   readonly unit: AnyUnit;
+  /** The amount of ticks that happened since the map started*/
+  readonly tick: number;
+  /** The current UNIX timestamp in milliseconds */
+  readonly time: number;
+  /** Total amount of items existent, can be used to check if an ID is valid*/
+  readonly itemCount: number;
+  /** Total amount of liquids existent, can be used to check if an ID is valid*/
+  readonly liquidCount: number;
+  /** Total amount of units existent, can be used to check if an ID is valid*/
+  readonly unitCount: number;
+  /** Total amount of blocks existent, can be used to check if an ID is valid*/
+  readonly blockCount: number;
 }
 
 declare const Vars: Vars;
@@ -162,167 +174,168 @@ declare namespace UnitCommands {
 
 type UnitCommandSymbol = typeof UnitCommands[keyof typeof UnitCommands];
 
-declare namespace Blocks {
+interface Blocks {
   // special "blocks" to reference stuff from the environment
-  const air: unique symbol;
-  const solid: unique symbol;
+  readonly air: unique symbol;
+  readonly solid: unique symbol;
 
-  const siliconSmelter: unique symbol;
-  const siliconCrucible: unique symbol;
-  const kiln: unique symbol;
-  const graphitePress: unique symbol;
-  const plastaniumCompressor: unique symbol;
-  const multiPress: unique symbol;
-  const phaseWeaver: unique symbol;
-  const surgeSmelter: unique symbol;
-  const pyratiteMixer: unique symbol;
-  const blastMixer: unique symbol;
-  const cryofluidMixer: unique symbol;
-  const melter: unique symbol;
-  const separator: unique symbol;
-  const disassembler: unique symbol;
-  const sporePress: unique symbol;
-  const pulverizer: unique symbol;
-  const incinerator: unique symbol;
-  const coalCentrifuge: unique symbol;
-  const powerSource: unique symbol;
-  const powerVoid: unique symbol;
-  const itemSource: unique symbol;
-  const itemVoid: unique symbol;
-  const liquidSource: unique symbol;
-  const liquidVoid: unique symbol;
-  const payloadSource: unique symbol;
-  const payloadVoid: unique symbol;
-  const illuminator: unique symbol;
-  const copperWall: unique symbol;
-  const copperWallLarge: unique symbol;
-  const titaniumWall: unique symbol;
-  const titaniumWallLarge: unique symbol;
-  const plastaniumWall: unique symbol;
-  const plastaniumWallLarge: unique symbol;
-  const thoriumWall: unique symbol;
-  const thoriumWallLarge: unique symbol;
-  const door: unique symbol;
-  const doorLarge: unique symbol;
-  const phaseWall: unique symbol;
-  const phaseWallLarge: unique symbol;
-  const surgeWall: unique symbol;
-  const surgeWallLarge: unique symbol;
-  const mender: unique symbol;
-  const mendProjector: unique symbol;
-  const overdriveProjector: unique symbol;
-  const overdriveDome: unique symbol;
-  const forceProjector: unique symbol;
-  const shockMine: unique symbol;
-  const scrapWall: unique symbol;
-  const scrapWallLarge: unique symbol;
-  const scrapWallHuge: unique symbol;
-  const scrapWallGigantic: unique symbol;
-  const thruster: unique symbol;
-  const conveyor: unique symbol;
-  const titaniumConveyor: unique symbol;
-  const plastaniumConveyor: unique symbol;
-  const armoredConveyor: unique symbol;
-  const distributor: unique symbol;
-  const junction: unique symbol;
-  const itemBridge: unique symbol;
-  const phaseConveyor: unique symbol;
-  const sorter: unique symbol;
-  const invertedSorter: unique symbol;
-  const router: unique symbol;
-  const overflowGate: unique symbol;
-  const underflowGate: unique symbol;
-  const massDriver: unique symbol;
-  const duct: unique symbol;
-  const ductRouter: unique symbol;
-  const ductBridge: unique symbol;
-  const mechanicalPump: unique symbol;
-  const rotaryPump: unique symbol;
-  const thermalPump: unique symbol;
-  const conduit: unique symbol;
-  const pulseConduit: unique symbol;
-  const platedConduit: unique symbol;
-  const liquidRouter: unique symbol;
-  const liquidContainer: unique symbol;
-  const liquidTank: unique symbol;
-  const liquidJunction: unique symbol;
-  const bridgeConduit: unique symbol;
-  const phaseConduit: unique symbol;
-  const combustionGenerator: unique symbol;
-  const thermalGenerator: unique symbol;
-  const steamGenerator: unique symbol;
-  const differentialGenerator: unique symbol;
-  const rtgGenerator: unique symbol;
-  const solarPanel: unique symbol;
-  const largeSolarPanel: unique symbol;
-  const thoriumReactor: unique symbol;
-  const impactReactor: unique symbol;
-  const battery: unique symbol;
-  const batteryLarge: unique symbol;
-  const powerNode: unique symbol;
-  const powerNodeLarge: unique symbol;
-  const surgeTower: unique symbol;
-  const diode: unique symbol;
-  const mechanicalDrill: unique symbol;
-  const pneumaticDrill: unique symbol;
-  const laserDrill: unique symbol;
-  const blastDrill: unique symbol;
-  const waterExtractor: unique symbol;
-  const oilExtractor: unique symbol;
-  const cultivator: unique symbol;
-  const coreShard: unique symbol;
-  const coreFoundation: unique symbol;
-  const coreNucleus: unique symbol;
-  const vault: unique symbol;
-  const container: unique symbol;
-  const unloader: unique symbol;
-  const duo: unique symbol;
-  const scatter: unique symbol;
-  const scorch: unique symbol;
-  const hail: unique symbol;
-  const arc: unique symbol;
-  const wave: unique symbol;
-  const lancer: unique symbol;
-  const swarmer: unique symbol;
-  const salvo: unique symbol;
-  const fuse: unique symbol;
-  const ripple: unique symbol;
-  const cyclone: unique symbol;
-  const foreshadow: unique symbol;
-  const spectre: unique symbol;
-  const meltdown: unique symbol;
-  const segment: unique symbol;
-  const parallax: unique symbol;
-  const tsunami: unique symbol;
-  const commandCenter: unique symbol;
-  const groundFactory: unique symbol;
-  const airFactory: unique symbol;
-  const navalFactory: unique symbol;
-  const additiveReconstructor: unique symbol;
-  const multiplicativeReconstructor: unique symbol;
-  const exponentialReconstructor: unique symbol;
-  const tetrativeReconstructor: unique symbol;
-  const repairPoint: unique symbol;
-  const repairTurret: unique symbol;
-  const payloadConveyor: unique symbol;
-  const payloadRouter: unique symbol;
-  const payloadPropulsionTower: unique symbol;
-  const deconstructor: unique symbol;
-  const constructor: unique symbol;
-  const largeConstructor: unique symbol;
-  const payloadLoader: unique symbol;
-  const payloadUnloader: unique symbol;
-  const message: unique symbol;
-  const switchBlock: unique symbol;
-  const microProcessor: unique symbol;
-  const logicProcessor: unique symbol;
-  const hyperProcessor: unique symbol;
-  const largeLogicDisplay: unique symbol;
-  const logicDisplay: unique symbol;
-  const memoryCell: unique symbol;
-  const memoryBank: unique symbol;
-  const launchPad: unique symbol;
-  const interplanetaryAccelerator: unique symbol;
+  readonly graphitePress: unique symbol;
+  readonly multiPress: unique symbol;
+  readonly siliconSmelter: unique symbol;
+  readonly siliconCrucible: unique symbol;
+  readonly kiln: unique symbol;
+  readonly plastaniumCompressor: unique symbol;
+  readonly phaseWeaver: unique symbol;
+  readonly alloySmelter: unique symbol;
+  readonly cryofluidMixer: unique symbol;
+  readonly pyratiteMixer: unique symbol;
+  readonly blastMixer: unique symbol;
+  readonly melter: unique symbol;
+  readonly separator: unique symbol;
+  readonly disassembler: unique symbol;
+  readonly sporePress: unique symbol;
+  readonly pulverizer: unique symbol;
+  readonly coalCentrifuge: unique symbol;
+  readonly incinerator: unique symbol;
+  readonly copperWall: unique symbol;
+  readonly copperWallLarge: unique symbol;
+  readonly titaniumWall: unique symbol;
+  readonly titaniumWallLarge: unique symbol;
+  readonly plastaniumWall: unique symbol;
+  readonly plastaniumWallLarge: unique symbol;
+  readonly thoriumWall: unique symbol;
+  readonly thoriumWallLarge: unique symbol;
+  readonly phaseWall: unique symbol;
+  readonly phaseWallLarge: unique symbol;
+  readonly surgeWall: unique symbol;
+  readonly surgeWallLarge: unique symbol;
+  readonly door: unique symbol;
+  readonly doorLarge: unique symbol;
+  readonly scrapWall: unique symbol;
+  readonly scrapWallLarge: unique symbol;
+  readonly scrapWallHuge: unique symbol;
+  readonly scrapWallGigantic: unique symbol;
+  readonly thruster: unique symbol;
+  readonly mender: unique symbol;
+  readonly mendProjector: unique symbol;
+  readonly overdriveProjector: unique symbol;
+  readonly overdriveDome: unique symbol;
+  readonly forceProjector: unique symbol;
+  readonly shockMine: unique symbol;
+  readonly conveyor: unique symbol;
+  readonly titaniumConveyor: unique symbol;
+  readonly plastaniumConveyor: unique symbol;
+  readonly armoredConveyor: unique symbol;
+  readonly junction: unique symbol;
+  readonly bridgeConveyor: unique symbol;
+  readonly phaseConveyor: unique symbol;
+  readonly sorter: unique symbol;
+  readonly invertedSorter: unique symbol;
+  readonly router: unique symbol;
+  readonly distributor: unique symbol;
+  readonly overflowGate: unique symbol;
+  readonly underflowGate: unique symbol;
+  readonly massDriver: unique symbol;
+  readonly duct: unique symbol;
+  readonly ductRouter: unique symbol;
+  readonly ductBridge: unique symbol;
+  readonly mechanicalPump: unique symbol;
+  readonly rotaryPump: unique symbol;
+  readonly thermalPump: unique symbol;
+  readonly conduit: unique symbol;
+  readonly pulseConduit: unique symbol;
+  readonly platedConduit: unique symbol;
+  readonly liquidRouter: unique symbol;
+  readonly liquidContainer: unique symbol;
+  readonly liquidTank: unique symbol;
+  readonly liquidJunction: unique symbol;
+  readonly bridgeConduit: unique symbol;
+  readonly phaseConduit: unique symbol;
+  readonly powerNode: unique symbol;
+  readonly powerNodeLarge: unique symbol;
+  readonly surgeTower: unique symbol;
+  readonly diode: unique symbol;
+  readonly battery: unique symbol;
+  readonly batteryLarge: unique symbol;
+  readonly combustionGenerator: unique symbol;
+  readonly thermalGenerator: unique symbol;
+  readonly steamGenerator: unique symbol;
+  readonly differentialGenerator: unique symbol;
+  readonly rtgGenerator: unique symbol;
+  readonly solarPanel: unique symbol;
+  readonly solarPanelLarge: unique symbol;
+  readonly thoriumReactor: unique symbol;
+  readonly impactReactor: unique symbol;
+  readonly mechanicalDrill: unique symbol;
+  readonly pneumaticDrill: unique symbol;
+  readonly laserDrill: unique symbol;
+  readonly blastDrill: unique symbol;
+  readonly waterExtractor: unique symbol;
+  readonly cultivator: unique symbol;
+  readonly oilExtractor: unique symbol;
+  readonly coreShard: unique symbol;
+  readonly coreFoundation: unique symbol;
+  readonly coreNucleus: unique symbol;
+  readonly vault: unique symbol;
+  readonly container: unique symbol;
+  readonly unloader: unique symbol;
+  readonly duo: unique symbol;
+  readonly scatter: unique symbol;
+  readonly scorch: unique symbol;
+  readonly hail: unique symbol;
+  readonly wave: unique symbol;
+  readonly lancer: unique symbol;
+  readonly arc: unique symbol;
+  readonly parallax: unique symbol;
+  readonly swarmer: unique symbol;
+  readonly salvo: unique symbol;
+  readonly segment: unique symbol;
+  readonly tsunami: unique symbol;
+  readonly fuse: unique symbol;
+  readonly ripple: unique symbol;
+  readonly cyclone: unique symbol;
+  readonly foreshadow: unique symbol;
+  readonly spectre: unique symbol;
+  readonly meltdown: unique symbol;
+  readonly commandCenter: unique symbol;
+  readonly groundFactory: unique symbol;
+  readonly airFactory: unique symbol;
+  readonly navalFactory: unique symbol;
+  readonly additiveReconstructor: unique symbol;
+  readonly multiplicativeReconstructor: unique symbol;
+  readonly exponentialReconstructor: unique symbol;
+  readonly tetrativeReconstructor: unique symbol;
+  readonly repairPoint: unique symbol;
+  readonly repairTurret: unique symbol;
+  readonly payloadConveyor: unique symbol;
+  readonly payloadRouter: unique symbol;
+  readonly payloadPropulsionTower: unique symbol;
+  readonly deconstructor: unique symbol;
+  readonly constructor: unique symbol;
+  readonly largeConstructor: unique symbol;
+  readonly payloadLoader: unique symbol;
+  readonly payloadUnloader: unique symbol;
+  readonly powerSource: unique symbol;
+  readonly powerVoid: unique symbol;
+  readonly itemSource: unique symbol;
+  readonly itemVoid: unique symbol;
+  readonly liquidSource: unique symbol;
+  readonly liquidVoid: unique symbol;
+  readonly payloadSource: unique symbol;
+  readonly payloadVoid: unique symbol;
+  readonly illuminator: unique symbol;
+  readonly launchPad: unique symbol;
+  readonly interplanetaryAccelerator: unique symbol;
+  readonly message: unique symbol;
+  readonly switch: unique symbol;
+  readonly microProcessor: unique symbol;
+  readonly logicProcessor: unique symbol;
+  readonly hyperProcessor: unique symbol;
+  readonly memoryCell: unique symbol;
+  readonly memoryBank: unique symbol;
+  readonly logicDisplay: unique symbol;
+  readonly largeLogicDisplay: unique symbol;
 }
 
+declare const Blocks: Blocks;
 type BlockSymbol = typeof Blocks[keyof typeof Blocks];

package/lib/helpers.d.ts

@@ -7,9 +7,9 @@
  * already accessible under the namespaces `Units`, `Blocks`,
  * `Items`, `Liquids`, `ControlKind`, `Vars` and `UnitCommands`.
  *
- * @param key The identifier of the value
+ * @param name The identifier of the value
  */
-declare function getVar<T>(key: string): T;
+declare function getVar<T>(name: string): T;
 
 /**
  * Gets a building linked to the processor by its name.

package/lib/memory.d.ts

@@ -2,7 +2,7 @@
 
 type MemoryCapacity = 64 | 512;
 /**
- * A wrapper around memory cells/banks that is compatible with custom types.
+ * Allows you to view and modify the data of memory cells and memory banks.
  */
 declare class Memory<S extends MemoryCapacity = 64> {
   constructor(cell: BasicBuilding, size?: S);

package/lib/traits.d.ts

@@ -1,5 +1,4 @@
 import "./globals";
-import "./custom-lib";
 
 type LogicSymbols = typeof Items & typeof Liquids & typeof LAccess;
 
@@ -8,114 +7,135 @@ type WithSymbols<T extends Record<string, unknown>> = T & {
 };
 
 declare global {
-  type LiquidHolder = WithSymbols<
-    {
-      readonly [L in keyof typeof Liquids]: number;
-    } & {
-      readonly totalLiquids: number;
-      readonly liquidCapacity: number;
-    }
-  >;
-
-  type ItemHolder = WithSymbols<
-    {
-      readonly [I in keyof typeof Items]: number;
-    } & {
-      readonly totalItems: number;
-      readonly firstItem: ItemSymbol | null;
-      readonly itemCapacity: number;
-    }
-  >;
-
-  type PowerHolder = WithSymbols<{
-    readonly totalPower: number;
-    readonly powerCapacity: number;
-    readonly powerNetStored: number;
-    readonly powerNetCapacity: number;
-    readonly powerNetIn: number;
-    readonly powerNetOut: number;
-  }>;
-
-  type Shooting = WithSymbols<{
-    readonly shootX: number;
-    readonly shootY: number;
-    readonly ammo: number;
-    readonly ammoCapacity: number;
-  }>;
-
-  type WithHealth = WithSymbols<{
-    readonly health: number;
-    readonly maxHealth: number;
-    readonly dead: boolean;
-  }>;
-
-  type Heatable = WithSymbols<{
-    readonly heat: number;
-  }>;
-
-  type WithEffiency = WithSymbols<{
-    readonly efficiency: number;
-  }>;
-
-  type WithProgress = WithSymbols<{
-    readonly progress: number;
-  }>;
-
-  type WithTimescale = WithSymbols<{
-    readonly timescale: number;
-  }>;
-
-  type Rotatable = WithSymbols<{
-    readonly rotation: number;
-  }>;
-
-  type Spaced = WithSymbols<{
-    readonly x: number;
-    readonly y: number;
-    readonly size: number;
-  }>;
-
-  type Ranged = WithSymbols<{
-    readonly range: number;
-  }>;
-
-  type Boosted = WithSymbols<{
-    readonly boosting: number;
-  }>;
-
-  type Mining = WithSymbols<{
-    readonly mineX: number;
-    readonly mineY: number;
-    readonly mining: number;
-  }>;
-
-  type Typed<T extends symbol = symbol> = WithSymbols<{
-    readonly type: T;
-  }>;
-  type Flagged = WithSymbols<{
-    readonly flag: number;
-  }>;
-
-  type Controllable = WithSymbols<{
-    readonly controlled: 0 | ControlKind;
-    readonly controller: AnyUnit | BasicBuilding;
-  }>;
-
-  type Nameable = WithSymbols<{
-    readonly name: string | null;
-  }>;
-
-  type PayloadHolder = WithSymbols<{
-    readonly payloadCount: number;
-    readonly payloadType: symbol | null;
-  }>;
-
-  type WithEnable = WithSymbols<{
-    enabled: boolean;
-  }>;
-
-  type WithConfig<T extends symbol | number | null = symbol | null> =
-    WithSymbols<{
+  interface LiquidHolder
+    extends WithSymbols<
+      {
+        readonly [L in keyof typeof Liquids]: number;
+      } & {
+        readonly totalLiquids: number;
+        readonly liquidCapacity: number;
+      }
+    > {}
+
+  interface ItemHolder
+    extends WithSymbols<
+      {
+        readonly [I in keyof typeof Items]: number;
+      } & {
+        readonly totalItems: number;
+        readonly firstItem: ItemSymbol | null;
+        readonly itemCapacity: number;
+      }
+    > {}
+
+  interface PowerHolder
+    extends WithSymbols<{
+      readonly totalPower: number;
+      readonly powerCapacity: number;
+      readonly powerNetStored: number;
+      readonly powerNetCapacity: number;
+      readonly powerNetIn: number;
+      readonly powerNetOut: number;
+    }> {}
+
+  interface Shooting
+    extends WithSymbols<{
+      readonly shootX: number;
+      readonly shootY: number;
+      readonly ammo: number;
+      readonly ammoCapacity: number;
+    }> {}
+
+  interface WithHealth
+    extends WithSymbols<{
+      readonly health: number;
+      readonly maxHealth: number;
+      readonly dead: boolean;
+    }> {}
+
+  interface Heatable
+    extends WithSymbols<{
+      readonly heat: number;
+    }> {}
+
+  interface WithEffiency
+    extends WithSymbols<{
+      readonly efficiency: number;
+    }> {}
+
+  interface WithProgress
+    extends WithSymbols<{
+      readonly progress: number;
+    }> {}
+
+  interface WithTimescale
+    extends WithSymbols<{
+      readonly timescale: number;
+    }> {}
+
+  interface Rotatable
+    extends WithSymbols<{
+      readonly rotation: number;
+    }> {}
+
+  interface Spaced
+    extends WithSymbols<{
+      readonly x: number;
+      readonly y: number;
+      readonly size: number;
+    }> {}
+
+  interface Ranged
+    extends WithSymbols<{
+      readonly range: number;
+    }> {}
+
+  interface Boosted
+    extends WithSymbols<{
+      readonly boosting: number;
+    }> {}
+
+  interface Mining
+    extends WithSymbols<{
+      readonly mineX: number;
+      readonly mineY: number;
+      readonly mining: number;
+    }> {}
+
+  interface Typed<T extends symbol = symbol>
+    extends WithSymbols<{
+      readonly type: T;
+    }> {}
+  interface Flagged
+    extends WithSymbols<{
+      readonly flag: number;
+    }> {}
+
+  interface Controllable
+    extends WithSymbols<{
+      readonly controlled: 0 | ControlKind;
+      readonly controller: AnyUnit | BasicBuilding;
+    }> {}
+
+  interface Nameable
+    extends WithSymbols<{
+      readonly name: string | null;
+    }> {}
+
+  interface PayloadHolder
+    extends WithSymbols<{
+      readonly payloadCount: number;
+      readonly payloadType: symbol | null;
+    }> {}
+
+  interface WithEnable
+    extends WithSymbols<{
+      enabled: boolean;
+    }> {}
+
+  interface WithConfig<
+    T extends symbol | number | null = symbol | null
+  > extends WithSymbols<{
       readonly config: T;
-    }>;
+    }> {}
 }