Merge pull request #7 from roobscoob/master

Exeteres · web-flow · commit 2309e6770707 · 2021-12-07T12:43:54.000+07:00
diff --git a/packages/common/components/debug.d.ts b/packages/common/components/debug.d.ts
@@ -93,9 +93,8 @@ declare namespace OC.Components {
          * The final value returned is a serialized or table representation of the entity or block scanned at the location.
          * The following code snippet can be used to debug what is possibly blocking
          * the robot from moving forward, if the robot is facing in the negative x direction.
-         * @tupleReturn
          */
-        scanContentsAt(x: number, y: number, z: number, worldId?: number): [boolean, string, any];
+        scanContentsAt(x: number, y: number, z: number, worldId?: number): LuaMultiReturn<[boolean, string, any]>;
     }
 
     interface World {
@@ -215,9 +214,8 @@ declare namespace OC.Components {
 
         /**
          * Get the current spawn point coordinates.
-         * @tupleReturn
          */
-        getSpawnPoint(): [number, number, number];
+        getSpawnPoint(): LuaMultiReturn<[number, number, number]>;
 
         /**
          * Set the spawn point coordinates.
@@ -293,9 +291,8 @@ declare namespace OC.Components {
 
         /**
          * Get the player's position.
-         * @tupleReturn
          */
-        getPosition(): [number, number, number];
+        getPosition(): LuaMultiReturn<[number, number, number]>;
 
         /**
          * Set the player's position.
diff --git a/packages/common/components/drone.d.ts b/packages/common/components/drone.d.ts
@@ -55,9 +55,8 @@ declare namespace OC.Components {
          * Lets the robot use the currently equipped item in the tool slot against the block or space directly in front of the robot.
          * Returns `true` if successful (may take time depending on block being interacted with - e.g.. Obsidian takes time to mine).
          * Returns `false` if the operation fails with a description of why it failed.
-         * @tupleReturn
          */
-        swing(side: number): [boolean, string | null];
+        swing(side: number): LuaMultiReturn<[boolean, string | null]>;
 
         /**
          * Returns the size of the device's internal inventory.
diff --git a/packages/common/components/generator.d.ts b/packages/common/components/generator.d.ts
@@ -21,9 +21,8 @@ declare namespace OC.Components {
          * * “selected slot does not contain fuel” if the selected slot has no item which can be burnt
          * * “different fuel type already queued” if there is already another type of item in the generator
          * * “queue is full” if there already are 64 items of that type in the generator
-         * @tupleReturn
          */
-        insert(count?: number): [boolean, string | null];
+        insert(count?: number): LuaMultiReturn<[boolean, string | null]>;
 
         /**
          * Removes up to the specified number of fuel items from the generator
diff --git a/packages/common/components/gpu.d.ts b/packages/common/components/gpu.d.ts
@@ -14,9 +14,8 @@ declare namespace OC.Components {
          * A GPU can only be bound to one screen at a time.
          * All operations on it will work on the bound screen.
          * If you wish to control multiple screens at once, you'll need to put more than one graphics card into your computer.
-         * @tupleReturn
          */
-        bind(address: string, reset?: boolean): [boolean, string | null];
+        bind(address: string, reset?: boolean): LuaMultiReturn<[boolean, string | null]>;
 
         /**
          * Get the address of the screen the GPU is bound to. Since 1.3.2.
@@ -28,9 +27,8 @@ declare namespace OC.Components {
          * This background color is applied to all “pixels” that get changed by other operations.
          * Note that the returned number is either an RGB value in hexadecimal format, i.e. `0xRRGGBB`, or a palette index.
          * The second returned value indicates which of the two it is (`true` for palette color, `false` for RGB value).
-         * @tupleReturn
          */
-        getBackground(): [number, boolean];
+        getBackground(): LuaMultiReturn<[number, boolean]>;
 
         /**
          * Sets the background color to apply to “pixels” modified by other operations from now on.
@@ -40,21 +38,18 @@ declare namespace OC.Components {
          * If the color was from the palette, the second value will be the index in the palette.
          * Otherwise it will be `nil`. Note that the color is expected to be specified in hexadecimal RGB format, i.e. `0xRRGGBB`.
          * This is to allow uniform color operations regardless of the color depth supported by the screen and GPU.
-         * @tupleReturn
          */
-        setBackground(color: number, isPaletteIndex?: boolean): [number, number | null];
+        setBackground(color: number, isPaletteIndex?: boolean): LuaMultiReturn<[number, number | null]>;
 
         /**
          * Like `getBackground`, but for the foreground color.
-         * @tupleReturn
          */
-        getForeground(): [number, boolean];
+        getForeground(): LuaMultiReturn<[number, boolean]>;
 
         /**
          * Like `setBackground`, but for the foreground color.
-         * @tupleReturn
          */
-        setForeground(color: number, isPaletteIndex?: boolean): [number, number | null];
+        setForeground(color: number, isPaletteIndex?: boolean): LuaMultiReturn<[number, number | null]>;
 
         /**
          * Gets the RGB value of the color in the palette at the specified index.
@@ -86,15 +81,13 @@ declare namespace OC.Components {
 
         /**
          * Gets the maximum resolution supported by the GPU and the screen it is bound to (minimum of the two).
-         * @tupleReturn
          */
-        maxResolution(): [number, number];
+        maxResolution(): LuaMultiReturn<[number, number]>;
 
         /**
          * Gets the currently set resolution.
-         * @tupleReturn
          */
-        getResolution(): [number, number];
+        getResolution(): LuaMultiReturn<[number, number]>;
 
         /**
          * Sets the specified resolution.
@@ -107,9 +100,8 @@ declare namespace OC.Components {
 
         /**
          * Get the current viewport resolution.
-         * @tupleReturn
          */
-        getViewport(): [number, number];
+        getViewport(): LuaMultiReturn<[number, number]>;
 
         /**
          * Set the current viewport resolution.
@@ -126,9 +118,8 @@ declare namespace OC.Components {
          * The second and third returned values are the fore- and background color, as hexvalues.
          * If the colors are from the palette, the fourth
          * and fifth values specify the palette index of the color, otherwise they are nil.
-         * @tupleReturn
          */
-        get(x: number, y: number): [string, number, number, number | null, number | null];
+        get(x: number, y: number): LuaMultiReturn<[string, number, number, number | null, number | null]>;
 
         /**
          * Writes a string to the screen, starting at the specified coordinates.
diff --git a/packages/common/components/internet.d.ts b/packages/common/components/internet.d.ts
@@ -61,9 +61,8 @@ declare namespace OC.Components {
 
         /**
          * Get response code, message and headers.
-         * @tupleReturn
          */
-        response(): [number, string, any];
+        response(): LuaMultiReturn<[number, string, any]>;
 
         /**
          * Closes an open socket stream.
diff --git a/packages/common/components/inventory_controller.d.ts b/packages/common/components/inventory_controller.d.ts
@@ -8,9 +8,8 @@ declare namespace OC.Components {
         /**
          * Get the size of the inventory at the specified side.
          * @returns the size of the inventory, or null followed by a description why this function failed (usually no inventory).
-         * @tupleReturn
          */
-        getInventorySize(side: number): number | [boolean, string];
+        getInventorySize(side: number): LuaMultiReturn<[number] | [boolean, string]>;
 
         /**
          * Get a table describing the item in the specified slot or nil. Deprecated for getting info about robot's own inventory, see getStackInInternalSlot.
diff --git a/packages/common/computer.d.ts b/packages/common/computer.d.ts
@@ -115,9 +115,8 @@ declare namespace OC {
          * Tries to pull a signal from the queue, waiting up to the specified amount of time before failing and returning nil.
          * If no timeout is specified waits forever.
          * The first returned result is the signal name, following results correspond to what was pushed in pushSignal, for example.
-         * @tupleReturn
          */
-        pullSignal<T extends any[]>(timeout?: number): [string, ...T];
+        pullSignal<T extends any[]>(timeout?: number): LuaMultiReturn<[string, ...T]>;
 
         /**
          * Causes the computer to produce a beep sound at frequency Hz for duration seconds.
diff --git a/packages/dbuf/DoubleBuffering.d.ts b/packages/dbuf/DoubleBuffering.d.ts
@@ -7,9 +7,8 @@ declare module "doubleBuffering" {
     /**
      * Get screen buffer resolution.
      * There's also `buffer.getWidth()` and `buffer.getHeight()` methods for your comfort.
-     * @tupleReturn
      */
-    function getResolution(): [number, number];
+    function getResolution(): LuaMultiReturn<[number, number]>;
 
     /**
      * Set screen buffer and GPU resolution.
@@ -51,9 +50,8 @@ declare module "doubleBuffering" {
 
     /**
      * Get currently set draw limit
-     * @tupleReturn
      */
-    function getDrawLimit(): [number, number, number, number];
+    function getDrawLimit(): LuaMultiReturn<[number, number, number, number]>;
 
     /**
      * Copy content of specified area from screen buffer and return it as a table.
@@ -80,9 +78,8 @@ declare module "doubleBuffering" {
 
     /**
      * Get value of specified pixel on screen.
-     * @tupleReturn
      */
-    function get(x: number, y: number): [number, number, string];
+    function get(x: number, y: number): LuaMultiReturn<[number, number, string]>;
 
     /**
      * Fill the rectangular area with the specified pixel data.
@@ -196,9 +193,8 @@ declare module "doubleBuffering" {
 
     /**
      * Get data values of pixel with specified index.
-     * @tupleReturn
      */
-    function rawGet(index: number): [number, number, string];
+    function rawGet(index: number): LuaMultiReturn<[number, number, string]>;
 }
 
 type PixelData = number[][];
diff --git a/packages/gui/GUI.d.ts b/packages/gui/GUI.d.ts
@@ -360,9 +360,8 @@ declare namespace GUI {
 
         /**
          *  Get current margins in pixels of specified cell
-         * @tupleReturn
          */
-        getMargin(column: number, row: number): [number, number, number];
+        getMargin(column: number, row: number): LuaMultiReturn<[number, number, number]>;
 
         /**
          * Assign the specified grid cell automatic resizing of child objects by horizonal, vertical or both directions.
@@ -426,9 +425,8 @@ declare namespace GUI {
 
         /**
          * Get current margins in pixels of List
-         * @tupleReturn
          */
-        getMargin(): [number, number, number];
+        getMargin(): LuaMultiReturn<[number, number, number]>;
     }
 
     interface Menu extends GUI.Layout {
diff --git a/packages/mineos/System.d.ts b/packages/mineos/System.d.ts
@@ -33,9 +33,8 @@ declare module "System" {
      * since multiple characters following a single - will be interpreted as multiple options.
      * Options specified with 2 dashes are not split and can have multiple letters.
      * Also, 2-dash options can be given values by using an equal sign.
-     * @tupleReturn
      */
-    export function parseArguments(): [string[], Option[]];
+    export function parseArguments(): LuaMultiReturn<[string[], Option[]]>;
 
     /**
      * Creates an shortcut with .lnk extension by given where path.
@@ -102,10 +101,9 @@ declare module "System" {
      * Adds instance of `GUI.window` object to MineOS windows container, adds corresponding icon to dock and adds window menu data.
      * If `keepCoordinates` argument is set, window coordinates will be kept, otherwise window will be centered.
      * Returns pointer to main system `GUI.workspace` object, a pointer to given window object and a pointer to system `GUI.menu` object.
-     * @tupleReturn
      */
     export function addWindow(
         window: GUI.Window,
         keepCoordinates?: boolean
-    ): [GUI.Workspace, GUI.Window, GUI.Menu];
+    ): LuaMultiReturn<[GUI.Workspace, GUI.Window, GUI.Menu]>;
 }
diff --git a/packages/openos/event.d.ts b/packages/openos/event.d.ts
@@ -32,24 +32,21 @@ declare module "event" {
 
     /**
      * Pulls and returns the next available event from the queue, or waits until one becomes available.
-     * @tupleReturn
      */
-    function pull<T extends OC.EventType>(event: T): [T, ...OC.EventMap[T]];
-    function pull<T extends any[]>(event: string): [string, ...T];
+    function pull<T extends OC.EventType>(event: T): LuaMultiReturn<[T, ...OC.EventMap[T]]>;
+    function pull<T extends any[]>(event: string): LuaMultiReturn<[string, ...T]>;
 
     /**
      * Pulls and returns the next available event from the queue,
      * or waits until one becomes available but allows filtering by specifying filter function.
-     * @tupleReturn
      */
-    function pullFiltered(timeout?: number, filter?: Function): [string, ...any[]];
+    function pullFiltered(timeout?: number, filter?: Function): LuaMultiReturn<[string, ...any[]]>;
 
     /**
      * As its arguments pullMultiple accepts multiple event names to be pulled,
      * allowing basic filtering of multiple events at once.
-     * @tupleReturn
      */
-    function pullMultiple(...events: string[]): [string, ...any[]];
+    function pullMultiple(...events: string[]): LuaMultiReturn<[string, ...any[]]>;
 
     /**
      * Global event callback error handler.
diff --git a/packages/openos/filesystem.d.ts b/packages/openos/filesystem.d.ts
@@ -45,15 +45,13 @@ declare module "filesystem" {
     /**
      * This is similar to component.proxy,
      * except that the specified string may also be a file system component's label.
-     * @tupleReturn
      */
-    function proxy(filter: string): [any, string];
+    function proxy(filter: string): LuaMultiReturn<[any, string]>;
 
     /**
      * Mounts a file system at the specified path.
-     * @tupleReturn
      */
-    function mount(fs: any, path: string): [boolean | null, string];
+    function mount(fs: any, path: string): LuaMultiReturn<[boolean | null, string]>;
 
     /**
      * Returns an iterator function over all currently mounted file system component's proxies
@@ -69,22 +67,19 @@ declare module "filesystem" {
     /**
      * Checks if the object at the specified path is a symlink,
      * if so returns the path to where it links.
-     * @tupleReturn
      */
-    function isLink(path: string): [boolean, string | null];
+    function isLink(path: string): LuaMultiReturn<[boolean, string | null]>;
 
     /**
      * Creates a symbolic link to the specified target path at the specified path.
-     * @tupleReturn
      */
-    function link(target: string, linkpath: string): [boolean | null, string];
+    function link(target: string, linkpath: string): LuaMultiReturn<[boolean | null, string]>;
 
     /**
      * Gets the file system component's proxy that contains the specified path.
      * Returns the proxy and mount path, or `null` and an error message.
-     * @tupleReturn
      */
-    function get(path: string): [any, string];
+    function get(path: string): LuaMultiReturn<[any, string]>;
 
     /**
      * Checks whether a file or folder exist at the specified path.
@@ -112,32 +107,28 @@ declare module "filesystem" {
     /**
      * Returns an iterator over all elements in the directory at the specified path.
      * Returns null and an error messages if the path is invalid or some other error occurred.
-     * @tupleReturn
      */
-    function list(path: string): [LuaIterable<string> | null, string];
+    function list(path: string): LuaMultiReturn<[LuaIterable<string> | null, string]>;
 
     /**
      * Creates a new directory at the specified path.
      * Creates any parent directories that do not exist yet, if necessary.
      * Returns true on success, null and an error message otherwise.
-     * @tupleReturn
      */
-    function makeDirectory(path: string): [true | null, string];
+    function makeDirectory(path: string): LuaMultiReturn<[true | null, string]>;
 
     /**
      * Deletes a file or folder. If the path specifies a folder,
      * deletes all files and subdirectories in the folder, recursively.
      * Return true on success, null and an error message otherwise.
-     * @tupleReturn
      */
-    function remove(path: string): [true | null, string];
+    function remove(path: string): LuaMultiReturn<[true | null, string]>;
 
     /**
      * Renames a file or folder.
      * If the paths point to different file system components this will only work for files,
      * because it actually perform a copy operation, followed by a deletion if the copy succeeds.
      * Returns true on success, null and an error message otherwise.
-     * @tupleReturn
      */
-    function rename(oldPath: string, newPath: string): [true | null, string];
+    function rename(oldPath: string, newPath: string): LuaMultiReturn<[true | null, string]>;
 }
diff --git a/packages/openos/robot.d.ts b/packages/openos/robot.d.ts
diff --git a/packages/openos/term.d.ts b/packages/openos/term.d.ts
diff --git a/packages/openos/thread.d.ts b/packages/openos/thread.d.ts
diff --git a/yarn.lock b/yarn.lock
