@defold-typescript/library-types 0.22.0 → 0.24.0

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/decore.json

@@ -61,7 +61,7 @@
           "types": [
             "LuaTable | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         },
         {
@@ -70,7 +70,7 @@
           "types": [
             "Url | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -107,7 +107,7 @@
           "types": [
             "string | string[] | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -152,7 +152,7 @@
           "types": [
             "string | string[] | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -197,7 +197,7 @@
           "types": [
             "string | string[] | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -242,7 +242,7 @@
           "types": [
             "string | string[] | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -286,7 +286,7 @@
           "types": [
             "string | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -375,7 +375,7 @@
           "types": [
             "string | Hash | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         },
         {
@@ -384,7 +384,7 @@
           "types": [
             "string | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         },
         {
@@ -393,7 +393,7 @@
           "types": [
             "LuaTable<string, unknown> | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -437,7 +437,7 @@
           "types": [
             "string | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -508,7 +508,7 @@
           "types": [
             "string | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -552,7 +552,7 @@
           "types": [
             "unknown | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -587,7 +587,7 @@
           "types": [
             "LuaTable<string, unknown> | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -666,7 +666,7 @@
           "types": [
             "unknown | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -718,7 +718,7 @@
           "types": [
             "decore_logger | LuaTable | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -736,7 +736,7 @@
           "types": [
             "string | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         },
         {
@@ -745,7 +745,7 @@
           "types": [
             "string | undefined"
           ],
-          "is_optional": "False",
+          "is_optional": "True",
           "is_vararg": "False"
         }
       ],
@@ -1465,7 +1465,7 @@
     },
     {
       "type": "TYPEDEF",
-      "name": "tiny_ecs_Tiny_ECS_module",
+      "name": "tiny_ecs",
       "properties": [
         {
           "name": "requireAll",
@@ -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[]]>"
           ]
         },
         {
@@ -1705,7 +1705,7 @@
               "types": [
                 "((events: unknown[]) => void) | ((context: unknown, events: unknown[]) => void) | undefined"
               ],
-              "is_optional": "False",
+              "is_optional": "True",
               "is_vararg": "False"
             },
             {
@@ -1714,7 +1714,7 @@
               "types": [
                 "unknown | undefined"
               ],
-              "is_optional": "False",
+              "is_optional": "True",
               "is_vararg": "False"
             }
           ],
@@ -1757,7 +1757,7 @@
               "types": [
                 "((new_event: unknown, events: unknown[], entity_map: LuaTable<entity, unknown[]>) => boolean) | undefined"
               ],
-              "is_optional": "False",
+              "is_optional": "True",
               "is_vararg": "False"
             }
           ],

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": []
+    }
+  ]
+}