@defold-typescript/types 0.39.0 → 0.41.0

package/generated/factory.d.ts

@@ -8,16 +8,17 @@ declare global {
    */
   namespace factory {
     type Status = typeof factory.STATUS_UNLOADED | typeof factory.STATUS_LOADING | typeof factory.STATUS_LOADED;
+    type STATUS = typeof factory.STATUS_LOADED | typeof factory.STATUS_LOADING | typeof factory.STATUS_UNLOADED;
     /**
-     * loaded
+     * The factory resources are loaded.
      */
     const STATUS_LOADED: number & { readonly __brand: "factory.STATUS_LOADED" };
     /**
-     * loading
+     * The factory resources are loading.
      */
     const STATUS_LOADING: number & { readonly __brand: "factory.STATUS_LOADING" };
     /**
-     * unloaded
+     * The factory resources are unloaded.
      */
     const STATUS_UNLOADED: number & { readonly __brand: "factory.STATUS_UNLOADED" };
     /**
@@ -35,8 +36,8 @@ declare global {
      * @param scale - the scale of the new game object (must be greater than 0), the scale of the game object containing the factory is used by default, or if the value is `nil`
      * @returns the global id of the spawned game object
      * @example
+     * How to create a new game object:
      * ```ts
-     * // How to create a new game object:
      * export default defineScript({
      *   init(self) {
      *     // create a new game object and provide property values
@@ -45,19 +46,20 @@ declare global {
      *     msg.post(created, "hello");
      *   },
      * });
+     * ```
+     * @example
+     * And then let the new game object have a script attached:
+     * ```ts
+     * go.property("my_value", 0);
      *
-     * // And then let the new game object have a script attached, in its own file:
-     * //
-     * //   go.property("my_value", 0);
-     * //
-     * //   export default defineScript({
-     * //     init(self) {
-     * //       // do something with self.my_value which is now one
-     * //     },
-     * //   });
+     * export default defineScript({
+     *   init(self) {
+     *     // do something with self.my_value which is now one
+     *   },
+     * });
      * ```
      */
-    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: Record<string | number, unknown>, scale?: number | Vector3): Hash;
+    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<string | Hash, unknown> | Record<string, unknown>, scale?: number | Vector3): Hash;
     /**
      * This returns status of the factory.
      * Calling this function when the factory is not marked as dynamic loading always returns
@@ -65,14 +67,8 @@ declare global {
      *
      * @param url - the factory component to get status from
      * @returns status of the factory component
-     *
-     * - `factory.STATUS_UNLOADED`
-     *
-     * - `factory.STATUS_LOADING`
-     *
-     * - `factory.STATUS_LOADED`
      */
-    function get_status(url?: string | Hash | Url): factory.Status;
+    function get_status(url: string | Hash | Url): factory.STATUS;
     /**
      * Resources are referenced by the factory component until the existing (parent) collection is destroyed or factory.unload is called.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -81,7 +77,7 @@ declare global {
      * @param complete_function - function to call when resources are loaded.
      *
      * `self`
-     * object The current object.
+     * script_instance The current script instance.
      * `url`
      * url url of the factory component
      * `result`
@@ -92,7 +88,7 @@ declare global {
      * factory.load("#factory", (self, url, result) => {});
      * ```
      */
-    function load(url?: string | Hash | Url, complete_function?: (self: unknown, url: unknown, result: unknown) => void): void;
+    function load(url: string | Hash | Url, complete_function: (self: unknown, url: Url, result: boolean) => void): void;
     /**
      * Changes the prototype for the factory.
      *
@@ -106,7 +102,7 @@ declare global {
      * const id = factory.create("#factory", go.get_world_position(), vmath.quat());
      * ```
      */
-    function set_prototype(url?: string | Hash | Url, prototype?: string): void;
+    function set_prototype(url: string | Hash | Url, prototype: string | undefined): void;
     /**
      * This decreases the reference count for each resource loaded with factory.load. If reference is zero, the resource is destroyed.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -118,7 +114,7 @@ declare global {
      * factory.unload("#factory");
      * ```
      */
-    function unload(url?: string | Hash | Url): void;
+    function unload(url: string | Hash | Url): void;
   }
 }
 

package/generated/font.d.ts

