Merge branch 'master' of https://github.com/Exeteres/opc-types

Author: Exeteres

README.ru.md

@@ -42,24 +42,19 @@ yarn add typescript-to-lua
 ```json
 // tsconfig.json
 {
-    "compilerOptions": {
-        "target": "esnext",
-        "outDir": "dist",
-        "module": "commonjs",
-        "lib": ["esnext"],
-        "strict": true,
-        "moduleResolution": "node",
-        "rootDir": "src",
-        "types": [
-            "lua-types/jit",
-            "@opct/openos",
-            "@opct/gui",
-            "@opct/mineos"
-        ]
-    },
-    "tstl": {
-        "luaTarget": "JIT"
-    }
+  "compilerOptions": {
+    "target": "esnext",
+    "outDir": "dist",
+    "module": "commonjs",
+    "lib": ["esnext"],
+    "strict": true,
+    "moduleResolution": "node",
+    "rootDir": "src",
+    "types": ["lua-types/jit", "@opct/openos", "@opct/gui", "@opct/mineos"]
+  },
+  "tstl": {
+    "luaTarget": "JIT"
+  }
 }
 ```
 
@@ -69,14 +64,14 @@ yarn add typescript-to-lua
 - Вместо реального мода можно использовать эмулятор. Иначе необходимо установить `filesystem.bufferChanges` на `false`, чтобы иметь внешний доступ к диску.
 - Создайте ссылку на диск, чтобы хранить исходный код отдельно от него:
 
-    ```shell
-    # linux / macos
-    ln -s /path/to/disk/home/app dist
-    ```
+  ```shell
+  # linux / macos
+  ln -s /path/to/disk/home/app dist
+  ```
 
-    ```cmd
-    # windows (cmd)
-    mklink /j dist C:\path\to\disk\home
-    ```
+  ```cmd
+  # windows (cmd)
+  mklink /j dist C:\path\to\disk\home
+  ```
 
 - Используйте `tstl --watch`

examples/ae2.ts

@@ -0,0 +1,4 @@
+import * as component from "component";
+
+const { me_controller } = component;
+me_controller.store();

packages/ae2/ME.d.ts

