@defold-typescript/library-types 0.23.0 → 0.25.0

package/api-doc/{persist.persist.json → persist.json}

@@ -1,6 +1,6 @@
 {
   "info": {
-    "namespace": "persist.persist",
+    "namespace": "persist",
     "brief": "A simple interface for saving and loading data.",
     "description": "A simple interface for saving and loading data."
   },
@@ -137,6 +137,31 @@
           ]
         }
       ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "exists",
+      "brief": "Checks if a file exists.",
+      "description": "Checks if a file exists.",
+      "parameters": [
+        {
+          "name": "file_name",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
     }
   ]
 }

package/api-doc/{platypus.platypus.json → platypus.json}

@@ -1,6 +1,6 @@
 {
   "info": {
-    "namespace": "platypus.platypus",
+    "namespace": "platypus",
     "brief": "Defold platformer engine",
     "description": "Defold platformer engine"
   },
@@ -8,8 +8,9 @@
     {
       "type": "FUNCTION",
       "name": "create",
-      "brief": "",
-      "description": "",
+      "brief": "Create a platypus instance.",
+      "description": "Create a platypus instance.\nThis will provide all the functionality to control a game object in a\nplatformer game. The functions will operate on the game object attached\nto the script calling the functions.",
+      "docSource": "upstream",
       "parameters": [
         {
           "name": "config",
@@ -33,6 +34,8 @@
     {
       "type": "VARIABLE",
       "name": "FALLING",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -40,6 +43,8 @@
     {
       "type": "VARIABLE",
       "name": "GROUND_CONTACT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -47,6 +52,8 @@
     {
       "type": "VARIABLE",
       "name": "WALL_CONTACT",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -54,6 +61,8 @@
     {
       "type": "VARIABLE",
       "name": "JUMP",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -61,6 +70,8 @@
     {
       "type": "VARIABLE",
       "name": "WALL_JUMP",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -68,6 +79,8 @@
     {
       "type": "VARIABLE",
       "name": "DOUBLE_JUMP",
+      "brief": "",
+      "description": "",
       "types": [
         "Hash"
       ]
@@ -75,6 +88,26 @@
     {
       "type": "VARIABLE",
       "name": "WALL_SLIDE",
+      "brief": "",
+      "description": "",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "SEPARATION_RAYS",
+      "brief": "Value for `collisions.separation` selecting raycast separation.",
+      "description": "Value for `collisions.separation` selecting raycast separation.",
+      "types": [
+        "Hash"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "SEPARATION_SHAPES",
+      "brief": "Value for `collisions.separation` selecting shape separation. Platypus warns",
+      "description": "Value for `collisions.separation` selecting shape separation. Platypus warns\nat runtime that this mode is no longer supported and only raycast separation\nis; the constant still exists.",
       "types": [
         "Hash"
       ]
@@ -86,6 +119,8 @@
     {
       "type": "VARIABLE",
       "name": "DIR_UP",
+      "brief": "",
+      "description": "",
       "types": [
         "Direction"
       ]
@@ -93,6 +128,8 @@
     {
       "type": "VARIABLE",
       "name": "DIR_LEFT",
+      "brief": "",
+      "description": "",
       "types": [
         "Direction"
       ]
@@ -100,6 +137,8 @@
     {
       "type": "VARIABLE",
       "name": "DIR_RIGHT",
+      "brief": "",
+      "description": "",
       "types": [
         "Direction"
       ]
@@ -107,6 +146,8 @@
     {
       "type": "VARIABLE",
       "name": "DIR_DOWN",
+      "brief": "",
+      "description": "",
       "types": [
         "Direction"
       ]
@@ -114,6 +155,8 @@
     {
       "type": "VARIABLE",
       "name": "DIR_ALL",
+      "brief": "",
+      "description": "",
       "types": [
         "Direction"
       ]
@@ -186,7 +229,8 @@
           "description": "",
           "types": [
             "boolean"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "reparent",
@@ -194,7 +238,8 @@
           "description": "",
           "types": [
             "boolean"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "gravity",
@@ -202,7 +247,8 @@
           "description": "",
           "types": [
             "number"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "max_velocity",
@@ -210,7 +256,8 @@
           "description": "",
           "types": [
             "number"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "wall_jump_power_ratio_x",
@@ -218,7 +265,8 @@
           "description": "",
           "types": [
             "number"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "wall_jump_power_ratio_y",
@@ -226,7 +274,8 @@
           "description": "",
           "types": [
             "number"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "allow_double_jump",
@@ -234,7 +283,8 @@
           "description": "",
           "types": [
             "boolean"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "allow_wall_jump",
@@ -242,7 +292,8 @@
           "description": "",
           "types": [
             "boolean"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "const_wall_jump",
@@ -250,7 +301,8 @@
           "description": "",
           "types": [
             "boolean"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "allow_wall_slide",
@@ -258,7 +310,8 @@
           "description": "",
           "types": [
             "boolean"
-          ]
+          ],
+          "is_optional": "True"
         },
         {
           "name": "wall_slide_velocity",
@@ -266,7 +319,8 @@
           "description": "",
           "types": [
             "number"
-          ]
+          ],
+          "is_optional": "True"
         }
       ]
     },

package/api-doc/{rendy.rendy.json → rendy.json}

@@ -1,6 +1,6 @@
 {
   "info": {
-    "namespace": "rendy.rendy",
+    "namespace": "rendy",
     "brief": "A versatile camera suite and render pipeline",
     "description": "A versatile camera suite and render pipeline"
   },
@@ -9,6 +9,51 @@
       "type": "TYPEDEF",
       "name": "CameraId"
     },
+    {
+      "type": "VARIABLE",
+      "name": "cameras",
+      "brief": "Every camera except the GUI camera, keyed by camera id. Exposed only because the",
+      "description": "Every camera except the GUI camera, keyed by camera id. Exposed only because the\nrendy.render_script file needs write-access to it; reach for `set` and `get`\nrather than accessing or manipulating it directly.",
+      "types": [
+        "LuaMap<CameraId, unknown>"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "display_width",
+      "brief": "Initial width of the window, specified in the game.project file. Exposed only",
+      "description": "Initial width of the window, specified in the game.project file. Exposed only\nbecause the rendy.render_script file needs write-access to it; it is unset until\nthat script has run.",
+      "types": [
+        "number"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "display_height",
+      "brief": "Initial height of the window, specified in the game.project file. Exposed only",
+      "description": "Initial height of the window, specified in the game.project file. Exposed only\nbecause the rendy.render_script file needs write-access to it; it is unset until\nthat script has run.",
+      "types": [
+        "number"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "window_width",
+      "brief": "Current width of the window. Exposed only because the rendy.render_script file",
+      "description": "Current width of the window. Exposed only because the rendy.render_script file\nneeds write-access to it; it is unset until that script has run.",
+      "types": [
+        "number"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "window_height",
+      "brief": "Current height of the window. Exposed only because the rendy.render_script file",
+      "description": "Current height of the window. Exposed only because the rendy.render_script file\nneeds write-access to it; it is unset until that script has run.",
+      "types": [
+        "number"
+      ]
+    },
     {
       "type": "FUNCTION",
       "name": "create_camera",
@@ -76,104 +121,6 @@
       ],
       "returnvalues": []
     },
-    {
-      "type": "FUNCTION",
-      "name": "animate",
-      "brief": "Animates a camera property. This function replaces the standard go.animate().",
-      "description": "Animates a camera property. This function replaces the standard go.animate().",
-      "parameters": [
-        {
-          "name": "camera_id",
-          "doc": "The identifier for the camera.",
-          "types": [
-            "CameraId"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "property",
-          "doc": "The property to be animated.",
-          "types": [
-            "Hash | string"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "playback",
-          "doc": "The playback mode of the animation.",
-          "types": [
-            "typeof go.PLAYBACK_LOOP_BACKWARD | typeof go.PLAYBACK_LOOP_FORWARD | typeof go.PLAYBACK_LOOP_PINGPONG | typeof go.PLAYBACK_ONCE_BACKWARD | typeof go.PLAYBACK_ONCE_FORWARD | typeof go.PLAYBACK_ONCE_PINGPONG"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "to",
-          "doc": "The target value of the animation.",
-          "types": [
-            "Quaternion | Vector3 | Vector4 | number"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "easing",
-          "doc": "The easing function for the animation.",
-          "types": [
-            "Vector3 | typeof go.EASING_INBACK | typeof go.EASING_INBOUNCE | typeof go.EASING_INCIRC | typeof go.EASING_INCUBIC | typeof go.EASING_INELASTIC | typeof go.EASING_INEXPO | typeof go.EASING_INOUTBACK | typeof go.EASING_INOUTBOUNCE | typeof go.EASING_INOUTCIRC | typeof go.EASING_INOUTCUBIC | typeof go.EASING_INOUTELASTIC | typeof go.EASING_INOUTEXPO | typeof go.EASING_INOUTQUAD | typeof go.EASING_INOUTQUART | typeof go.EASING_INOUTQUINT | typeof go.EASING_INOUTSINE | typeof go.EASING_INQUAD | typeof go.EASING_INQUART | typeof go.EASING_INQUINT | typeof go.EASING_INSINE | typeof go.EASING_LINEAR | typeof go.EASING_OUTBACK | typeof go.EASING_OUTBOUNCE | typeof go.EASING_OUTCIRC | typeof go.EASING_OUTCUBIC | typeof go.EASING_OUTELASTIC | typeof go.EASING_OUTEXPO | typeof go.EASING_OUTINBACK | typeof go.EASING_OUTINBOUNCE | typeof go.EASING_OUTINCIRC | typeof go.EASING_OUTINCUBIC | typeof go.EASING_OUTINELASTIC | typeof go.EASING_OUTINEXPO | typeof go.EASING_OUTINQUAD | typeof go.EASING_OUTINQUART | typeof go.EASING_OUTINQUINT | typeof go.EASING_OUTINSINE | typeof go.EASING_OUTQUAD | typeof go.EASING_OUTQUART | typeof go.EASING_OUTQUINT | typeof go.EASING_OUTSINE"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "duration",
-          "doc": "The duration of the animation.",
-          "types": [
-            "number"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "delay",
-          "doc": "Optional delay before starting the animation.",
-          "types": [
-            "number"
-          ],
-          "is_optional": "True"
-        },
-        {
-          "name": "complete_function",
-          "doc": "Optional function to be called when the animation is complete.",
-          "types": [
-            "(this: any, url: Url, property: Hash) => void"
-          ],
-          "is_optional": "True"
-        }
-      ],
-      "returnvalues": []
-    },
-    {
-      "type": "FUNCTION",
-      "name": "cancel_animations",
-      "brief": "Cancels a camera property animation. This function replaces the standard go.cancel_animations().",
-      "description": "Cancels a camera property animation. This function replaces the standard go.cancel_animations().",
-      "parameters": [
-        {
-          "name": "camera_id",
-          "doc": "The identifier for the camera.",
-          "types": [
-            "CameraId"
-          ],
-          "is_optional": "False"
-        },
-        {
-          "name": "property",
-          "doc": "The property of the animation to be cancelled.",
-          "types": [
-            "Hash | string"
-          ],
-          "is_optional": "False"
-        }
-      ],
-      "returnvalues": []
-    },
     {
       "type": "FUNCTION",
       "name": "get",

package/api-doc/richtext.color.json

@@ -30,9 +30,86 @@
       ],
       "returnvalues": []
     },
+    {
+      "type": "FUNCTION",
+      "name": "parse",
+      "brief": "Resolves a color by name, hex string or comma-separated decimal string.",
+      "description": "Resolves a color by name, hex string or comma-separated decimal string.",
+      "parameters": [
+        {
+          "name": "c",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "Vector4 | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "parse_hex",
+      "brief": "Parses a `#rrggbb` or `#rrggbbaa` hex string, with or without the leading `#`.",
+      "description": "Parses a `#rrggbb` or `#rrggbbaa` hex string, with or without the leading `#`.",
+      "parameters": [
+        {
+          "name": "hex",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "Vector4 | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "parse_decimal",
+      "brief": "Parses a comma-separated `r,g,b,a` string of decimal components.",
+      "description": "Parses a comma-separated `r,g,b,a` string of decimal components.",
+      "parameters": [
+        {
+          "name": "dec",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "Vector4 | undefined"
+          ]
+        }
+      ]
+    },
     {
       "type": "VARIABLE",
       "name": "COLORS",
+      "brief": "",
+      "description": "",
       "types": [
         "{ aqua: Vector4; black: Vector4; blue: Vector4; brown: Vector4; cyan: Vector4; darkblue: Vector4; fuchsia: Vector4; green: Vector4; grey: Vector4; lightblue: Vector4; lime: Vector4; magenta: Vector4; maroon: Vector4; navy: Vector4; olive: Vector4; orange: Vector4; purple: Vector4; red: Vector4; silver: Vector4; teal: Vector4; white: Vector4; yellow: Vector4; }"
       ],