@defold-typescript/library-types 0.23.0 → 0.25.0

package/api-doc/bridge.json

@@ -37,7 +37,8 @@
           "name": "result",
           "doc": "",
           "types": [
-            "string | nil"
+            "string",
+            "nil"
           ]
         }
       ]
@@ -52,7 +53,8 @@
           "name": "result",
           "doc": "",
           "types": [
-            "string | nil"
+            "string",
+            "nil"
           ]
         }
       ]
@@ -82,7 +84,8 @@
           "name": "result",
           "doc": "",
           "types": [
-            "string | nil"
+            "string",
+            "nil"
           ]
         }
       ]
@@ -684,7 +687,8 @@
           "name": "result",
           "doc": "",
           "types": [
-            "string | nil"
+            "string",
+            "nil"
           ]
         }
       ]
@@ -699,7 +703,8 @@
           "name": "result",
           "doc": "",
           "types": [
-            "string | nil"
+            "string",
+            "nil"
           ]
         }
       ]

package/api-doc/bzAnim.json

@@ -0,0 +1,338 @@
+{
+  "info": {
+    "namespace": "bzAnim",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "INFO_LEVEL",
+      "brief": "",
+      "description": "",
+      "types": []
+    },
+    {
+      "type": "VARIABLE",
+      "name": "DEBUG_LEVEL",
+      "brief": "",
+      "description": "",
+      "types": []
+    },
+    {
+      "type": "VARIABLE",
+      "name": "TRACE_LEVEL",
+      "brief": "",
+      "description": "",
+      "types": []
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "Path",
+      "properties": [
+        {
+          "name": "x",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "y",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "Segment",
+      "properties": [
+        {
+          "name": "duration",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "delay",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "path",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Array<Path>"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "AnimateArgs",
+      "properties": [
+        {
+          "name": "obj",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Hash | string | undefined"
+          ]
+        },
+        {
+          "name": "easing",
+          "brief": "",
+          "description": "",
+          "types": [
+            "EASING_TYPES"
+          ]
+        },
+        {
+          "name": "duration",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "delay",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "path",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Array<Path>"
+          ],
+          "is_optional": "True"
+        }
+      ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "AnimateSequenceArgs",
+      "properties": [
+        {
+          "name": "obj",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Hash | string | undefined"
+          ]
+        },
+        {
+          "name": "easing",
+          "brief": "",
+          "description": "",
+          "types": [
+            "EASING_TYPES"
+          ]
+        },
+        {
+          "name": "segments",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Array<Segment>"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "on_complete",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean | string"
+          ],
+          "is_optional": "True"
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "animate",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "args",
+          "doc": "",
+          "types": [
+            "AnimateArgs"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "string"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "animateSequence",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "args",
+          "doc": "",
+          "types": [
+            "AnimateSequenceArgs"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "string"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "cancel",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "id",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "info",
+      "brief": "",
+      "description": "",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "string"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "isReady",
+      "brief": "",
+      "description": "",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "setDebugLevel",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "level",
+          "doc": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "setMaxPoints",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "num",
+          "doc": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "registerController",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "obj",
+          "doc": "",
+          "types": [
+            "Hash | string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "unregisterController",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "obj",
+          "doc": "",
+          "types": [
+            "Hash | string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    }
+  ]
+}

package/api-doc/checkpoint.json

@@ -0,0 +1,127 @@
+{
+  "info": {
+    "namespace": "checkpoint",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "project_title",
+      "brief": "The `project.title` from game.project, read once when the module loads. It is",
+      "description": "The `project.title` from game.project, read once when the module loads. It is\nthe name the save directory is derived from.",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "project_save_path",
+      "brief": "The absolute path of the project's save directory, resolved once when the",
+      "description": "The absolute path of the project's save directory, resolved once when the\nmodule loads. Every path the other members take is relative to it, and `list`\nreturns paths relative to it. Ends with a separator, e.g.\n`/home/klaleus/.local/share/defold-checkpoint/`.",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "read",
+      "brief": "Loads a saved file. A path ending in `.json` is read as text and decoded with",
+      "description": "Loads a saved file. A path ending in `.json` is read as text and decoded with\n`json.decode`; anything else is loaded with `sys.load`. On success the loaded\nvalue is returned alone, so the error slot is absent; on any failure — the file\nmissing, unreadable, or holding invalid content — the first value is `false` and\nthe second is the error string. Name the saved shape through the type parameter\nto avoid casting at the call site.",
+      "generics": "<T = unknown>",
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "Path relative to `project_save_path`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "The loaded value, or `false` and the error that stopped it.",
+          "types": [
+            "LuaMultiReturn<[ T | false, string | undefined ]>"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "write",
+      "brief": "Saves a value, creating any missing directories along the path first. A path",
+      "description": "Saves a value, creating any missing directories along the path first. A path\nending in `.json` is encoded with `json.encode` and written as text and flushed\nimmediately; anything else is written with `sys.save`. Creating the directories\ngoes through `lfs`, so the project needs `britzl/defold-lfs` as a dependency;\nthis corpus does not type it.",
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "Path relative to `project_save_path`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "data",
+          "doc": "The value to save.",
+          "types": [
+            "unknown"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "`true`, or `false` and the error that stopped it.",
+          "types": [
+            "LuaMultiReturn<[ boolean, string | undefined ]>"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "exists",
+      "brief": "Whether a saved file exists. Returns a real boolean rather than the underlying",
+      "description": "Whether a saved file exists. Returns a real boolean rather than the underlying\nfile attributes, so it reads directly as a condition. Goes through `lfs`, so the\nproject needs `britzl/defold-lfs` as a dependency.",
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "Path relative to `project_save_path`.",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "list",
+      "brief": "Every saved file, found by walking the save directory breadth-first. Directories",
+      "description": "Every saved file, found by walking the save directory breadth-first. Directories\nare descended into rather than listed. Goes through `lfs`, so the project needs\n`britzl/defold-lfs` as a dependency.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "The file paths, relative to `project_save_path`.",
+          "types": [
+            "string[]"
+          ]
+        }
+      ]
+    }
+  ]
+}

package/api-doc/decore.json

@@ -1544,7 +1544,7 @@
           "brief": "Creates a new world",
           "description": "Creates a new world",
           "types": [
-            "(...args: unknown[]) => LuaMultiReturn<[world, unknown]>"
+            "(...args: unknown[]) => LuaMultiReturn<[world, ...unknown[]]>"
           ]
         },
         {

package/api-doc/defcon.json

@@ -0,0 +1,150 @@
+{
+  "info": {
+    "namespace": "defcon",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "print",
+      "brief": "The engine's own `print`, captured at load. `start()` replaces the global with a",
+      "description": "The engine's own `print`, captured at load. `start()` replaces the global with a\nlogging wrapper that calls this, and `stop()` restores the global from it.",
+      "types": [
+        "(...args: unknown[]) => void"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "pprint",
+      "brief": "The engine's own `pprint`, captured at load. `start()` replaces the global with a",
+      "description": "The engine's own `pprint`, captured at load. `start()` replaces the global with a\nlogging wrapper that calls this, and `stop()` restores the global from it.",
+      "types": [
+        "(...args: unknown[]) => void"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "server",
+      "brief": "The `defnet` http_server the console listens on. A router-only stand-in until",
+      "description": "The `defnet` http_server the console listens on. A router-only stand-in until\n`start()` creates the real one; opaque here, `defnet` not being vendored by this\ntarget.",
+      "types": [
+        "unknown"
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "start",
+      "brief": "Start the console",
+      "description": "Start the console",
+      "docSource": "upstream",
+      "parameters": [
+        {
+          "name": "port",
+          "doc": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "stop",
+      "brief": "Stop the server",
+      "description": "Stop the server",
+      "docSource": "upstream",
+      "parameters": [],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "update",
+      "brief": "Update the server",
+      "description": "Update the server\nPreferably call this once per frame",
+      "docSource": "upstream",
+      "parameters": [],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "register_module",
+      "brief": "Register a module. All functions on the module will be exposed to",
+      "description": "Register a module. All functions on the module will be exposed to\nthe console",
+      "docSource": "upstream",
+      "parameters": [
+        {
+          "name": "module",
+          "doc": "",
+          "types": [
+            "unknown"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "name",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "register_command",
+      "brief": "Register a console command",
+      "description": "Register a console command",
+      "docSource": "upstream",
+      "parameters": [
+        {
+          "name": "command",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "description",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "callback",
+          "doc": "",
+          "types": [
+            "CommandCallback"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "set_environment",
+      "brief": "Set the global environment table used for commands ran as Lua code and inspect.",
+      "description": "Set the global environment table used for commands ran as Lua code and inspect.",
+      "docSource": "upstream",
+      "parameters": [
+        {
+          "name": "env",
+          "doc": "",
+          "types": [
+            "unknown"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    }
+  ]
+}