@defold-typescript/library-types 0.22.0 → 0.24.0

package/api-doc/in.gesture.json

@@ -7,15 +7,408 @@
   "elements": [
     {
       "type": "TYPEDEF",
-      "name": "GestureInstance"
+      "name": "GestureInstance",
+      "functions": [
+        {
+          "type": "FUNCTION",
+          "name": "on_input",
+          "brief": "",
+          "description": "",
+          "parameters": [
+            {
+              "name": "action_id",
+              "doc": "",
+              "types": [
+                "Hash"
+              ],
+              "is_optional": "False"
+            },
+            {
+              "name": "action",
+              "doc": "",
+              "types": [
+                "{}"
+              ],
+              "is_optional": "False"
+            }
+          ],
+          "returnvalues": [
+            {
+              "name": "",
+              "doc": "",
+              "types": [
+                "DetectedGestures"
+              ]
+            }
+          ]
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "DetectedGestures"
+      "name": "DetectedGestures",
+      "properties": [
+        {
+          "name": "tap",
+          "brief": "",
+          "description": "",
+          "types": [
+            "{ position: { x: number; y: number; }; }"
+          ],
+          "is_optional": "True",
+          "fields": [
+            {
+              "name": "position",
+              "doc": "",
+              "types": [
+                "{ x: number; y: number; }"
+              ],
+              "is_optional": "False",
+              "fields": [
+                {
+                  "name": "x",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                },
+                {
+                  "name": "y",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "double_tap",
+          "brief": "",
+          "description": "",
+          "types": [
+            "{ position: { x: number; y: number; }; }"
+          ],
+          "is_optional": "True",
+          "fields": [
+            {
+              "name": "position",
+              "doc": "",
+              "types": [
+                "{ x: number; y: number; }"
+              ],
+              "is_optional": "False",
+              "fields": [
+                {
+                  "name": "x",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                },
+                {
+                  "name": "y",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "name": "long_press",
+          "brief": "",
+          "description": "",
+          "types": [
+            "{ position: { x: number; y: number; }; time: number; }"
+          ],
+          "is_optional": "True",
+          "fields": [
+            {
+              "name": "position",
+              "doc": "",
+              "types": [
+                "{ x: number; y: number; }"
+              ],
+              "is_optional": "False",
+              "fields": [
+                {
+                  "name": "x",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                },
+                {
+                  "name": "y",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                }
+              ]
+            },
+            {
+              "name": "time",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "False"
+            }
+          ]
+        },
+        {
+          "name": "repeated",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "swipe_left",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "swipe_right",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "swipe_up",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "swipe_down",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "swipe",
+          "brief": "",
+          "description": "",
+          "types": [
+            "{ from: { x: number; y: number; }; to: { x: number; y: number; }; time: number; }"
+          ],
+          "is_optional": "True",
+          "fields": [
+            {
+              "name": "from",
+              "doc": "",
+              "types": [
+                "{ x: number; y: number; }"
+              ],
+              "is_optional": "False",
+              "fields": [
+                {
+                  "name": "x",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                },
+                {
+                  "name": "y",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                }
+              ]
+            },
+            {
+              "name": "to",
+              "doc": "",
+              "types": [
+                "{ x: number; y: number; }"
+              ],
+              "is_optional": "False",
+              "fields": [
+                {
+                  "name": "x",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                },
+                {
+                  "name": "y",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                }
+              ]
+            },
+            {
+              "name": "time",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "False"
+            }
+          ]
+        },
+        {
+          "name": "two_finger",
+          "brief": "",
+          "description": "",
+          "types": [
+            "{ tap?: boolean; double_tap?: boolean; long_press?: boolean; repeated?: boolean; swipe_left?: boolean; swipe_right?: boolean; swipe_up?: boolean; swipe_down?: boolean; pinch?: { center: { x: number; y: number; }; ratio: number; }; }"
+          ],
+          "is_optional": "True",
+          "fields": [
+            {
+              "name": "tap",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "double_tap",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "long_press",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "repeated",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "swipe_left",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "swipe_right",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "swipe_up",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "swipe_down",
+              "doc": "",
+              "types": [
+                "boolean"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "pinch",
+              "doc": "",
+              "types": [
+                "{ center: { x: number; y: number; }; ratio: number; }"
+              ],
+              "is_optional": "True",
+              "fields": [
+                {
+                  "name": "center",
+                  "doc": "",
+                  "types": [
+                    "{ x: number; y: number; }"
+                  ],
+                  "is_optional": "False",
+                  "fields": [
+                    {
+                      "name": "x",
+                      "doc": "",
+                      "types": [
+                        "number"
+                      ],
+                      "is_optional": "False"
+                    },
+                    {
+                      "name": "y",
+                      "doc": "",
+                      "types": [
+                        "number"
+                      ],
+                      "is_optional": "False"
+                    }
+                  ]
+                },
+                {
+                  "name": "ratio",
+                  "doc": "",
+                  "types": [
+                    "number"
+                  ],
+                  "is_optional": "False"
+                }
+              ]
+            }
+          ]
+        }
+      ]
     },
     {
       "type": "VARIABLE",
       "name": "SETTINGS",
+      "brief": "",
+      "description": "",
       "types": [
         "{ action_id: Hash; tap_threshold: number; double_tap_interval: number; swipe_threshold: number; swipe_time: number; long_press_time: number; multi_touch: boolean; }"
       ],
@@ -81,8 +474,9 @@
     {
       "type": "FUNCTION",
       "name": "create",
-      "brief": "",
-      "description": "",
+      "brief": "Create a gesture instance. Use this if you need multiple gesture detectors that each needs",
+      "description": "Create a gesture instance. Use this if you need multiple gesture detectors that each needs\nunique settings",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "settings",
@@ -164,8 +558,9 @@
     {
       "type": "FUNCTION",
       "name": "on_input",
-      "brief": "",
-      "description": "",
+      "brief": "Forward calls to on_input to this function to detect supported gestures",
+      "description": "Forward calls to on_input to this function to detect supported gestures",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "this",

package/api-doc/in.keyboard.json

@@ -8,6 +8,8 @@
     {
       "type": "VARIABLE",
       "name": "KEYBOARD_INPUT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]

package/api-doc/in.mapper.json

@@ -8,8 +8,9 @@
     {
       "type": "FUNCTION",
       "name": "bind",
-      "brief": "",
-      "description": "",
+      "brief": "Bind an input trigger to an action, optionally associating the binding",
+      "description": "Bind an input trigger to an action, optionally associating the binding\nto a specific player",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "trigger",
@@ -57,8 +58,9 @@
     {
       "type": "FUNCTION",
       "name": "unbind",
-      "brief": "",
-      "description": "",
+      "brief": "Unbind (remove) an existing input binding",
+      "description": "Unbind (remove) an existing input binding",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "trigger",
@@ -82,8 +84,9 @@
     {
       "type": "FUNCTION",
       "name": "unbind_all",
-      "brief": "",
-      "description": "",
+      "brief": "Unbind (remove) all input trigger bindings",
+      "description": "Unbind (remove) all input trigger bindings",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "player",
@@ -99,8 +102,9 @@
     {
       "type": "FUNCTION",
       "name": "on_input",
-      "brief": "",
-      "description": "",
+      "brief": "Handle incoming input trigger from a script by finding an binding and",
+      "description": "Handle incoming input trigger from a script by finding an binding and\nreturning the bound action",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "trigger",

package/api-doc/in.onscreen.json

@@ -8,6 +8,8 @@
     {
       "type": "VARIABLE",
       "name": "BUTTON",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -15,6 +17,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -22,6 +26,8 @@
     {
       "type": "VARIABLE",
       "name": "BUTTON_PRESSED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -29,6 +35,8 @@
     {
       "type": "VARIABLE",
       "name": "BUTTON_RELEASED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -36,6 +44,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_PRESSED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -43,6 +53,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_RELEASED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -50,6 +62,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_MOVED",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -57,6 +71,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_LEFT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -64,6 +80,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_RIGHT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -71,6 +89,8 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_UP",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -78,23 +98,59 @@
     {
       "type": "VARIABLE",
       "name": "ANALOG_DOWN",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
     },
     {
       "type": "TYPEDEF",
-      "name": "OnscreenInstance"
+      "name": "OnscreenInstance",
+      "properties": [
+        {
+          "name": "reset",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => void"
+          ]
+        },
+        {
+          "name": "register_button",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(node: Opaque<\"node\">, settings: {} | undefined, fn: (action: Hash, node: Opaque<\"node\">, touch: {}) => void) => void"
+          ]
+        },
+        {
+          "name": "register_analog",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(node: Opaque<\"node\">, settings: { radius?: number; threshold?: number; } | undefined, fn: (action: Hash, node: Opaque<\"node\">, touch: {}) => void) => void"
+          ]
+        },
+        {
+          "name": "on_input",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(action_id: Hash, action: {}) => boolean"
+          ]
+        }
+      ]
     },
     {
       "type": "FUNCTION",
       "name": "create",
-      "brief": "",
-      "description": "",
+      "brief": "Create an instance of the onscreen controls.",
+      "description": "Create an instance of the onscreen controls.",
       "parameters": [
         {
           "name": "config",
-          "doc": "",
+          "doc": "Optional settings. `touch` is the action id bound to single touch.",
           "types": [
             "{ touch: Hash; }"
           ],
@@ -114,7 +170,7 @@
       "returnvalues": [
         {
           "name": "",
-          "doc": "",
+          "doc": "The instance the register and input functions operate on.",
           "types": [
             "OnscreenInstance"
           ]