@defold-typescript/library-types 0.22.0 → 0.24.0

package/api-doc/{event.event.json → log.json}

@@ -1,56 +1,59 @@
 {
   "info": {
-    "namespace": "event.event",
-    "brief": "Cross-Context Defold Event System",
-    "description": "Cross-Context Defold Event System"
+    "namespace": "log",
+    "brief": "",
+    "description": ""
   },
   "elements": [
     {
       "type": "FUNCTION",
-      "name": "set_logger",
-      "brief": "",
-      "description": "",
+      "name": "get_logger",
+      "brief": "Return the new logger instance",
+      "description": "Return the new logger instance",
       "parameters": [
         {
-          "name": "logger",
+          "name": "logger_name",
           "doc": "",
           "types": [
-            "LoggerInstance"
+            "string | undefined"
           ],
-          "is_optional": "False"
-        }
-      ],
-      "returnvalues": []
-    },
-    {
-      "type": "FUNCTION",
-      "name": "create",
-      "brief": "Generate a new event instance. This instance can then be used to subscribe to and trigger events.",
-      "description": "Generate a new event instance. This instance can then be used to subscribe to and trigger events.",
-      "parameters": [
+          "is_optional": "True",
+          "is_vararg": "False"
+        },
         {
-          "name": "this",
-          "doc": "",
+          "name": "force_logger_level_in_debug",
+          "doc": "Default is DEBUG, values: FATAL, ERROR, WARN, INFO, DEBUG, TRACE",
           "types": [
-            "void"
+            "string | undefined"
           ],
-          "is_optional": "False"
-        },
+          "is_optional": "True",
+          "is_vararg": "False"
+        }
+      ],
+      "returnvalues": [
         {
-          "name": "callback",
+          "name": "",
           "doc": "",
           "types": [
-            "(this: any) => void"
-          ],
-          "is_optional": "False"
-        },
+            "logger"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "get_default_logger_name",
+      "brief": "Return the basename of the current file",
+      "description": "Return the basename of the current file",
+      "parameters": [
         {
-          "name": "callback_context",
+          "name": "debuginfo",
           "doc": "",
           "types": [
-            "any"
+            "debug.FunctionInfo"
           ],
-          "is_optional": "True"
+          "is_optional": "False",
+          "is_vararg": "False"
         }
       ],
       "returnvalues": [
@@ -58,44 +61,38 @@
           "name": "",
           "doc": "",
           "types": [
-            "EventInstance"
+            "string"
           ]
         }
       ]
     },
     {
       "type": "TYPEDEF",
-      "name": "LoggerInstance",
+      "name": "log",
       "functions": [
         {
           "type": "FUNCTION",
           "name": "trace",
-          "brief": "",
-          "description": "",
+          "brief": "Log message with TRACE level",
+          "description": "Log message with TRACE level",
           "parameters": [
-            {
-              "name": "this",
-              "doc": "",
-              "types": [
-                "any"
-              ],
-              "is_optional": "False"
-            },
             {
               "name": "message",
-              "doc": "",
+              "doc": "Message to log",
               "types": [
                 "string"
               ],
-              "is_optional": "False"
+              "is_optional": "False",
+              "is_vararg": "False"
             },
             {
               "name": "data",
               "doc": "",
               "types": [
-                "{}"
+                "unknown"
               ],
-              "is_optional": "True"
+              "is_optional": "False",
+              "is_vararg": "False"
             }
           ],
           "returnvalues": []
@@ -103,32 +100,26 @@
         {
           "type": "FUNCTION",
           "name": "debug",
-          "brief": "",
-          "description": "",
+          "brief": "Log message with DEBUG level",
+          "description": "Log message with DEBUG level",
           "parameters": [
-            {
-              "name": "this",
-              "doc": "",
-              "types": [
-                "any"
-              ],
-              "is_optional": "False"
-            },
             {
               "name": "message",
-              "doc": "",
+              "doc": "Message to log",
               "types": [
                 "string"
               ],
-              "is_optional": "False"
+              "is_optional": "False",
+              "is_vararg": "False"
             },
             {
               "name": "data",
               "doc": "",
               "types": [
-                "{}"
+                "unknown"
               ],
-              "is_optional": "True"
+              "is_optional": "False",
+              "is_vararg": "False"
             }
           ],
           "returnvalues": []
@@ -136,32 +127,26 @@
         {
           "type": "FUNCTION",
           "name": "info",
-          "brief": "",
-          "description": "",
+          "brief": "Log message with INFO level",
+          "description": "Log message with INFO level",
           "parameters": [
-            {
-              "name": "this",
-              "doc": "",
-              "types": [
-                "any"
-              ],
-              "is_optional": "False"
-            },
             {
               "name": "message",
               "doc": "",
               "types": [
                 "string"
               ],
-              "is_optional": "False"
+              "is_optional": "False",
+              "is_vararg": "False"
             },
             {
               "name": "data",
               "doc": "",
               "types": [
-                "{}"
+                "unknown"
               ],
-              "is_optional": "True"
+              "is_optional": "False",
+              "is_vararg": "False"
             }
           ],
           "returnvalues": []
@@ -169,32 +154,26 @@
         {
           "type": "FUNCTION",
           "name": "warn",
-          "brief": "",
-          "description": "",
+          "brief": "Log message with WARN level",
+          "description": "Log message with WARN level",
           "parameters": [
-            {
-              "name": "this",
-              "doc": "",
-              "types": [
-                "any"
-              ],
-              "is_optional": "False"
-            },
             {
               "name": "message",
               "doc": "",
               "types": [
                 "string"
               ],
-              "is_optional": "False"
+              "is_optional": "False",
+              "is_vararg": "False"
             },
             {
               "name": "data",
               "doc": "",
               "types": [
-                "{}"
+                "unknown"
               ],
-              "is_optional": "True"
+              "is_optional": "False",
+              "is_vararg": "False"
             }
           ],
           "returnvalues": []
@@ -202,37 +181,53 @@
         {
           "type": "FUNCTION",
           "name": "error",
-          "brief": "",
-          "description": "",
+          "brief": "Log message with ERROR level",
+          "description": "Log message with ERROR level",
           "parameters": [
-            {
-              "name": "this",
-              "doc": "",
-              "types": [
-                "any"
-              ],
-              "is_optional": "False"
-            },
             {
               "name": "message",
               "doc": "",
               "types": [
                 "string"
               ],
-              "is_optional": "False"
+              "is_optional": "False",
+              "is_vararg": "False"
             },
             {
               "name": "data",
               "doc": "",
               "types": [
-                "{}"
+                "unknown"
               ],
-              "is_optional": "True"
+              "is_optional": "False",
+              "is_vararg": "False"
             }
           ],
           "returnvalues": []
         }
+      ],
+      "properties": [
+        {
+          "name": "name",
+          "brief": "",
+          "description": "",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "level",
+          "brief": "",
+          "description": "",
+          "types": [
+            "string"
+          ]
+        }
       ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "logger"
     }
   ]
 }

package/api-doc/metrics.fps.json

@@ -5,6 +5,33 @@
     "description": ""
   },
   "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "POSITION",
+      "brief": "Where `draw()` places the text, and the default `create()` uses when given no position.",
+      "description": "Where `draw()` places the text, and the default `create()` uses when given no position.",
+      "types": [
+        "Vector3"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "FORMAT",
+      "brief": "The `string.format` pattern the FPS reading is rendered through.",
+      "description": "The `string.format` pattern the FPS reading is rendered through.",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "COLOR",
+      "brief": "The colour `draw()` renders the text in, and the default `create()` uses when given no colour.",
+      "description": "The colour `draw()` renders the text in, and the default `create()` uses when given no colour.",
+      "types": [
+        "Vector4"
+      ]
+    },
     {
       "type": "FUNCTION",
       "name": "create",
@@ -31,7 +58,7 @@
           "name": "position",
           "doc": "",
           "types": [
-            "string"
+            "Vector3"
           ],
           "is_optional": "True"
         },
@@ -39,7 +66,7 @@
           "name": "color",
           "doc": "",
           "types": [
-            "string"
+            "Vector4"
           ],
           "is_optional": "True"
         }
@@ -54,6 +81,38 @@
         }
       ]
     },
