@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.13.0/editor_tilemap_tiles_doc.json

@@ -0,0 +1,235 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.new",
+      "brief": "create a new unbounded 2d grid data structure for storing tilemap layer tiles",
+      "description": "Create a new unbounded 2d grid data structure for storing tilemap layer tiles",
+      "returnvalues": [
+        { "name": "tiles", "doc": "unbounded 2d grid of tiles", "types": ["tiles"] }
+      ],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.get_tile",
+      "brief": "get a tile index at a particular coordinate",
+      "description": "Get a tile index at a particular coordinate",
+      "returnvalues": [
+        {
+          "name": "tile_index",
+          "doc": "1-indexed tile index of a tilemap's tilesource",
+          "types": ["integer"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["tiles"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x",
+          "doc": "x coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        },
+        {
+          "name": "y",
+          "doc": "y coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.get_info",
+      "brief": "get full information from a tile at a particular coordinate",
+      "description": "Get full information from a tile at a particular coordinate",
+      "returnvalues": [
+        {
+          "name": "info",
+          "doc": "full tile information table with the following keys:<dl><dt><code>index <small>integer</small></code></dt><dd>1-indexed tile index of a tilemap's tilesource</dd><dt><code>h_flip <small>boolean</small></code></dt><dd>horizontal flip</dd><dt><code>v_flip <small>boolean</small></code></dt><dd>vertical flip</dd><dt><code>rotate_90 <small>boolean</small></code></dt><dd>whether the tile is rotated 90 degrees clockwise</dd></dl>",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["tiles"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x",
+          "doc": "x coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        },
+        {
+          "name": "y",
+          "doc": "y coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.iterator",
+      "brief": "create an iterator over all tiles in a tiles data structure",
+      "description": "Create an iterator over all tiles in a tiles data structure\nWhen iterating using for loop, each iteration returns x, y and tile index of a tile in a tile map",
+      "returnvalues": [{ "name": "iter", "doc": "iterator", "types": ["function"] }],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["tiles"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Iterate over all tiles in a tile map:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"k\">local</span><span class=\"w\"> </span><span class=\"n\">layers</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"n\">editor</span><span class=\"p\">.</span><span class=\"k\">get</span><span class=\"p\">(</span><span class=\"ss\">&quot;/level.tilemap&quot;</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"ss\">&quot;layers&quot;</span><span class=\"p\">)</span><span class=\"w\"></span>\n<span class=\"k\">for</span><span class=\"w\"> </span><span class=\"n\">i</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"mi\">1</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"n\">#layers</span><span class=\"w\"> </span><span class=\"n\">do</span><span class=\"w\"></span>\n<span class=\"w\">  </span><span class=\"k\">local</span><span class=\"w\"> </span><span class=\"n\">tiles</span><span class=\"w\"> </span><span class=\"o\">=</span><span class=\"w\"> </span><span class=\"n\">editor</span><span class=\"p\">.</span><span class=\"k\">get</span><span class=\"p\">(</span><span class=\"n\">layers</span><span class=\"o\">[</span><span class=\"n\">i</span><span class=\"o\">]</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"ss\">&quot;tiles&quot;</span><span class=\"p\">)</span><span class=\"w\"></span>\n<span class=\"w\">  </span><span class=\"k\">for</span><span class=\"w\"> </span><span class=\"n\">x</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"n\">y</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"n\">i</span><span class=\"w\"> </span><span class=\"ow\">in</span><span class=\"w\"> </span><span class=\"n\">tilemap</span><span class=\"p\">.</span><span class=\"n\">tiles</span><span class=\"p\">.</span><span class=\"n\">iterator</span><span class=\"p\">(</span><span class=\"n\">tiles</span><span class=\"p\">)</span><span class=\"w\"> </span><span class=\"n\">do</span><span class=\"w\"></span>\n<span class=\"w\">    </span><span class=\"k\">print</span><span class=\"p\">(</span><span class=\"n\">x</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"n\">y</span><span class=\"p\">,</span><span class=\"w\"> </span><span class=\"n\">i</span><span class=\"p\">)</span><span class=\"w\"></span>\n<span class=\"w\">  </span><span class=\"k\">end</span><span class=\"w\"></span>\n<span class=\"k\">end</span><span class=\"w\"></span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.clear",
+      "brief": "remove all tiles",
+      "description": "Remove all tiles",
+      "returnvalues": [
+        { "name": "tiles", "doc": "unbounded 2d grid of tiles", "types": ["tiles"] }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["tiles"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.set",
+      "brief": "set a tile at a particular coordinate",
+      "description": "Set a tile at a particular coordinate",
+      "returnvalues": [
+        { "name": "tiles", "doc": "unbounded 2d grid of tiles", "types": ["tiles"] }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["tiles"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x",
+          "doc": "x coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        },
+        {
+          "name": "y",
+          "doc": "y coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        },
+        {
+          "name": "tile_or_info",
+          "doc": "Either 1-indexed tile index of a tilemap's tilesource or full tile information table with the following keys:<dl><dt><code>index <small>integer</small></code></dt><dd>1-indexed tile index of a tilemap's tilesource</dd><dt><code>h_flip <small>boolean</small></code></dt><dd>horizontal flip</dd><dt><code>v_flip <small>boolean</small></code></dt><dd>vertical flip</dd><dt><code>rotate_90 <small>boolean</small></code></dt><dd>whether the tile is rotated 90 degrees clockwise</dd></dl>",
+          "types": ["integer", "table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "tilemap.tiles.remove",
+      "brief": "remove a tile at a particular coordinate",
+      "description": "Remove a tile at a particular coordinate",
+      "returnvalues": [
+        { "name": "tiles", "doc": "unbounded 2d grid of tiles", "types": ["tiles"] }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["tiles"],
+          "is_optional": "False"
+        },
+        {
+          "name": "x",
+          "doc": "x coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        },
+        {
+          "name": "y",
+          "doc": "y coordinate of a tile",
+          "types": ["integer"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "tilemap.tiles",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.13.0/editor_zip_doc.json

@@ -0,0 +1,163 @@
+{
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "zip.METHOD.DEFLATED",
+      "brief": "<code>\"deflated\"</code> compression method",
+      "description": "<code>\"deflated\"</code> compression method",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "VARIABLE",
+      "name": "zip.METHOD.STORED",
+      "brief": "<code>\"stored\"</code> compression method, i.e. no compression",
+      "description": "<code>\"stored\"</code> compression method, i.e. no compression",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "VARIABLE",
+      "name": "zip.ON_CONFLICT.ERROR",
+      "brief": "<code>\"error\"</code>, any conflict aborts extraction",
+      "description": "<code>\"error\"</code>, any conflict aborts extraction",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "VARIABLE",
+      "name": "zip.ON_CONFLICT.SKIP",
+      "brief": "<code>\"skip\"</code>, existing file is preserved",
+      "description": "<code>\"skip\"</code>, existing file is preserved",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "VARIABLE",
+      "name": "zip.ON_CONFLICT.OVERWRITE",
+      "brief": "<code>\"skip\"</code>, existing file is overwritten",
+      "description": "<code>\"skip\"</code>, existing file is overwritten",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "zip.pack",
+      "brief": "create a ZIP archive",
+      "description": "Create a ZIP archive",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "output_path",
+          "doc": "output zip file path, resolved against project root if relative",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "opts",
+          "doc": "compression options, a table with the following keys:<dl><dt><code>method <small>string</small></code></dt><dd>compression method, either <code>zip.METHOD.DEFLATED</code> (default) or <code>zip.METHOD.STORED</code></dd><dt><code>level <small>integer</small></code></dt><dd>compression level, an integer between 0 and 9, only useful when the compression method is <code>zip.METHOD.DEFLATED</code>; defaults to 6</dd></dl>",
+          "types": ["table"],
+          "is_optional": "True"
+        },
+        {
+          "name": "entries",
+          "doc": "entries to compress, either a string (relative path to file or folder to include) or a table with the following keys:<dl><dt><code>1 <small>string</small></code></dt><dd>required; source file or folder path to include, resolved against project root if relative</dd><dt><code>2 <small>string</small></code></dt><dd>optional; target file or folder path in the zip archive. May be omitted if source is a relative path that does not go above the project directory.</dd><dt><code>method <small>string</small></code></dt><dd>compression method, either <code>zip.METHOD.DEFLATED</code> (default) or <code>zip.METHOD.STORED</code></dd><dt><code>level <small>integer</small></code></dt><dd>compression level, an integer between 0 and 9, only useful when the compression method is <code>zip.METHOD.DEFLATED</code>; defaults to 6</dd></dl>",
+          "types": ["string", "table"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Archive a file and a folder:\n<div class=\"codehilite\"><pre><span></span><code>zip.pack(&quot;build.zip&quot;, {&quot;build&quot;, &quot;game.project&quot;})\n</code></pre></div>\n\nChange the location of the files within the archive:\n<div class=\"codehilite\"><pre><span></span><code>zip.pack(&quot;build.zip&quot;, {\n  {&quot;build/wasm-web&quot;, &quot;.&quot;},\n  {&quot;configs/prod.json&quot;, &quot;config.json&quot;}\n})\n</code></pre></div>\n\nCreate archive without compression (much faster to create the archive, bigger archive file size, allows mmap access):\n<div class=\"codehilite\"><pre><span></span><code>zip.pack(&quot;build.zip&quot;, {method = zip.METHOD.STORED}, {\n  &quot;build&quot;,\n  &quot;resources&quot;\n})\n</code></pre></div>\n\nDon't compress one of the folders:\n<div class=\"codehilite\"><pre><span></span><code>zip.pack(&quot;build.zip&quot;, {\n  {&quot;assets&quot;, method = zip.METHOD.STORED},\n  &quot;build/wasm-web&quot;\n})\n</code></pre></div>\n\nInclude files from outside the project:\n<div class=\"codehilite\"><pre><span></span><code>zip.pack(&quot;build.zip&quot;, {\n  &quot;build&quot;,\n  {&quot;../secrets/auth-key.txt&quot;, &quot;auth-key.txt&quot;}\n})\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "zip.unpack",
+      "brief": "extract a ZIP archive",
+      "description": "Extract a ZIP archive",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "archive_path",
+          "doc": "zip file path, resolved against project root if relative",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "target_path",
+          "doc": "target path for extraction, defaults to parent of <code>archive_path</code> if omitted",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "opts",
+          "doc": "extraction options, a table with the following keys:<dl><dt><code>on_conflict <small>string</small></code></dt><dd>conflict resolution strategy, defaults to <code>zip.ON_CONFLICT.ERROR</code></dd></dl>",
+          "types": ["table"],
+          "is_optional": "True"
+        },
+        {
+          "name": "paths",
+          "doc": "entries to extract, relative string paths",
+          "types": ["table"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "Extract everything to a build dir:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">zip</span><span class=\"p\">.</span><span class=\"n\">unpack</span><span class=\"p\">(</span><span class=\"s2\">&quot;build/dev/resources.zip&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n\nExtract to a different directory:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">zip</span><span class=\"p\">.</span><span class=\"n\">unpack</span><span class=\"p\">(</span>\n  <span class=\"s2\">&quot;build/dev/resources.zip&quot;</span><span class=\"p\">,</span>\n  <span class=\"s2\">&quot;build/dev/tmp&quot;</span><span class=\"p\">,</span>\n<span class=\"p\">)</span>\n</code></pre></div>\n\nExtract while overwriting existing files on conflict:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">zip</span><span class=\"p\">.</span><span class=\"n\">unpack</span><span class=\"p\">(</span>\n  <span class=\"s2\">&quot;build/dev/resources.zip&quot;</span><span class=\"p\">,</span>\n  <span class=\"p\">{</span><span class=\"n\">on_conflict</span> <span class=\"o\">=</span> <span class=\"n\">zip</span><span class=\"p\">.</span><span class=\"n\">ON_CONFLICT</span><span class=\"p\">.</span><span class=\"n\">OVERWRITE</span><span class=\"p\">}</span>\n<span class=\"p\">)</span>\n</code></pre></div>\n\nExtract a single file:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">zip</span><span class=\"p\">.</span><span class=\"n\">unpack</span><span class=\"p\">(</span>\n  <span class=\"s2\">&quot;build/dev/resources.zip&quot;</span><span class=\"p\">,</span>\n  <span class=\"p\">{</span><span class=\"s2\">&quot;config.json&quot;</span><span class=\"p\">}</span>\n<span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "zip",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}

package/fixtures/defold-1.13.0/editor_zlib_doc.json

@@ -0,0 +1,48 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "zlib.deflate",
+      "brief": "deflate (compress) a buffer",
+      "description": "Deflate (compress) a buffer",
+      "returnvalues": [{ "name": "buf", "doc": "deflated buffer", "types": ["string"] }],
+      "parameters": [
+        { "name": "buf", "doc": "buffer to deflate", "types": ["string"], "is_optional": "False" }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "zlib.inflate",
+      "brief": "inflate (decompress) a buffer",
+      "description": "Inflate (decompress) a buffer",
+      "returnvalues": [{ "name": "buf", "doc": "inflated buffer", "types": ["string"] }],
+      "parameters": [
+        { "name": "buf", "doc": "buffer to inflate", "types": ["string"], "is_optional": "False" }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "zlib",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "engine/docs/editor.apidoc",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}