@@ -0,0 +1,196 @@
+/**
+ * This library wraps functionality of Applied Energistics 2.
+ * @see https://ocdoc.cil.li/component:applied_energistics
+ * @noSelfInFile
+ */
+declare namespace ME {
+    /**
+     * Common is the base network API functionality for all AE2 interfaces.
+     * @noSelf
+     */
+    interface Common {
+        /**
+         * Get a list of tables representing the available CPUs in the network.
+         */
+        getCpus(): Cpu[];
+
+        /**
+         * Get a list of known item recipes. These can be used to issue crafting requests..
+         */
+        getCraftables(filter?: any): Craftable[];
+
+        /**
+         * Get a list of the stored items in the network.
+         */
+        getItemsInNetwork(filter?: ItemStack): ItemStack[];
+
+        /**
+         * Store items in the network matching the specified filter in the database with the specified address.
+         */
+        store(filter?: any, dbAddress?: string, startSlot?: number, count?: number): boolean;
+
+        /**
+         * Get a list of the stored fluids in the network.
+         */
+        getFluidsInNetwork(): Fluid[];
+
+        /**
+         * Get the average power injection into the network.
+         */
+        getAvgPowerInjection(): number;
+
+        /**
+         * Get the average power usage of the network.
+         */
+        getAvgPowerUsage(): number;
+
+        /**
+         * Get the idle power usage of the network.
+         */
+        getIdlePowerUsage(): number;
+
+        /**
+         * Get the maximum stored power in the network.
+         */
+        getMaxStoredPower(): number;
+
+        /**
+         * Get the stored power in the network.
+         */
+        getStoredPower(): number;
+    }
+
+    /**
+     * Controller interface for the AE2 controller. Referred as "me_controller" in ocdocs
+     * @noSelf
+     */
+    interface Controller extends Common {
+        /**
+         * Returns the amount of stored energy on the connected side.
+         */
+        getEnergyStored(): number;
+
+        /**
+         * Returns the maximum amount of stored energy on the connected side.
+         */
+        getMaxEnergyStored(): number;
+
+        /**
+         * Returns whether this component can have energy extracted from the connected side.
+         */
+        canExtract(): number;
+
+        /**
+         * Returns whether this component can receive energy on the connected side.
+         */
+        canReceive(): number;
+    }
+
+    /**
+     * Interface interface for the AE2 interface blocks. Referred as "me_interface" in ocdocs
+     * @noSelf
+     */
+    interface Interface extends Common {
+        /**
+         * Get the configuration of the interface.
+         */
+        getInterfaceConfiguration(slot?: number): ItemStack[];
+
+        /**
+         * Configure the interface.
+         */
+        setInterfaceConfiguration(slot?: number, database?: string, entry?: number, size?: number): boolean;
+    }
+
+    /**
+     * ImportBus interface for the AE2 Importbus blocks. Referred as "me_importbus" in ocdocs
+     * @noSelf
+     */
+    interface ImportBus extends Common {
+        /**
+         * Get the configuration of the import bus pointing in the specified direction.
+         */
+        getImportConfiguration(side: number, slot?: number): boolean;
+
+        /**
+         * Configure the import bus pointing in the specified direction to import item stacks matching the specified descriptor.
+         */
+        setImportConfiguration(side: number, slot?: number, database?: string, entry?: number): boolean;
+    }
+
+    /**
+     * ExportBus interface for the AE2 Exportbus blocks. Referred as "me_exportbus" in ocdocs
+     * @noSelf
+     */
+    interface ExportBus extends Common {
+        /**
+         * Get the configuration of the export bus pointing in the specified direction.
+         */
+        getExportConfiguration(side: number, slot?: number): boolean;
+
+        /**
+         * Configure the export bus pointing in the specified direction to export item stacks matching the specified descriptor.
+         */
+        setExportConfiguration(side: number, slot?: number, database?: string, entry?: number): boolean;
+
+        /**
+         * Make the export bus facing the specified direction perform a single export operation into the specified slot.
+         */
+        exportIntoSlot(side: number, slot: number): boolean;
+    }
+
+    /**
+     * @noSelf
+     */
+    interface Craftable {
+        /**
+         * Returns the item stack representation of the crafting result.
+         */
+        getItemStack(): ItemStack;
+
+        /**
+         * Requests the item to be crafted, returning an object that allows tracking the crafting status.
+         */
+        request(amount: number, prioritizePower?: boolean, cpuName?: string): CraftingStatus;
+    }
+
+    /**
+     * @noSelf
+     */
+    interface CraftingStatus {
+        /**
+         * Get whether the crafting request has been canceled.
+         */
+        isCanceled(): boolean;
+
+        /**
+         * Get whether the crafting request is done.
+         */
+        isDone(): boolean;
+    }
+
+    interface ItemStack {
+        damage?: number;
+        hasTag?: boolean;
+        isCraftable?: boolean;
+        label?: string;
+        maxDamage?: number;
+        maxSize?: number;
+        name?: string;
+        size?: number;
+    }
+
+    interface Fluid {
+        amount?: number;
+        hasTag?: boolean;
+        label?: string;
+        name?: string;
+    }
+
+    interface Cpu {
+        busy?: boolean;
+        coprocessors?: number;
+        name?: string;
+        storage?: number;
+    }
+}

packages/ae2/component_map.d.ts

@@ -0,0 +1,8 @@
+declare namespace OC {
+    interface ComponentMap {
+        me_controller: ME.Controller;
+        me_interface: ME.Interface;
+        me_importbus: ME.ImportBus;
+        me_exportbus: ME.ExportBus;
+    }
+}

packages/ae2/index.d.ts

@@ -0,0 +1,2 @@
+import "./ME";
+import "./component_map";