@defold-typescript/types 0.18.4 → 0.18.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defold-typescript/types",
-  "version": "0.18.4",
+  "version": "0.18.5",
   "description": "TypeScript types for the Defold engine's Lua APIs.",
   "license": "MIT",
   "repository": {

package/src/lifecycle.ts

@@ -559,7 +559,7 @@ export type ScriptPropertiesOf<T extends { properties?: object }> = NonNullable<
  * `fixed_update`, `late_update`, `on_message`, `on_input`, `final`,
  * `on_reload`.
  *
- * Scaffold it with the `defold-script` / `defold-script-typed` VSCode snippets
+ * Scaffold it with the `def-ts-defineScript-inferred-self` / `def-ts-defineScript-typed-self` VSCode snippets
  * from `defold-typescript init`.
  *
  * @param hooks - the `.script` lifecycle hook table to type and return.
@@ -594,7 +594,7 @@ export function defineScript<TProps extends object = Record<never, never>, TInit
  * the rest, all optional: `init`, `update`, `on_message`, `on_input`, `final`,
  * `on_reload`.
  *
- * Scaffold it with the `defold-gui` / `defold-gui-typed` VSCode snippets from
+ * Scaffold it with the `def-ts-defineGuiScript-inferred-self` / `def-ts-defineGuiScript-typed-self` VSCode snippets from
  * `defold-typescript init`.
  *
  * @param hooks - the `.gui_script` lifecycle hook table to type and return.
@@ -628,7 +628,7 @@ export function defineGuiScript<TProps extends object = Record<never, never>, TI
  * receive input. It accepts the rest of the set, all optional: `init`,
  * `update`, `fixed_update`, `late_update`, `on_message`, `final`, `on_reload`.
  *
- * Scaffold it with the `defold-render` / `defold-render-typed` VSCode snippets
+ * Scaffold it with the `def-ts-defineRenderScript-inferred-self` / `def-ts-defineRenderScript-typed-self` VSCode snippets
  * from `defold-typescript init`.
  *
  * @param hooks - the `.render_script` lifecycle hook table to type and return.

package/src/signature-store.ts

@@ -4,6 +4,11 @@
 // so these strengthen the rendered signature while the ref-doc prose stays.
 export interface SignatureOverride {
   signatures: string[];
+  // Optional per-overload descriptions, parallel to `signatures`: entry `i`
+  // overrides row `i`'s rendered doc prose; a `null` entry or an array shorter
+  // than `signatures` keeps the ref-doc fixture description for those rows. Every
+  // existing override omits `docs` and renders exactly as before.
+  docs?: (string | null)[];
 }
 
 // An FQN (`io.open`, `file:read`, …) maps to one override. An element with