@defold-typescript/library-types 0.22.0 → 0.24.0

package/api-doc/immutable.json

@@ -0,0 +1,65 @@
+{
+  "info": {
+    "namespace": "immutable",
+    "brief": "",
+    "description": ""
+  },
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "is_immutable",
+      "brief": "Checks if a given table `table_to_check` is immutable",
+      "description": "Checks if a given table `table_to_check` is immutable",
+      "parameters": [
+        {
+          "name": "table_to_check",
+          "doc": "@table to check if is immutable",
+          "types": [
+            "LuaTable | Immutable"
+          ],
+          "is_optional": "False",
+          "is_vararg": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "@true if table is immutable, false otherwise",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "make",
+      "brief": "Makes a given table immutable, including nested tables",
+      "description": "Makes a given table immutable, including nested tables",
+      "parameters": [
+        {
+          "name": "original_table",
+          "doc": "@table to convert",
+          "types": [
+            "LuaTable | Immutable"
+          ],
+          "is_optional": "False",
+          "is_vararg": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "@converted table",
+          "types": [
+            "Immutable"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "TYPEDEF",
+      "name": "Immutable"
+    }
+  ]
+}

package/api-doc/in.accelerometer.json

@@ -7,7 +7,81 @@
   "elements": [
     {
       "type": "TYPEDEF",
-      "name": "AccelerometerInstance"
+      "name": "AccelerometerInstance",
+      "properties": [
+        {
+          "name": "reset",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => void"
+          ]
+        },
+        {
+          "name": "calibrate",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => void"
+          ]
+        },
+        {
+          "name": "on_input",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(action: { acc_x: number; acc_y: number; acc_z: number; }) => void"
+          ]
+        },
+        {
+          "name": "calibrated",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => Vector3"
+          ]
+        },
+        {
+          "name": "adjusted",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => Vector3"
+          ]
+        },
+        {
+          "name": "average",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => Vector3"
+          ]
+        },
+        {
+          "name": "zero",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => Vector3"
+          ]
+        },
+        {
+          "name": "latest",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => Vector3"
+          ]
+        },
+        {
+          "name": "on_window_resized",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(width: number, height: number) => void"
+          ]
+        }
+      ]
     },
     {
       "type": "FUNCTION",

package/api-doc/in.button.json

@@ -8,6 +8,8 @@
     {
       "type": "VARIABLE",
       "name": "TOUCH",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -15,24 +17,27 @@
     {
       "type": "FUNCTION",
       "name": "acquire",
-      "brief": "",
-      "description": "",
+      "brief": "Convenience function to acquire input focus",
+      "description": "Convenience function to acquire input focus",
+      "docSource": "upstream",
       "parameters": [],
       "returnvalues": []
     },
     {
       "type": "FUNCTION",
       "name": "release",
-      "brief": "",
-      "description": "",
+      "brief": "Convenience function to release input focus",
+      "description": "Convenience function to release input focus",
+      "docSource": "upstream",
       "parameters": [],
       "returnvalues": []
     },
     {
       "type": "FUNCTION",
       "name": "register",
-      "brief": "",
-      "description": "",
+      "brief": "Register a node and a callback to invoke when it is clicked",
+      "description": "Register a node and a callback to invoke when it is clicked",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "node_or_string",
@@ -64,8 +69,9 @@
     {
       "type": "FUNCTION",
       "name": "unregister",
-      "brief": "",
-      "description": "",
+      "brief": "Unregister a previously registered node or all nodes",
+      "description": "Unregister a previously registered node or all nodes\nregistered from the calling script",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "node_or_string",
@@ -114,8 +120,9 @@
     {
       "type": "FUNCTION",
       "name": "on_input",
-      "brief": "",
-      "description": "",
+      "brief": "Forward on_input calls to this function to detect input",
+      "description": "Forward on_input calls to this function to detect input\nfor registered nodes",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "action_id",

package/api-doc/in.cursor.json

@@ -8,6 +8,8 @@
     {
       "type": "VARIABLE",
       "name": "OVER",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -15,6 +17,8 @@
     {
       "type": "VARIABLE",
       "name": "OUT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -22,6 +26,8 @@
     {
       "type": "VARIABLE",
       "name": "PRESSED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -29,6 +35,8 @@
     {
       "type": "VARIABLE",
       "name": "RELEASED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -36,6 +44,8 @@
     {
       "type": "VARIABLE",
       "name": "DRAG",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -43,6 +53,8 @@
     {
       "type": "VARIABLE",
       "name": "DRAG_END",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -50,6 +62,8 @@
     {
       "type": "VARIABLE",
       "name": "DRAG_START",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -57,6 +71,8 @@
     {
       "type": "VARIABLE",
       "name": "CLICKED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -64,6 +80,8 @@
     {
       "type": "VARIABLE",
       "name": "RESET",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -71,6 +89,8 @@
     {
       "type": "VARIABLE",
       "name": "START_DRAGGING",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -78,6 +98,8 @@
     {
       "type": "VARIABLE",
       "name": "DRAG_MODE_HORIZONTAL",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -85,6 +107,8 @@
     {
       "type": "VARIABLE",
       "name": "DRAG_MODE_VERTICAL",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -92,6 +116,8 @@
     {
       "type": "VARIABLE",
       "name": "DRAG_MODE_FREE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]