@defold-typescript/library-types 0.23.0 → 0.24.0

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

package/api-doc/in.state.json

@@ -7,13 +7,56 @@
   "elements": [
     {
       "type": "TYPEDEF",
-      "name": "StateInstance"
+      "name": "StateInstance",
+      "properties": [
+        {
+          "name": "acquire",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => void"
+          ]
+        },
+        {
+          "name": "release",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(url?: Url) => void"
+          ]
+        },
+        {
+          "name": "is_pressed",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(action_id: Hash | string) => boolean"
+          ]
+        },
+        {
+          "name": "on_input",
+          "brief": "",
+          "description": "",
+          "types": [
+            "(action_id: Hash | string, action: {}) => void"
+          ]
+        },
+        {
+          "name": "clear",
+          "brief": "",
+          "description": "",
+          "types": [
+            "() => void"
+          ]
+        }
+      ]
     },
     {
       "type": "FUNCTION",
       "name": "create",
-      "brief": "",
-      "description": "",
+      "brief": "Create an instance of the input state tracker",
+      "description": "Create an instance of the input state tracker",
+      "docSource": "upstream",
       "parameters": [],
       "returnvalues": [
         {
@@ -28,8 +71,9 @@
     {
       "type": "FUNCTION",
       "name": "acquire",
-      "brief": "",
-      "description": "",
+      "brief": "Acquire input focus for the current script and clear state",
+      "description": "Acquire input focus for the current script and clear state",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "url",
@@ -53,8 +97,9 @@
     {
       "type": "FUNCTION",
       "name": "release",
-      "brief": "",
-      "description": "",
+      "brief": "Release input focus for the current script and clear state",
+      "description": "Release input focus for the current script and clear state",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "url",
@@ -78,8 +123,9 @@
     {
       "type": "FUNCTION",
       "name": "is_pressed",
-      "brief": "",
-      "description": "",
+      "brief": "Check if an action is pressed/active",
+      "description": "Check if an action is pressed/active",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "action_id",
@@ -111,8 +157,9 @@
     {
       "type": "FUNCTION",
       "name": "update",
-      "brief": "",
-      "description": "",
+      "brief": "Forward any calls to on_input from scripts using this module",
+      "description": "Forward any calls to on_input from scripts using this module",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "action_id",
@@ -177,8 +224,9 @@
     {
       "type": "FUNCTION",
       "name": "clear",
-      "brief": "",
-      "description": "",
+      "brief": "Clear the state of any currently tracked input states",
+      "description": "Clear the state of any currently tracked input states",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "instance",

package/api-doc/in.textbox.json

@@ -8,6 +8,8 @@
     {
       "type": "VARIABLE",
       "name": "TOUCH",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -15,6 +17,8 @@
     {
       "type": "VARIABLE",
       "name": "TYPE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -22,6 +26,8 @@
     {
       "type": "VARIABLE",
       "name": "BACKSPACE",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -29,24 +35,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 box and text nodes and optional mask param",
+      "description": "Register box and text nodes and optional mask param\nUse is_mask = true if you want to show asterisks (*) instead of the text",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "box_node_or_string",
@@ -86,8 +95,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",
@@ -146,8 +156,8 @@
     {
       "type": "FUNCTION",
       "name": "text",
-      "brief": "",
-      "description": "",
+      "brief": "Get a registered textbox's text, or set it first when `text` is given.",
+      "description": "Get a registered textbox's text, or set it first when `text` is given.\nReturns the text the box holds after the call.",
       "parameters": [
         {
           "name": "node_or_string",
@@ -179,8 +189,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",