@defold-typescript/library-types 0.23.0 → 0.24.0

package/api-doc/lang.json

@@ -68,7 +68,7 @@
           "name": "on_lang_changed",
           "doc": "",
           "types": [
-            "unknown | undefined"
+            "((...args: any[]) => unknown) | undefined"
           ],
           "is_optional": "True",
           "is_vararg": "False"
@@ -95,7 +95,7 @@
           "name": "on_lang_changed",
           "doc": "",
           "types": [
-            "unknown | undefined"
+            "((...args: any[]) => unknown) | undefined"
           ],
           "is_optional": "True",
           "is_vararg": "False"
@@ -113,7 +113,7 @@
           "name": "on_lang_changed",
           "doc": "",
           "types": [
-            "unknown | undefined"
+            "((...args: any[]) => unknown) | undefined"
           ],
           "is_optional": "True",
           "is_vararg": "False"
@@ -475,7 +475,7 @@
           "brief": "Called after translations are loaded",
           "description": "Called after translations are loaded",
           "types": [
-            "unknown"
+            "(...args: any[]) => unknown"
           ]
         }
       ]
@@ -519,7 +519,7 @@
           "brief": "Optional async loader function with signature: loader(path, on_success, on_error)",
           "description": "Optional async loader function with signature: loader(path, on_success, on_error)",
           "types": [
-            "unknown | undefined"
+            "((...args: any[]) => unknown) | undefined"
           ]
         }
       ]

package/api-doc/log.json

@@ -50,7 +50,7 @@
           "name": "debuginfo",
           "doc": "",
           "types": [
-            "unknown"
+            "debug.FunctionInfo"
           ],
           "is_optional": "False",
           "is_vararg": "False"

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",

package/api-doc/monarch.monarch.json