+    {
+      "type": "FUNCTION",
+      "name": "update",
+      "brief": "Call this once per frame. Once enough samples have been collected it is possible to call fps() to get the current FPS.",
+      "description": "Call this once per frame. Once enough samples have been collected it is possible to call fps() to get the current FPS.",
+      "parameters": [],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "fps",
+      "brief": "Get the current FPS, based on collected samples.",
+      "description": "Get the current FPS, based on collected samples.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "draw",
+      "brief": "Draw fps count text using `draw_debug_text`.",
+      "description": "Draw fps count text using `draw_debug_text`.",
+      "parameters": [],
+      "returnvalues": []
+    },
     {
       "type": "TYPEDEF",
       "name": "Metrics",

package/api-doc/metrics.mem.json

@@ -5,6 +5,33 @@
     "description": ""
   },
   "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "POSITION",
+      "brief": "Where `draw()` places the text, and the default `create()` uses when given no position.",
+      "description": "Where `draw()` places the text, and the default `create()` uses when given no position.",
+      "types": [
+        "Vector3"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "FORMAT",
+      "brief": "The `string.format` pattern the memory reading is rendered through.",
+      "description": "The `string.format` pattern the memory reading is rendered through.",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "COLOR",
+      "brief": "The colour `draw()` renders the text in, and the default `create()` uses when given no colour.",
+      "description": "The colour `draw()` renders the text in, and the default `create()` uses when given no colour.",
+      "types": [
+        "Vector4"
+      ]
+    },
     {
       "type": "FUNCTION",
       "name": "create",
@@ -23,7 +50,7 @@
           "name": "position",
           "doc": "",
           "types": [
-            "string"
+            "Vector3"
           ],
           "is_optional": "True"
         },
@@ -31,7 +58,7 @@
           "name": "color",
           "doc": "",
           "types": [
-            "string"
+            "Vector4"
           ],
           "is_optional": "True"
         }
@@ -46,6 +73,38 @@
         }
       ]
     },
+    {
+      "type": "FUNCTION",
+      "name": "update",
+      "brief": "Call this to get a new memory usage reading.",
+      "description": "Call this to get a new memory usage reading.",
+      "parameters": [],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "mem",
+      "brief": "Get the current memory usage, in kilobytes.",
+      "description": "Get the current memory usage, in kilobytes.",
+      "parameters": [],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "number"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "draw",
+      "brief": "Draw memory usage text using `draw_debug_text`.",
+      "description": "Draw memory usage text using `draw_debug_text`.",
+      "parameters": [],
+      "returnvalues": []
+    },
     {
       "type": "TYPEDEF",
       "name": "Metrics",