@defold-typescript/types 0.53.0 → 0.54.0

package/fixtures/defold-1.13.2/editor_zip_doc.json

@@ -0,0 +1,237 @@
+{
+  "elements": [
+    {
+      "type": "TYPEDEF",
+      "name": "zip.pack.entry",
+      "brief": "zIP entry containing a source path, optional archive target path, and optional compression settings",
+      "description": "ZIP entry containing a source path, optional archive target path, and optional compression settings",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "value",
+          "doc": "zIP entry containing a source path, optional archive target path, and optional compression settings",
+          "types": ["{[1]:string, [2]?:string, method?:zip.METHOD, level?:integer}"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "zip.pack.entries",
+      "brief": "entries included in a ZIP archive",
+      "description": "Entries included in a ZIP archive",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "value",
+          "doc": "entries included in a ZIP archive",
+          "types": ["(string|zip.pack.entry)[]"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "zip.pack.options",
+      "brief": "options for zip.pack",
+      "description": "Options for zip.pack",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "method?",
+          "doc": "compression method, defaults to <code>zip.METHOD.DEFLATED</code>",
+          "type": "zip.METHOD"
+        },
+        {
+          "name": "level?",
+          "doc": "compression level from 0 to 9 for deflated entries; defaults to 6",
+          "type": "integer"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "zip.unpack.options",
+      "brief": "options for zip.unpack",
+      "description": "Options for zip.unpack",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        { "name": "on_conflict", "doc": "conflict resolution strategy", "type": "zip.ON_CONFLICT" }
+      ],
+      "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",
+          "types": ["zip.pack.options"],
+          "is_optional": "True"
+        },
+        {
+          "name": "entries",
+          "doc": "files and folders to include in the archive",
+          "types": ["zip.pack.entries"],
+          "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; conflict handling defaults to <code>zip.ON_CONFLICT.ERROR</code>",
+          "types": ["zip.unpack.options"],
+          "is_optional": "True"
+        },
+        {
+          "name": "paths",
+          "doc": "entries to extract, relative string paths",
+          "types": ["string[]"],
+          "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": ""
+    },
+    {
+      "type": "ENUM",
+      "name": "zip.METHOD",
+      "brief": "constants for zip compression methods",
+      "description": "Constants for zip compression methods",
+      "returnvalues": [],
+      "parameters": [
+        { "name": "value", "doc": "enum value", "types": ["string"], "is_optional": "False" }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "zip.METHOD.DEFLATED",
+          "doc": "<code>\"deflated\"</code> compression method",
+          "type": ""
+        },
+        {
+          "name": "zip.METHOD.STORED",
+          "doc": "<code>\"stored\"</code> compression method, i.e. no compression",
+          "type": ""
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "ENUM",
+      "name": "zip.ON_CONFLICT",
+      "brief": "constants defining conflict resolution strategies for zip archive extraction",
+      "description": "Constants defining conflict resolution strategies for zip archive extraction",
+      "returnvalues": [],
+      "parameters": [
+        { "name": "value", "doc": "enum value", "types": ["string"], "is_optional": "False" }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "zip.ON_CONFLICT.ERROR",
+          "doc": "<code>\"error\"</code>, any conflict aborts extraction",
+          "type": ""
+        },
+        {
+          "name": "zip.ON_CONFLICT.SKIP",
+          "doc": "<code>\"skip\"</code>, existing file is preserved",
+          "type": ""
+        },
+        {
+          "name": "zip.ON_CONFLICT.OVERWRITE",
+          "doc": "<code>\"overwrite\"</code>, existing file is overwritten",
+          "type": ""
+        }
+      ],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "zip",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}

package/fixtures/defold-1.13.2/editor_zlib_doc.json

@@ -0,0 +1,49 @@
+{
+  "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": "",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}

package/fixtures/defold-1.13.2/factory_doc.json

@@ -0,0 +1,206 @@
+{
+  "elements": [
+    {
+      "type": "ENUM",
+      "name": "factory.STATUS",
+      "brief": "Factory status values",
+      "description": "Factory status values",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "factory.STATUS_LOADED",
+          "doc": "The factory resources are loaded.",
+          "type": ""
+        },
+        {
+          "name": "factory.STATUS_LOADING",
+          "doc": "The factory resources are loading.",
+          "type": ""
+        },
+        {
+          "name": "factory.STATUS_UNLOADED",
+          "doc": "The factory resources are unloaded.",
+          "type": ""
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "factory.get_status",
+      "brief": "Get factory status",
+      "description": "This returns status of the factory.\nCalling this function when the factory is not marked as dynamic loading always returns\nfactory.STATUS_LOADED.",
+      "returnvalues": [
+        {
+          "name": "status",
+          "doc": "status of the factory component",
+          "types": ["factory.STATUS"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the factory component to get status from",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "factory.unload",
+      "brief": "Unload resources previously loaded using factory.load",
+      "description": "This decreases the reference count for each resource loaded with factory.load. If reference is zero, the resource is destroyed.\nCalling this function when the factory is not marked as dynamic loading does nothing.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the factory component to unload",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to unload resources of a factory prototype loaded with factory.load\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">factory</span><span class=\"p\">.</span><span class=\"n\">unload</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "factory.load",
+      "brief": "Load resources of a factory prototype.",
+      "description": "Resources are referenced by the factory component until the existing (parent) collection is destroyed or factory.unload is called.\nCalling this function when the factory is not marked as dynamic loading does nothing.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the factory component to load",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        },
+        {
+          "name": "complete_function",
+          "doc": "function to call when resources are loaded.\n<dl>\n<dt><code>self</code></dt>\n<dd><span class=\"type\">script_instance</span> The current script instance.</dd>\n<dt><code>url</code></dt>\n<dd><span class=\"type\">url</span> url of the factory component</dd>\n<dt><code>result</code></dt>\n<dd><span class=\"type\">boolean</span> True if resources were loaded successfully</dd>\n</dl>",
+          "types": ["fun(self:script_instance, url:url, result:boolean)"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to load resources of a factory prototype.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">factory</span><span class=\"p\">.</span><span class=\"n\">load</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">,</span> <span class=\"kr\">function</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">url</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span> <span class=\"kr\">end</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "factory.create",
+      "brief": "make a factory create a new game object",
+      "description": "The URL identifies which factory should create the game object.\nIf the game object is created inside of the frame (e.g. from an update callback), the game object will be created instantly, but none of its component will be updated in the same frame.\nProperties defined in scripts in the created game object can be overridden through the properties-parameter below.\nSee go.property for more information on script properties.\n<span class=\"icon-attention\"></span> Calling <a href=\"/ref/factory#factory.create\">factory.create</a> on a factory that is marked as dynamic without having loaded resources\nusing <a href=\"/ref/factory#factory.load\">factory.load</a> will synchronously load and create resources which may affect application performance.",
+      "returnvalues": [
+        {
+          "name": "id",
+          "doc": "the global id of the spawned game object",
+          "types": ["hash"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the factory that should create a game object.",
+          "types": ["string", "hash", "url"],
+          "is_optional": "False"
+        },
+        {
+          "name": "position",
+          "doc": "the position of the new game object, the position of the game object calling <code>factory.create()</code> is used by default, or if the value is <code>nil</code>.",
+          "types": ["vector3"],
+          "is_optional": "True"
+        },
+        {
+          "name": "rotation",
+          "doc": "the rotation of the new game object, the rotation of the game object calling <code>factory.create()</code> is used by default, or if the value is <code>nil</code>.",
+          "types": ["quaternion"],
+          "is_optional": "True"
+        },
+        {
+          "name": "properties",
+          "doc": "the properties defined in a script attached to the new game object.",
+          "types": ["table<string|hash, any>"],
+          "is_optional": "True"
+        },
+        {
+          "name": "scale",
+          "doc": "the scale of the new game object (must be greater than 0), the scale of the game object containing the factory is used by default, or if the value is <code>nil</code>",
+          "types": ["number", "vector3"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to create a new game object:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"c1\">-- create a new game object and provide property values</span>\n    <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_created_object</span> <span class=\"o\">=</span> <span class=\"n\">factory</span><span class=\"p\">.</span><span class=\"n\">create</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">,</span> <span class=\"kc\">nil</span><span class=\"p\">,</span> <span class=\"kc\">nil</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">my_value</span> <span class=\"o\">=</span> <span class=\"mi\">1</span><span class=\"p\">})</span>\n    <span class=\"c1\">-- communicate with the object</span>\n    <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">my_created_object</span><span class=\"p\">,</span> <span class=\"s2\">&quot;hello&quot;</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\nAnd then let the new game object have a script attached:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">property</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_value&quot;</span><span class=\"p\">,</span> <span class=\"mi\">0</span><span class=\"p\">)</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n    <span class=\"c1\">-- do something with self.my_value which is now one</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "factory.set_prototype",
+      "brief": "changes the prototype for the factory",
+      "description": "Changes the prototype for the factory.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "the factory component",
+          "types": ["string", "hash", "url"],
+          "is_optional": "True"
+        },
+        {
+          "name": "prototype",
+          "doc": "the path to the new prototype, or <code>nil</code>",
+          "types": ["string", "nil"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to unload the previous prototypes resources, and then spawn a new game object\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">factory</span><span class=\"p\">.</span><span class=\"n\">unload</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">)</span> <span class=\"c1\">-- unload the previous resources</span>\n<span class=\"n\">factory</span><span class=\"p\">.</span><span class=\"n\">set_prototype</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;/main/levels/enemyA.goc&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">id</span> <span class=\"o\">=</span> <span class=\"n\">factory</span><span class=\"p\">.</span><span class=\"n\">create</span><span class=\"p\">(</span><span class=\"s2\">&quot;#factory&quot;</span><span class=\"p\">,</span> <span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">get_world_position</span><span class=\"p\">(),</span> <span class=\"n\">vmath</span><span class=\"p\">.</span><span class=\"n\">quat</span><span class=\"p\">())</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "- Requires the factory to have the \"Dynamic Prototype\" set\n  - Cannot be set when the state is COMP_FACTORY_STATUS_LOADING\n  - Setting the prototype to `nil` will revert back to the original prototype."
+      ],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "factory",
+    "name": "Factory",
+    "brief": "Factory API documentation",
+    "description": "Functions for controlling factory components which are used to\ndynamically spawn game objects into the runtime.",
+    "path": "engine/gamesys/src/gamesys/scripts/script_factory.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}