@@ -11,23 +11,177 @@
     },
     {
       "type": "TYPEDEF",
-      "name": "ShowOptions"
+      "name": "ShowOptions",
+      "properties": [
+        {
+          "name": "clear",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "reload",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "sequential",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "no_stack",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "pop",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "ReplaceOptions"
+      "name": "ReplaceOptions",
+      "properties": [
+        {
+          "name": "clear",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "reload",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "no_stack",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "RegisterProxyOptions"
+      "name": "RegisterProxyOptions",
+      "properties": [
+        {
+          "name": "popup",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "popup_on_popup",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "timestep_below_popup",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "screen_keeps_input_focus_when_below_popup",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "others_keep_input_focus_when_below_screen",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "auto_preload",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "BackOptions"
+      "name": "BackOptions",
+      "properties": [
+        {
+          "name": "sequential",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "PreloadOptions"
+      "name": "PreloadOptions",
+      "properties": [
+        {
+          "name": "auto_preload",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
@@ -41,9 +195,74 @@
       "type": "TYPEDEF",
       "name": "Callback"
     },
+    {
+      "type": "VARIABLE",
+      "name": "TRANSITION_DONE",
+      "brief": "Post this back to Monarch from a transition listener once the transition",
+      "description": "Post this back to Monarch from a transition listener once the transition\nhas finished. Monarch will not proceed until it arrives.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "TRANSITION_SHOW_IN",
+      "brief": "Sent to a screen's transition url when the screen should transition in.",
+      "description": "Sent to a screen's transition url when the screen should transition in.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "TRANSITION_SHOW_OUT",
+      "brief": "Sent to a screen's transition url when the screen should transition out.",
+      "description": "Sent to a screen's transition url when the screen should transition out.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "TRANSITION_BACK_IN",
+      "brief": "Sent to a screen's transition url when the screen above it was popped and",
+      "description": "Sent to a screen's transition url when the screen above it was popped and\nthis screen should transition back in.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "TRANSITION_BACK_OUT",
+      "brief": "Sent to a screen's transition url when this screen is being popped and",
+      "description": "Sent to a screen's transition url when this screen is being popped and\nshould transition back out.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "FOCUS_GAINED",
+      "brief": "Sent to a screen's focus url when the screen gains focus.",
+      "description": "Sent to a screen's focus url when the screen gains focus.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "FOCUS_LOST",
+      "brief": "Sent to a screen's focus url when the screen loses focus.",
+      "description": "Sent to a screen's focus url when the screen loses focus.",
+      "types": [
+        "Hash"
+      ]
+    },
     {
       "type": "VARIABLE",
       "name": "TRANSITION",
+      "brief": "",
+      "description": "",
       "types": [
         "{ DONE: Hash; SHOW_IN: Hash; SHOW_OUT: Hash; BACK_IN: Hash; BACK_OUT: Hash; }"
       ],
@@ -88,11 +307,14 @@
           ],
           "is_optional": "False"
         }
-      ]
+      ],
+      "deprecated": "Use the flat `TRANSITION_*` constants instead — Monarch marks\nthis grouping deprecated in its own source."
     },
     {
       "type": "VARIABLE",
       "name": "FOCUS",
+      "brief": "",
+      "description": "",
       "types": [
         "{ GAINED: Hash; LOST: Hash; }"
       ],
@@ -113,11 +335,14 @@
           ],
           "is_optional": "False"
         }
-      ]
+      ],
+      "deprecated": "Use the flat `FOCUS_*` constants instead — Monarch marks this\ngrouping deprecated in its own source."
     },
     {
       "type": "VARIABLE",
       "name": "SCREEN_TRANSITION_IN_STARTED",
+      "brief": "Sent to every url registered with `add_listener` when a screen begins",
+      "description": "Sent to every url registered with `add_listener` when a screen begins\ntransitioning in, carrying `screen` and `previous_screen` ids.",
       "types": [
         "Hash"
       ]
@@ -125,6 +350,8 @@
     {
       "type": "VARIABLE",
       "name": "SCREEN_TRANSITION_IN_FINISHED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -132,6 +359,8 @@
     {
       "type": "VARIABLE",
       "name": "SCREEN_TRANSITION_OUT_STARTED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -139,6 +368,8 @@
     {
       "type": "VARIABLE",
       "name": "SCREEN_TRANSITION_OUT_FINISHED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -146,6 +377,8 @@
     {
       "type": "VARIABLE",
       "name": "SCREEN_TRANSITION_FAILED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -316,6 +549,15 @@
       ],
       "returnvalues": []
     },
+    {
+      "type": "VARIABLE",
+      "name": "register",
+      "brief": "Alias of {@link register_proxy}, kept for the pre-factory API.",
+      "description": "Alias of {@link register_proxy}, kept for the pre-factory API.\nTyped through the function it aliases so the two cannot drift apart.",
+      "types": [
+        "typeof register_proxy"
+      ]
+    },
     {
       "type": "FUNCTION",
       "name": "register_factory",

package/api-doc/monarch.transitions.easings.json

@@ -15,7 +15,25 @@
     },
     {
       "type": "TYPEDEF",
-      "name": "Easing"
+      "name": "Easing",
+      "properties": [
+        {
+          "name": "IN",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(typeof gui)[`EASING_OUT${EasingOut}`]"
+          ]
+        },
+        {
+          "name": "OUT",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(typeof gui)[`EASING_IN${EasingIn}`]"
+          ]
+        }
+      ]
     },
     {
       "type": "FUNCTION",
@@ -176,31 +194,6 @@
           ]
         }
       ]
-    },
-    {
-      "type": "FUNCTION",
-      "name": "create",
-      "brief": "",
-      "description": "",
-      "parameters": [
-        {
-          "name": "name",
-          "doc": "",
-          "types": [
-            "EasingIn | EasingOut"
-          ],
-          "is_optional": "False"
-        }
-      ],
-      "returnvalues": [
-        {
-          "name": "",
-          "doc": "",
-          "types": [
-            "Easing"
-          ]
-        }
-      ]
     }
   ]
 }