@defold-typescript/types 0.53.0 → 0.54.0

package/fixtures/defold-1.13.2/liveupdate_doc.json

@@ -0,0 +1,221 @@
+{
+  "elements": [
+    {
+      "type": "ENUM",
+      "name": "liveupdate.LIVEUPDATE",
+      "brief": "LiveUpdate values",
+      "description": "LiveUpdate values",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "liveupdate.LIVEUPDATE_BUNDLED_RESOURCE_MISMATCH",
+          "doc": "Mismatch between between expected bundled resources and actual bundled resources. The manifest expects a resource to be in the bundle, but it was not found in the bundle. This is typically the case when a non-excluded resource was modified between publishing the bundle and publishing the manifest.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_ENGINE_VERSION_MISMATCH",
+          "doc": "Mismatch between running engine version and engine versions supported by manifest.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_FORMAT_ERROR",
+          "doc": "Failed to parse manifest data buffer. The manifest was probably produced by a different engine version.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_INVAL",
+          "doc": "Argument was invalid",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_INVALID_HEADER",
+          "doc": "The handled resource is invalid.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_INVALID_RESOURCE",
+          "doc": "The header of the resource is invalid.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_IO_ERROR",
+          "doc": "I/O operation failed",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_MEM_ERROR",
+          "doc": "Memory wasn't allocated",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_OK",
+          "doc": "Operation completed successfully.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_SCHEME_MISMATCH",
+          "doc": "Mismatch between scheme used to load resources. Resources are loaded with a different scheme than from manifest, for example over HTTP or directly from file. This is typically the case when running the game directly from the editor instead of from a bundle.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_SIGNATURE_MISMATCH",
+          "doc": "Mismatch between expected and actual integrity data for legacy liveupdate verification.",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_UNKNOWN",
+          "doc": "Unspecified error",
+          "type": ""
+        },
+        {
+          "name": "liveupdate.LIVEUPDATE_VERSION_MISMATCH",
+          "doc": "Mismatch between manifest expected version and actual version.",
+          "type": ""
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "liveupdate.get_mounts",
+      "brief": "Get current mounts",
+      "description": "Get an array of the current mounts\nThis can be used to determine if a new mount is needed or not",
+      "returnvalues": [
+        {
+          "name": "mounts",
+          "doc": "Array of mounts",
+          "types": ["{ name:hash, uri:string, priority:integer }[]"]
+        }
+      ],
+      "parameters": [],
+      "examples": "Output the current resource mounts\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">pprint</span><span class=\"p\">(</span><span class=\"s2\">&quot;MOUNTS&quot;</span><span class=\"p\">,</span> <span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">get_mounts</span><span class=\"p\">())</span>\n</code></pre></div>\n\nGive an output like:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">DEBUG</span><span class=\"p\">:</span><span class=\"n\">SCRIPT</span><span class=\"p\">:</span> <span class=\"n\">MOUNTS</span><span class=\"p\">,</span>\n<span class=\"p\">{</span> <span class=\"cm\">--[[0x119667bf0]]</span>\n  <span class=\"mi\">1</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"cm\">--[[0x119667c50]]</span>\n    <span class=\"n\">name</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">:</span> <span class=\"p\">[</span><span class=\"n\">liveupdate</span><span class=\"p\">],</span>\n    <span class=\"n\">uri</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;zip:/device/path/to/acchives/liveupdate.zip&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">priority</span> <span class=\"o\">=</span> <span class=\"mi\">5</span>\n  <span class=\"p\">},</span>\n  <span class=\"mi\">2</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"cm\">--[[0x119667d50]]</span>\n    <span class=\"n\">name</span> <span class=\"o\">=</span> <span class=\"n\">hash</span><span class=\"p\">:</span> <span class=\"p\">[</span><span class=\"n\">_base</span><span class=\"p\">],</span>\n    <span class=\"n\">uri</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;archive:build/default/game.dmanifest&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">priority</span> <span class=\"o\">=</span> <span class=\"o\">-</span><span class=\"mi\">10</span>\n  <span class=\"p\">}</span>\n<span class=\"p\">}</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "Any mount with priority < 0 is considered a base archive and it cannot be removed. All other mounts are considered \"live update\" content"
+      ],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "liveupdate.add_mount",
+      "brief": "Add resource mount",
+      "description": "Adds a resource mount to the resource system.\nAfter the mount succeeded, the resources are available to load. (i.e. no reboot required)",
+      "returnvalues": [
+        {
+          "name": "result",
+          "doc": "The result of the request",
+          "types": ["liveupdate.LIVEUPDATE"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "name",
+          "doc": "Unique name of the mount",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        },
+        {
+          "name": "uri",
+          "doc": "The uri of the mount, including the scheme. Currently supported schemes are 'zip' and 'archive'.",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "priority",
+          "doc": "Priority of mount. Larger priority takes prescedence",
+          "types": ["integer"],
+          "is_optional": "False"
+        },
+        {
+          "name": "callback",
+          "doc": "Callback after the asynchronous request completed\n- <code>name</code> <span class=\"type\">hash</span> Unique name of the mount\n- <code>uri</code> <span class=\"type\">string</span> The uri of the mount\n- <code>result</code> <span class=\"type\">liveupdate.LIVEUPDATE</span> The result of the request",
+          "types": [
+            "fun(self:script_instance, name:hash, uri:string, result:liveupdate.LIVEUPDATE)"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Add multiple mounts. Higher priority takes precedence.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">add_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;common&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;zip:/path/to/common_stuff.zip&quot;</span><span class=\"p\">,</span> <span class=\"mi\">10</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\">name</span><span class=\"p\">,</span> <span class=\"n\">uri</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span> <span class=\"kr\">end</span><span class=\"p\">)</span> <span class=\"c1\">-- base pack</span>\n<span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">add_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;levelpack_1&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;zip:/path/to/levels_1_to_20.zip&quot;</span><span class=\"p\">,</span> <span class=\"mi\">20</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\">name</span><span class=\"p\">,</span> <span class=\"n\">uri</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span> <span class=\"kr\">end</span><span class=\"p\">)</span> <span class=\"c1\">-- level pack</span>\n<span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">add_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;season_pack_1&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;zip:/path/to/easter_pack_1.zip&quot;</span><span class=\"p\">,</span> <span class=\"mi\">30</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\">name</span><span class=\"p\">,</span> <span class=\"n\">uri</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span> <span class=\"kr\">end</span><span class=\"p\">)</span> <span class=\"c1\">-- season pack, overriding content in the other packs</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "The request is asynchronous",
+        "Mounts are active for the current session only",
+        "Names cannot be '_base' or '_builtin'",
+        "Priority must be >= 0"
+      ],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "liveupdate.remove_mount",
+      "brief": "Remove resource mount",
+      "description": "Remove a mount the resource system.\nRemoving a mount does not affect any loaded resources.",
+      "returnvalues": [
+        {
+          "name": "result",
+          "doc": "The result of the call",
+          "types": ["liveupdate.LIVEUPDATE"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "name",
+          "doc": "Unique name of the mount",
+          "types": ["string", "hash"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Add multiple mounts. Higher priority takes precedence.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">remove_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;season_pack_1&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": ["The call is synchronous", "Names cannot be '_base' or '_builtin'"],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "liveupdate.is_built_with_excluded_files",
+      "brief": "check if the build contains excluded live update resources",
+      "description": "Checks if the bundled application was built with one or more resources\nexcluded from the main bundle, through a collection proxy with\n<code>Exclude</code> enabled.\nThis value is based on metadata in the bundled manifest. It does not check\nwhether any live update archive has been mounted or whether the excluded\nresources are currently available on device.",
+      "returnvalues": [
+        {
+          "name": "is_built_with_excluded_files",
+          "doc": "true if the bundled application was built with excluded files",
+          "types": ["boolean"]
+        }
+      ],
+      "parameters": [],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">if</span> <span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">is_built_with_excluded_files</span><span class=\"p\">()</span> <span class=\"kr\">then</span>\n    <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"s2\">&quot;The bundle expects live update content.&quot;</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "liveupdate",
+    "name": "LiveUpdate",
+    "brief": "LiveUpdate API documentation",
+    "description": "Functions and constants to access resources.",
+    "path": "engine/liveupdate/src/script_liveupdate.h",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}