@defold-typescript/types 0.39.0 → 0.41.0

package/generated/label.d.ts

@@ -6,16 +6,82 @@ declare global {
    * Label API documentation
    */
   namespace label {
+    /**
+     * Rich-text layout object
+     */
+    interface layout_object {
+      /**
+       * object type, currently `link` or `sprite`
+       */
+      type: string;
+      /**
+       * the object's `id` attribute, or its generated layout object id
+       */
+      id: Hash;
+      /**
+       * zero-based UTF-32 offset in the visible text
+       */
+      text_offset: number;
+      /**
+       * visible UTF-32 text length covered by the object
+       */
+      text_length: number;
+      /**
+       * lower-left x-coordinate relative to the label's upper-left layout origin
+       */
+      x: number;
+      /**
+       * lower-left y-coordinate relative to the label's upper-left layout origin
+       */
+      y: number;
+      /**
+       * resolved object width
+       */
+      width: number;
+      /**
+       * resolved object height
+       */
+      height: number;
+      /**
+       * markup attributes keyed by name
+       */
+      attributes: LuaTable<string, string>;
+    }
+    /**
+     * Returns the sprites and links found in the label's current layout.
+     * Each entry contains `type`, `id`, the zero-based UTF-32 `text_offset`,
+     * `text_length`, resolved `x`, `y`, `width`
+     * and `height`, and an `attributes` table. The position is the lower-left
+     * object corner relative to the label's upper-left layout origin.
+     * Inline resource rendering is not part of this MVP; sprites use their explicit
+     * dimensions or a one-em square fallback.
+     *
+     * @param url - the label to inspect
+     * @returns layout objects in source order. **0️⃣ `text_offset` is 0-based; passed to Defold unchanged.**
+     * @example
+     * ```ts
+     * const objects = label.get_layout_objects("#label");
+     * for (const object of objects) {
+     *   if (object.type === "link") {
+     *     print(object.attributes.get("src"), object.text_offset, object.text_length);
+     *   } else if (object.type === "sprite") {
+     *     print(object.attributes.get("src"), object.x, object.y, object.width, object.height);
+     *   }
+     * }
+     * ```
+     */
+    function get_layout_objects(url: string | Hash | Url): label.layout_object[];
     /**
      * Gets the text from a label component
+     * This function is deprecated. Use `go.get("#label", "text")` instead.
      *
      * @param url - the label to get the text from
      * @returns the label text
      * @example
      * ```ts
      * export default defineScript({
-     *   init(self) {
-     *     const text = label.get_text("#label");
+     *   init() {
+     *     const text = go.get<label.properties>()("#label", "text");
      *     print(text);
      *   },
      * });
@@ -24,6 +90,7 @@ declare global {
     function get_text(url: string | Hash | Url): string;
     /**
      * Sets the text of a label component
+     * This function is deprecated. Use `go.set("#label", "text", value)` instead.
      * This method uses the message passing that means the value will be set after `dispatch messages` step.
      * More information is available in the Application Lifecycle manual.
      *
@@ -32,8 +99,8 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
-     *   init(self) {
-     *     label.set_text("#label", "Hello World!");
+     *   init() {
+     *     go.set<label.properties>()("#label", "text", "Hello World!");
      *   },
      * });
      * ```
@@ -68,10 +135,9 @@ declare global {
        */
       outline: Vector4;
       /**
-       * The scale of the label. The type of the property is number (uniform)
-       * or vector3 (non uniform).
+       * The scale of the label. `go.get` returns and `go.set` takes a vector3; `go.animate` also takes a number, which sets a uniform scale.
        */
-      scale: number | Vector3;
+      scale: Vector3;
       /**
        * The shadow color of the label. The type of the property is vector4.
        */
@@ -81,6 +147,10 @@ declare global {
        * The type of the property is vector3.
        */
       size: Vector3;
+      /**
+       * The text of the label.
+       */
+      text: string;
       /**
        * The tracking of the label.
        * This value is used to adjust the vertical spacing of characters in the text.

package/generated/liveupdate.d.ts

@@ -6,6 +6,7 @@ declare global {
    * Functions and constants to access resources.
    */
   namespace liveupdate {
+    type LIVEUPDATE = typeof liveupdate.LIVEUPDATE_BUNDLED_RESOURCE_MISMATCH | typeof liveupdate.LIVEUPDATE_ENGINE_VERSION_MISMATCH | typeof liveupdate.LIVEUPDATE_FORMAT_ERROR | typeof liveupdate.LIVEUPDATE_INVAL | typeof liveupdate.LIVEUPDATE_INVALID_HEADER | typeof liveupdate.LIVEUPDATE_INVALID_RESOURCE | typeof liveupdate.LIVEUPDATE_IO_ERROR | typeof liveupdate.LIVEUPDATE_MEM_ERROR | typeof liveupdate.LIVEUPDATE_OK | typeof liveupdate.LIVEUPDATE_SCHEME_MISMATCH | typeof liveupdate.LIVEUPDATE_SIGNATURE_MISMATCH | typeof liveupdate.LIVEUPDATE_UNKNOWN | typeof liveupdate.LIVEUPDATE_VERSION_MISMATCH;
     /**
      * Mismatch between between expected bundled resources and actual bundled resources. The manifest expects a resource to be in the bundle, but it was not found in the bundle. This is typically the case when a non-excluded resource was modified between publishing the bundle and publishing the manifest.
      */
@@ -39,7 +40,7 @@ declare global {
      */
     const LIVEUPDATE_MEM_ERROR: number & { readonly __brand: "liveupdate.LIVEUPDATE_MEM_ERROR" };
     /**
-     * LIVEUPDATE_OK
+     * Operation completed successfully.
      */
     const LIVEUPDATE_OK: number & { readonly __brand: "liveupdate.LIVEUPDATE_OK" };
     /**
@@ -68,7 +69,7 @@ declare global {
      * @param callback - Callback after the asynchronous request completed
      * - `name` hash Unique name of the mount
      * - `uri` string The uri of the mount
-     * - `result` number The result of the request
+     * - `result` liveupdate.LIVEUPDATE The result of the request
      * @returns The result of the request
      * @example
      * ```ts
@@ -78,34 +79,36 @@ declare global {
      * liveupdate.add_mount("season_pack_1", "zip:/path/to/easter_pack_1.zip", 30, (result) => {}); // season pack, overriding content in the other packs
      * ```
      */
-    function add_mount(name: string | Hash, uri: string, priority: number, callback: (self: unknown, name: unknown, uri: unknown, result: unknown) => void): number;
+    function add_mount(name: string | Hash, uri: string, priority: number, callback: (self: unknown, name: Hash, uri: string, result: liveupdate.LIVEUPDATE) => void): liveupdate.LIVEUPDATE;
     /**
      * Get an array of the current mounts
      * This can be used to determine if a new mount is needed or not
      *
      * @returns Array of mounts
      * @example
+     * Output the current resource mounts
      * ```ts
-     * // Output the current resource mounts
      * pprint("MOUNTS", liveupdate.get_mounts());
-     *
-     * // Give an output like:
+     * ```
+     * @example
+     * Give an output like:
+     * ```ts
      * // DEBUG:SCRIPT: MOUNTS,
      * // {
      * //   1 = {
-     * //     name = "liveupdate",
+     * //     name = hash: [liveupdate],
      * //     uri = "zip:/device/path/to/acchives/liveupdate.zip",
      * //     priority = 5
      * //   },
      * //   2 = {
-     * //     name = "_base",
+     * //     name = hash: [_base],
      * //     uri = "archive:build/default/game.dmanifest",
      * //     priority = -10
      * //   }
      * // }
      * ```
      */
-    function get_mounts(): { name: string; uri: string; priority: number }[];
+    function get_mounts(): ({ name: Hash; uri: string; priority: number })[];
     /**
      * Checks if the bundled application was built with one or more resources
      * excluded from the main bundle, through a collection proxy with
@@ -133,7 +136,7 @@ declare global {
      * liveupdate.remove_mount("season_pack_1");
      * ```
      */
-    function remove_mount(name: string | Hash): number;
+    function remove_mount(name: string | Hash): liveupdate.LIVEUPDATE;
   }
 }