@@ -7,10 +7,36 @@ declare global {
    */
   namespace font {
     /**
-     * associates a ttf resource to a .fontc file.
+     * Associated font file information
+     */
+    interface file_info {
+      /**
+       * path to the `.ttf` or `.otf` font file
+       */
+      path: string;
+      /**
+       * hashed font-file path
+       */
+      path_hash: Hash;
+    }
+    /**
+     * Font resource information
+     */
+    interface info {
+      /**
+       * path hash of the `.fontc` resource
+       */
+      path: Hash;
+      /**
+       * associated font files
+       */
+      fonts: font.file_info[];
+    }
+    /**
+     * associates a TTF or OTF resource to a .fontc file.
      *
      * @param fontc - The path to the .fontc resource
-     * @param ttf - The path to the .ttf resource
+     * @param font - The path to the .ttf or .otf resource
      * @example
      * ```ts
      * const font_hash = hash("/assets/fonts/roboto.fontc");
@@ -18,25 +44,14 @@ declare global {
      * font.add_font(font_hash, ttf_hash);
      * ```
      */
-    function add_font(fontc: string | Hash, ttf: string | Hash): void;
+    function add_font(fontc: string | Hash, font: string | Hash): void;
     /**
      * Gets information about a font, such as the associated font files
      *
      * @param fontc - The path to the .fontc resource
-     * @returns the information table contains these fields:
-     *
-     * `path`
-     * hash The path hash of the current file.
-     * `fonts`
-     *
-     * table An array of associated font (e.g. .ttf) files. Each item is a table that contains:
-     *
-     * `path`
-     * string The path of the font file
-     * `path_hash`
-     * hash The path of the font file
+     * @returns font resource information
      */
-    function get_info(fontc: string | Hash): { path: Hash; fonts: { path: string; path_hash: Hash }[] };
+    function get_info(fontc: string | Hash): font.info;
     /**
      * prepopulates the font glyph cache with rasterised glyphs
      *
@@ -45,9 +60,9 @@ declare global {
      * @param callback - (optional) A callback function that is called after the request is finished
      *
      * `self`
-     * object The current object.
+     * script_instance The current script instance.
      * `request_id`
-     * number The request id
+     * integer The request id
      * `result`
      * boolean True if request was succesful
      * `errstring`
@@ -61,12 +76,12 @@ declare global {
      * });
      * ```
      */
-    function prewarm_text(fontc: string | Hash, text: string, callback?: (self: unknown, request_id: unknown, result: unknown, errstring: unknown) => void): number;
+    function prewarm_text(fontc: string | Hash, text: string, callback?: (self: unknown, request_id: number, result: boolean, errstring?: string) => void): number;
     /**
-     * associates a ttf resource to a .fontc file
+     * associates a TTF or OTF resource to a .fontc file
      *
      * @param fontc - The path to the .fontc resource
-     * @param ttf - The path to the .ttf resource
+     * @param font - The path to the .ttf or .otf resource
      * @example
      * ```ts
      * const font_hash = hash("/assets/fonts/roboto.fontc");
@@ -74,7 +89,34 @@ declare global {
      * font.remove_font(font_hash, ttf_hash);
      * ```
      */
-    function remove_font(fontc: string | Hash, ttf: string | Hash): void;
+    function remove_font(fontc: string | Hash, font: string | Hash): void;
+    /**
+     * Named object styles are resolved by text layouts without reshaping text.
+     * A `link` tag uses `link` by default. Callers may select another named style,
+     * such as `link:hover` or `link:active`, in response to input.
+     * Font collections initially define these named styles. Each default contains
+     * a normalized RGBA face-color multiplier and no effects. The default `link`
+     * style also uses a solid underline, which remains when hover or active colors
+     * are applied:
+     *
+     * - `link`: `(0.10, 0.45, 0.90, 1.0)`, solid underline
+     * - `link:hover`: `(0.30, 0.65, 1.00, 1.0)`
+     * - `link:active`: `(0.05, 0.30, 0.70, 1.0)`
+     *
+     * The definition is an opening-only sequence of rich-text tags. Tags are
+     * implicitly closed in reverse order. Calling this function replaces the
+     * named render properties and effects. Resource-defined decorations, such as
+     * the default `link` underline, remain unchanged.
+     *
+     * @param fontc - The path to the `.fontc` resource.
+     * @param name - Style name, for example `link:hover`.
+     * @param style - Opening-only render-style markup.
+     * @example
+     * ```ts
+     * font.set_style("/fonts/ui.fontc", "link:hover", "<color=#66b3ff><outline color=#000000 size=1><shake amplitude=0.2>");
+     * ```
+     */
+    function set_style(fontc: string | Hash, name: string, style: string): void;
   }
 }