@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.14.0/editor_json_doc.json

@@ -0,0 +1,81 @@
+{
+  "elements": [
+    {
+      "type": "STRUCT",
+      "name": "json.decode.options",
+      "brief": "options for json.decode",
+      "description": "Options for json.decode",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "all?",
+          "doc": "if true, decodes all JSON values in a string and returns an array",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "json.decode",
+      "brief": "decode JSON string to Lua value",
+      "description": "Decode JSON string to Lua value",
+      "returnvalues": [],
+      "parameters": [
+        { "name": "json", "doc": "json data", "types": ["string"], "is_optional": "False" },
+        {
+          "name": "options",
+          "doc": "decoding options",
+          "types": ["json.decode.options"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "json.encode",
+      "brief": "encode Lua value to JSON string",
+      "description": "Encode Lua value to JSON string",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "value",
+          "doc": "any Lua value that may be represented as JSON",
+          "types": ["any"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "json",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}

package/fixtures/defold-1.14.0/editor_localization_doc.json

@@ -0,0 +1,139 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "localization.message",
+      "brief": "create a message pattern for a localization key defined in an <code>.editor_localization</code> file; the actual localization happens when the returned value is stringified",
+      "description": "Create a message pattern for a localization key defined in an <code>.editor_localization</code> file; the actual localization happens when the returned value is stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["editor.message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "key",
+          "doc": "localization key defined in an <code>.editor_localization</code> file",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "vars",
+          "doc": "optional table with variables to be substituted in the localized string that uses <a href=\"https://unicode-org.github.io/icu/userguide/format_parse/messages/\">ICU Message Format</a> syntax; keys must be strings; values must be either <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["table<string, nil|boolean|number|string|editor.message>"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "localization.and_list",
+      "brief": "create a message pattern that renders a list with the \"and\" conjunction (for example: a, b, and c) once it is stringified",
+      "description": "Create a message pattern that renders a list with the \"and\" conjunction (for example: a, b, and c) once it is stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["editor.message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "items",
+          "doc": "array of values; each value may be <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["(nil|boolean|number|string|editor.message)[]"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "localization.or_list",
+      "brief": "create a message pattern that renders a list with the \"or\" conjunction (for example: a, b, or c) once it is stringified",
+      "description": "Create a message pattern that renders a list with the \"or\" conjunction (for example: a, b, or c) once it is stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["editor.message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "items",
+          "doc": "array of values; each value may be <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["(nil|boolean|number|string|editor.message)[]"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "localization.concat",
+      "brief": "create a message pattern that concatenates values (similar to <code>table.concat</code>) and performs the actual concatenation when stringified",
+      "description": "Create a message pattern that concatenates values (similar to <code>table.concat</code>) and performs the actual concatenation when stringified",
+      "returnvalues": [
+        {
+          "name": "message",
+          "doc": "a userdata value that, when stringified with <code>tostring()</code>, will produce a localized text according to the currently selected language in the editor",
+          "types": ["editor.message"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "items",
+          "doc": "array of values; each value may be <code>nil</code>, <code>boolean</code>, <code>number</code>, <code>string</code>, or another <code>message</code> instance",
+          "types": ["(nil|boolean|number|string|editor.message)[]"],
+          "is_optional": "False"
+        },
+        {
+          "name": "separator",
+          "doc": "optional separator inserted between values; defaults to an empty string",
+          "types": ["nil", "boolean", "number", "string", "editor.message"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "localization",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}

package/fixtures/defold-1.14.0/editor_pprint_doc.json

@@ -0,0 +1,37 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "pprint",
+      "brief": "pretty-print Lua values",
+      "description": "Pretty-print Lua values",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "...",
+          "doc": "Lua values to pretty-print",
+          "types": ["any"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "pprint",
+    "name": "Editor",
+    "brief": "Editor scripting documentation",
+    "description": "Editor scripting documentation",
+    "path": "",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}

package/fixtures/defold-1.14.0/editor_tilemap_tiles_doc.json

@@ -0,0 +1,292 @@
+{
+  "elements": [
+    {
+      "type": "STRUCT",
+      "name": "tilemap.tiles.get_info.result",
+      "brief": "full tile information returned by tilemap.tiles.get_info",
+      "description": "Full tile information returned by tilemap.tiles.get_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "index",
+          "doc": "1-indexed tile index of a tilemap's tilesource",
+          "type": "integer"
+        },
+        { "name": "h_flip", "doc": "horizontal flip", "type": "boolean" },
+        { "name": "v_flip", "doc": "vertical flip", "type": "boolean" },
+        {
+          "name": "rotate_90",
+          "doc": "whether the tile is rotated 90 degrees clockwise",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "tilemap.tiles.set.info",
+      "brief": "tile information accepted by tilemap.tiles.set",
+      "description": "Tile information accepted by tilemap.tiles.set",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "index",
+          "doc": "1-indexed tile index of a tilemap's tilesource",
+          "type": "integer"
+        },
+        { "name": "h_flip?", "doc": "horizontal flip", "type": "boolean" },
+        { "name": "v_flip?", "doc": "vertical flip", "type": "boolean" },
+        {
+          "name": "rotate_90?",
+          "doc": "whether the tile is rotated 90 degrees clockwise",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "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": ["editor.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": ["editor.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, or nil if no tile is set at the coordinate",
+          "types": ["tilemap.tiles.get_info.result", "nil"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["editor.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": ["editor.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": ["editor.tiles"] }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["editor.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": ["editor.tiles"] }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["editor.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",
+          "types": ["integer", "tilemap.tiles.set.info"],
+          "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": ["editor.tiles"] }
+      ],
+      "parameters": [
+        {
+          "name": "tiles",
+          "doc": "unbounded 2d grid of tiles",
+          "types": ["editor.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": "",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}