@defold-typescript/library-types 0.22.0 → 0.24.0

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; }"
       ],

package/api-doc/richtext.richtext.json

@@ -7,7 +7,41 @@
   "elements": [
     {
       "type": "TYPEDEF",
-      "name": "FontSettings"
+      "name": "FontSettings",
+      "properties": [
+        {
+          "name": "regular",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Hash"
+          ]
+        },
+        {
+          "name": "italic",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Hash"
+          ]
+        },
+        {
+          "name": "bold",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Hash"
+          ]
+        },
+        {
+          "name": "bold_italic",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Hash"
+          ]
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
@@ -15,19 +49,341 @@
     },
     {
       "type": "TYPEDEF",
-      "name": "LayersTable"
+      "name": "LayersTable",
+      "properties": [
+        {
+          "name": "fonts",
+          "brief": "",
+          "description": "",
+          "types": [
+            "LuaMap<Hash, Hash>"
+          ]
+        },
+        {
+          "name": "images",
+          "brief": "",
+          "description": "",
+          "types": [
+            "LuaMap<Hash, Hash>"
+          ]
+        },
+        {
+          "name": "spinescenes",
+          "brief": "",
+          "description": "",
+          "types": [
+            "LuaMap<Hash, Hash>"
+          ]
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "Settings"
+      "name": "Settings",
+      "properties": [
+        {
+          "name": "width",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "position",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector3"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "size",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "parent",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Opaque<\"node\">"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "fonts",
+          "brief": "",
+          "description": "",
+          "types": [
+            "FontsTable"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "layers",
+          "brief": "",
+          "description": "",
+          "types": [
+            "LayersTable"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "color",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector4"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "shadow",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector4"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "outline",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector4"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "align",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Alignment"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "valign",
+          "brief": "",
+          "description": "",
+          "types": [
+            "VAlignment"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "line_spacing",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "paragraph_spacing",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "image_pixel_grid_snap",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "combine_words",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        },
+        {
+          "name": "dryrun",
+          "brief": "",
+          "description": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "Word"
+      "name": "Word",
+      "properties": [
+        {
+          "name": "size",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "color",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector4"
+          ]
+        },
+        {
+          "name": "shadow",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector4"
+          ]
+        },
+        {
+          "name": "outline",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Vector4"
+          ]
+        },
+        {
+          "name": "node",
+          "brief": "",
+          "description": "",
+          "types": [
+            "Opaque<\"node\">"
+          ]
+        },
+        {
+          "name": "metrics",
+          "brief": "",
+          "description": "",
+          "types": [
+            "{ width: number; height: number; total_width: number; max_descent?: number; max_ascent?: number; }"
+          ],
+          "fields": [
+            {
+              "name": "width",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "False"
+            },
+            {
+              "name": "height",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "False"
+            },
+            {
+              "name": "total_width",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "False"
+            },
+            {
+              "name": "max_descent",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "True"
+            },
+            {
+              "name": "max_ascent",
+              "doc": "",
+              "types": [
+                "number"
+              ],
+              "is_optional": "True"
+            }
+          ]
+        },
+        {
+          "name": "font",
+          "brief": "",
+          "description": "",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "text",
+          "brief": "",
+          "description": "",
+          "types": [
+            "string"
+          ]
+        }
+      ]
     },
     {
       "type": "TYPEDEF",
-      "name": "TextMetrics"
+      "name": "TextMetrics",
+      "properties": [
+        {
+          "name": "width",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "height",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "char_count",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "img_count",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        },
+        {
+          "name": "spine_count",
+          "brief": "",
+          "description": "",
+          "types": [
+            "number"
+          ]
+        }
+      ]
     },
     {
       "type": "FUNCTION",
@@ -332,6 +688,8 @@
     {
       "type": "VARIABLE",
       "name": "ALIGN_LEFT",
+      "brief": "",
+      "description": "",
       "types": [
         "Alignment"
       ]
@@ -339,6 +697,8 @@
     {
       "type": "VARIABLE",
       "name": "ALIGN_CENTER",
+      "brief": "",
+      "description": "",
       "types": [
         "Alignment"
       ]
@@ -346,6 +706,8 @@
     {
       "type": "VARIABLE",
       "name": "ALIGN_RIGHT",
+      "brief": "",
+      "description": "",
       "types": [
         "Alignment"
       ]
@@ -353,6 +715,8 @@
     {
       "type": "VARIABLE",
       "name": "ALIGN_JUSTIFY",
+      "brief": "",
+      "description": "",
       "types": [
         "Alignment"
       ]
@@ -360,6 +724,8 @@
     {
       "type": "VARIABLE",
       "name": "VALIGN_TOP",
+      "brief": "",
+      "description": "",
       "types": [
         "VAlignment"
       ]
@@ -367,6 +733,8 @@
     {
       "type": "VARIABLE",
       "name": "VALIGN_MIDDLE",
+      "brief": "",
+      "description": "",
       "types": [
         "VAlignment"
       ]
@@ -374,6 +742,8 @@
     {
       "type": "VARIABLE",
       "name": "VALIGN_BOTTOM",
+      "brief": "",
+      "description": "",
       "types": [
         "VAlignment"
       ]