@defold-typescript/library-types 0.23.0 → 0.25.0

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

@@ -1,6 +1,6 @@
 {
   "info": {
-    "namespace": "zzfx.api",
+    "namespace": "zzfx",
     "brief": "ZzFX extension for Defold",
     "description": "ZzFX extension for Defold"
   },
@@ -8,8 +8,8 @@
     {
       "type": "FUNCTION",
       "name": "play",
-      "brief": "",
-      "description": "",
+      "brief": "Build a sample from a ZzFX parameter list and play it in one call.",
+      "description": "Build a sample from a ZzFX parameter list and play it in one call.",
       "parameters": [
         {
           "name": "args",
@@ -25,8 +25,8 @@
     {
       "type": "FUNCTION",
       "name": "samplerate",
-      "brief": "",
-      "description": "",
+      "brief": "Set the sample rate used to render subsequent samples. Defaults to 44100.",
+      "description": "Set the sample rate used to render subsequent samples. Defaults to 44100.",
       "parameters": [
         {
           "name": "rate",
@@ -42,8 +42,8 @@
     {
       "type": "FUNCTION",
       "name": "play_sample",
-      "brief": "",
-      "description": "",
+      "brief": "Play a sample previously returned by {@link build_sample}.",
+      "description": "Play a sample previously returned by {@link build_sample}.",
       "parameters": [
         {
           "name": "sample",
@@ -59,8 +59,8 @@
     {
       "type": "FUNCTION",
       "name": "build_sample",
-      "brief": "",
-      "description": "",
+      "brief": "Build a reusable sample from a ZzFX parameter list, without playing it.",
+      "description": "Build a reusable sample from a ZzFX parameter list, without playing it.",
       "parameters": [
         {
           "name": "args",

package/authored-targets.json

@@ -0,0 +1,433 @@
+{
+  "targets": [
+    {
+      "repo": "https://github.com/britzl/defcon",
+      "ref": "2.6.0",
+      "license": "MIT",
+      "authored": "fixtures/authored/defcon.console.d.ts",
+      "moduleId": "defcon.console",
+      "namespace": "defcon",
+      "generated": "generated/defcon.d.ts",
+      "apiDoc": "api-doc/defcon.json",
+      "upstreamLua": ["fixtures/upstream-lua/defcon/defcon/console.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/deftest",
+      "ref": "2.8.0",
+      "license": "MIT",
+      "authored": "fixtures/authored/deftest.deftest.d.ts",
+      "moduleId": "deftest.deftest",
+      "namespace": "deftest",
+      "generated": "generated/deftest.d.ts",
+      "apiDoc": "api-doc/deftest.json",
+      "upstreamLua": ["fixtures/upstream-lua/deftest/deftest/deftest.lua"]
+    },
+    {
+      "repo": "https://github.com/subsoap/defmath",
+      "ref": "c67c227322334056cea7a631f3ddcdf2bcfd480c",
+      "license": "CC0-1.0",
+      "authored": "fixtures/authored/defmath.defmath.d.ts",
+      "moduleId": "defmath.defmath",
+      "namespace": "defmath",
+      "generated": "generated/defmath.d.ts",
+      "apiDoc": "api-doc/defmath.json",
+      "upstreamLua": ["fixtures/upstream-lua/defmath/defmath/defmath.lua"]
+    },
+    {
+      "repo": "https://github.com/subsoap/defsave",
+      "ref": "v1.2.6",
+      "license": "CC0-1.0",
+      "authored": "fixtures/authored/defsave.defsave.d.ts",
+      "moduleId": "defsave.defsave",
+      "namespace": "defsave",
+      "generated": "generated/defsave.d.ts",
+      "apiDoc": "api-doc/defsave.json",
+      "upstreamLua": ["fixtures/upstream-lua/defsave/defsave/defsave.lua"]
+    },
+    {
+      "repo": "https://github.com/thejustinwalsh/defold-zzfx",
+      "ref": "8c90e12c5b83dd39ebc7a6c0fd28aafd8e7b1eac",
+      "license": "MIT",
+      "authored": "fixtures/authored/zzfx.api.d.ts",
+      "moduleId": "zzfx.api",
+      "namespace": "zzfx",
+      "generated": "generated/zzfx.d.ts",
+      "apiDoc": "api-doc/zzfx.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-zzfx/zzfx/api.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/boom",
+      "ref": "5d47820c947dc7b68d1702dfadbf27e6e74e9319",
+      "license": "MIT",
+      "authored": "fixtures/authored/boom.boom.d.ts",
+      "moduleId": "boom.boom",
+      "namespace": "boom",
+      "generated": "generated/boom.d.ts",
+      "apiDoc": "api-doc/boom.json",
+      "upstreamLua": ["fixtures/upstream-lua/boom/boom/boom.lua"]
+    },
+    {
+      "repo": "https://github.com/whiteboxdev/library-defold-persist",
+      "ref": "b37f61040740f232d86f68e2606f27b6f1bd15c4",
+      "license": "Zlib",
+      "authored": "fixtures/authored/persist.persist.d.ts",
+      "moduleId": "persist.persist",
+      "namespace": "persist",
+      "generated": "generated/persist.d.ts",
+      "apiDoc": "api-doc/persist.json",
+      "upstreamLua": ["fixtures/upstream-lua/library-defold-persist/persist/persist.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-orthographic",
+      "ref": "3.6.3",
+      "license": "MIT",
+      "authored": "fixtures/authored/orthographic.camera.d.ts",
+      "moduleId": "orthographic.camera",
+      "namespace": "orthographic.camera",
+      "generated": "generated/orthographic.camera.d.ts",
+      "apiDoc": "api-doc/orthographic.camera.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-orthographic/orthographic/camera.lua"]
+    },
+    {
+      "repo": "https://github.com/heroiclabs/nakama-defold",
+      "ref": "v3.4.0",
+      "license": "Apache-2.0",
+      "authored": "fixtures/authored/nakama.engine.defold.d.ts",
+      "moduleId": "nakama.engine.defold",
+      "namespace": "nakama.engine.defold",
+      "generated": "generated/nakama.engine.defold.d.ts",
+      "apiDoc": "api-doc/nakama.engine.defold.json",
+      "upstreamLua": ["fixtures/upstream-lua/nakama-defold/nakama/engine/defold.lua"]
+    },
+    {
+      "repo": "https://github.com/heroiclabs/nakama-defold",
+      "ref": "v3.4.0",
+      "license": "Apache-2.0",
+      "authored": "fixtures/authored/nakama.util.log.d.ts",
+      "moduleId": "nakama.util.log",
+      "namespace": "nakama.util.log",
+      "generated": "generated/nakama.util.log.d.ts",
+      "apiDoc": "api-doc/nakama.util.log.json",
+      "upstreamLua": ["fixtures/upstream-lua/nakama-defold/nakama/util/log.lua"]
+    },
+    {
+      "repo": "https://github.com/heroiclabs/nakama-defold",
+      "ref": "v3.4.0",
+      "license": "Apache-2.0",
+      "authored": "fixtures/authored/nakama.session.d.ts",
+      "moduleId": "nakama.session",
+      "namespace": "nakama.session",
+      "generated": "generated/nakama.session.d.ts",
+      "apiDoc": "api-doc/nakama.session.json",
+      "upstreamLua": ["fixtures/upstream-lua/nakama-defold/nakama/session.lua"]
+    },
+    {
+      "repo": "https://github.com/heroiclabs/nakama-defold",
+      "ref": "v3.4.0",
+      "license": "Apache-2.0",
+      "authored": "fixtures/authored/nakama.socket.d.ts",
+      "moduleId": "nakama.socket",
+      "namespace": "nakama.socket",
+      "generated": "generated/nakama.socket.d.ts",
+      "apiDoc": "api-doc/nakama.socket.json",
+      "upstreamLua": ["fixtures/upstream-lua/nakama-defold/nakama/socket.lua"]
+    },
+    {
+      "repo": "https://github.com/indiesoftby/defold-yagames",
+      "ref": "0.19.0",
+      "license": "MIT",
+      "authored": "fixtures/authored/yagames.yagames.d.ts",
+      "moduleId": "yagames.yagames",
+      "namespace": "yagames",
+      "generated": "generated/yagames.d.ts",
+      "apiDoc": "api-doc/yagames.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-yagames/yagames/yagames.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.accelerometer.d.ts",
+      "moduleId": "in.accelerometer",
+      "namespace": "in.accelerometer",
+      "generated": "generated/in.accelerometer.d.ts",
+      "apiDoc": "api-doc/in.accelerometer.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/accelerometer.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.button.d.ts",
+      "moduleId": "in.button",
+      "namespace": "in.button",
+      "generated": "generated/in.button.d.ts",
+      "apiDoc": "api-doc/in.button.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/button.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.cursor.d.ts",
+      "moduleId": "in.cursor",
+      "namespace": "in.cursor",
+      "generated": "generated/in.cursor.d.ts",
+      "apiDoc": "api-doc/in.cursor.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/cursor.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.gesture.d.ts",
+      "moduleId": "in.gesture",
+      "namespace": "in.gesture",
+      "generated": "generated/in.gesture.d.ts",
+      "apiDoc": "api-doc/in.gesture.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/gesture.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.keyboard.d.ts",
+      "moduleId": "in.keyboard",
+      "namespace": "in.keyboard",
+      "generated": "generated/in.keyboard.d.ts",
+      "apiDoc": "api-doc/in.keyboard.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/keyboard.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.mapper.d.ts",
+      "moduleId": "in.mapper",
+      "namespace": "in.mapper",
+      "generated": "generated/in.mapper.d.ts",
+      "apiDoc": "api-doc/in.mapper.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/mapper.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.onscreen.d.ts",
+      "moduleId": "in.onscreen",
+      "namespace": "in.onscreen",
+      "generated": "generated/in.onscreen.d.ts",
+      "apiDoc": "api-doc/in.onscreen.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/onscreen.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.state.d.ts",
+      "moduleId": "in.state",
+      "namespace": "in.state",
+      "generated": "generated/in.state.d.ts",
+      "apiDoc": "api-doc/in.state.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/state.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.textbox.d.ts",
+      "moduleId": "in.textbox",
+      "namespace": "in.textbox",
+      "generated": "generated/in.textbox.d.ts",
+      "apiDoc": "api-doc/in.textbox.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/textbox.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-input",
+      "ref": "4.7.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/in.triggers.d.ts",
+      "moduleId": "in.triggers",
+      "namespace": "in.triggers",
+      "generated": "generated/in.triggers.d.ts",
+      "apiDoc": "api-doc/in.triggers.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-input/in/triggers.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/monarch",
+      "ref": "6.0.2",
+      "license": "MIT",
+      "authored": "fixtures/authored/monarch.monarch.d.ts",
+      "moduleId": "monarch.monarch",
+      "namespace": "monarch.monarch",
+      "generated": "generated/monarch.monarch.d.ts",
+      "apiDoc": "api-doc/monarch.monarch.json",
+      "upstreamLua": ["fixtures/upstream-lua/monarch/monarch/monarch.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/monarch",
+      "ref": "6.0.2",
+      "license": "MIT",
+      "authored": "fixtures/authored/monarch.transitions.easings.d.ts",
+      "moduleId": "monarch.transitions.easings",
+      "namespace": "monarch.transitions.easings",
+      "generated": "generated/monarch.transitions.easings.d.ts",
+      "apiDoc": "api-doc/monarch.transitions.easings.json",
+      "upstreamLua": ["fixtures/upstream-lua/monarch/monarch/transitions/easings.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/monarch",
+      "ref": "6.0.2",
+      "license": "MIT",
+      "authored": "fixtures/authored/monarch.transitions.gui.d.ts",
+      "moduleId": "monarch.transitions.gui",
+      "namespace": "monarch.transitions.gui",
+      "generated": "generated/monarch.transitions.gui.d.ts",
+      "apiDoc": "api-doc/monarch.transitions.gui.json",
+      "upstreamLua": ["fixtures/upstream-lua/monarch/monarch/transitions/gui.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-richtext",
+      "ref": "5.22.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/richtext.color.d.ts",
+      "moduleId": "richtext.color",
+      "namespace": "richtext.color",
+      "generated": "generated/richtext.color.d.ts",
+      "apiDoc": "api-doc/richtext.color.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-richtext/richtext/color.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-richtext",
+      "ref": "5.22.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/richtext.richtext.d.ts",
+      "moduleId": "richtext.richtext",
+      "namespace": "richtext.richtext",
+      "generated": "generated/richtext.richtext.d.ts",
+      "apiDoc": "api-doc/richtext.richtext.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-richtext/richtext/richtext.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-richtext",
+      "ref": "5.22.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/richtext.tags.d.ts",
+      "moduleId": "richtext.tags",
+      "namespace": "richtext.tags",
+      "generated": "generated/richtext.tags.d.ts",
+      "apiDoc": "api-doc/richtext.tags.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-richtext/richtext/tags.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-metrics",
+      "ref": "1.2.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/metrics.fps.d.ts",
+      "moduleId": "metrics.fps",
+      "namespace": "metrics.fps",
+      "generated": "generated/metrics.fps.d.ts",
+      "apiDoc": "api-doc/metrics.fps.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-metrics/metrics/fps.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/defold-metrics",
+      "ref": "1.2.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/metrics.mem.d.ts",
+      "moduleId": "metrics.mem",
+      "namespace": "metrics.mem",
+      "generated": "generated/metrics.mem.d.ts",
+      "apiDoc": "api-doc/metrics.mem.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-metrics/metrics/mem.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/gooey",
+      "ref": "10.5.3",
+      "license": "MIT",
+      "authored": "fixtures/authored/gooey.gooey.d.ts",
+      "moduleId": "gooey.gooey",
+      "namespace": "gooey",
+      "generated": "generated/gooey.d.ts",
+      "apiDoc": "api-doc/gooey.json",
+      "upstreamLua": ["fixtures/upstream-lua/gooey/gooey/gooey.lua"]
+    },
+    {
+      "repo": "https://github.com/jbp4444/bzAnim",
+      "ref": "v.1.2",
+      "license": "Apache-2.0",
+      "authored": "fixtures/authored/bzAnim.bzLibrary.d.ts",
+      "moduleId": "bzAnim.bzLibrary",
+      "namespace": "bzAnim",
+      "generated": "generated/bzAnim.d.ts",
+      "apiDoc": "api-doc/bzAnim.json",
+      "upstreamLua": ["fixtures/upstream-lua/bzAnim/bzAnim/bzLibrary.lua"]
+    },
+    {
+      "repo": "https://github.com/britzl/platypus",
+      "ref": "4.3.1",
+      "license": "MIT",
+      "authored": "fixtures/authored/platypus.platypus.d.ts",
+      "moduleId": "platypus.platypus",
+      "namespace": "platypus",
+      "generated": "generated/platypus.d.ts",
+      "apiDoc": "api-doc/platypus.json",
+      "upstreamLua": ["fixtures/upstream-lua/platypus/platypus/platypus.lua"]
+    },
+    {
+      "repo": "https://github.com/8bitskull/dicebag",
+      "ref": "0.3",
+      "license": "CC0-1.0",
+      "authored": "fixtures/authored/dicebag.dicebag.d.ts",
+      "moduleId": "dicebag.dicebag",
+      "namespace": "dicebag",
+      "generated": "generated/dicebag.d.ts",
+      "apiDoc": "api-doc/dicebag.json",
+      "upstreamLua": ["fixtures/upstream-lua/dicebag/dicebag/dicebag.lua"]
+    },
+    {
+      "repo": "https://github.com/whiteboxdev/library-defold-rendy",
+      "ref": "b72ee2419f2cd5e1a2281e1eed5cc4081b5cbcc3",
+      "license": "Zlib",
+      "authored": "fixtures/authored/rendy.rendy.d.ts",
+      "moduleId": "rendy.rendy",
+      "namespace": "rendy",
+      "generated": "generated/rendy.d.ts",
+      "apiDoc": "api-doc/rendy.json",
+      "upstreamLua": ["fixtures/upstream-lua/library-defold-rendy/rendy/rendy.lua"]
+    },
+    {
+      "repo": "https://github.com/heroiclabs/nakama-defold",
+      "ref": "v3.4.0",
+      "license": "Apache-2.0",
+      "authored": "fixtures/authored/nakama.nakama.d.ts",
+      "moduleId": "nakama.nakama",
+      "namespace": "nakama",
+      "generated": "generated/nakama.d.ts",
+      "apiDoc": "api-doc/nakama.json",
+      "upstreamLua": ["fixtures/upstream-lua/nakama-defold/nakama/nakama.lua"]
+    },
+    {
+      "repo": "https://github.com/Klaleus/defold-shutter",
+      "ref": "2ed27b50cda551650b01b80c1ccb5dd3f4e161fc",
+      "license": "Zlib",
+      "authored": "fixtures/authored/shutter.shutter.d.ts",
+      "moduleId": "shutter.shutter",
+      "namespace": "shutter",
+      "generated": "generated/shutter.d.ts",
+      "apiDoc": "api-doc/shutter.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-shutter/shutter/shutter.lua"]
+    },
+    {
+      "repo": "https://github.com/Klaleus/defold-checkpoint",
+      "ref": "e4268ffba8f4f968f3c27a1a066ac9660bef3a73",
+      "license": "Zlib",
+      "authored": "fixtures/authored/checkpoint.checkpoint.d.ts",
+      "moduleId": "checkpoint.checkpoint",
+      "namespace": "checkpoint",
+      "generated": "generated/checkpoint.d.ts",
+      "apiDoc": "api-doc/checkpoint.json",
+      "upstreamLua": ["fixtures/upstream-lua/defold-checkpoint/checkpoint/checkpoint.lua"]
+    }
+  ]
+}

package/generated/{boom.boom.d.ts → boom.d.ts}

@@ -1542,6 +1542,20 @@ declare function cam_rot(): number;
 declare function cam_zoom(zoom: number): void;
 declare function cam_zoom(): number;
 
+/**
+ * Transform a point from world position to screen position.
+ * @param p Point
+ * @returns Screen position
+ */
+declare function to_screen(p: Vec2): Vec2;
+
+/**
+ * Transform a point from screen position to world position.
+ * @param p Point
+ * @returns World position
+ */
+declare function to_world(p: Vec2): Vec2;
+
 /**
  * Get gravity.
  * @returns The gravity in pixels per seconds

package/generated/bridge.d.ts

@@ -235,7 +235,7 @@ declare module 'bridge.bridge' {
       /**
        * Identify the platform on which the game is currently running to customize features and settings accordingly.
        */
-      function id(): unknown;
+      function id(): string | undefined;
       /**
        * Check if the audio is enabled on the platform.
        */
@@ -261,7 +261,7 @@ declare module 'bridge.bridge' {
       /**
        * Embed auxiliary information into the game URL to pass additional data or settings when launching the game.
        */
-      function payload(): unknown;
+      function payload(): string | undefined;
       /**
        * Send a custom message with an arbitrary id to the platform.
        *
@@ -279,7 +279,7 @@ declare module 'bridge.bridge' {
       /**
        * Retrieve the top-level domain of the platform to handle domain-specific configurations and behavior.
        */
-      function tld(): unknown;
+      function tld(): string | undefined;
     }
     namespace player {
       /**
@@ -296,7 +296,7 @@ declare module 'bridge.bridge' {
       /**
        * Get the player’s unique ID on the platform to manage user-specific data and settings. Use this ID to track player progress, achievements, and purchases.
        */
-      function id(): unknown;
+      function id(): string | undefined;
       /**
        * Check if the platform supports player authorization to enable features that require user authentication, such as saving game progress or accessing social features.
        */
@@ -312,7 +312,7 @@ declare module 'bridge.bridge' {
       /**
        * Retrieve the player's name to personalize the game experience. Display the name in leaderboards, friend lists, or when sending notifications and messages.
        */
-      function name(): unknown;
+      function name(): string | undefined;
       /**
        * Get the count of player avatars available. Use this to manage and display user profile images effectively, such as showing the avatar in multiplayer lobbies or profile screens.
        */

package/generated/{bzAnim.bzLibrary.d.ts → bzAnim.d.ts}

@@ -90,4 +90,10 @@ declare module "bzAnim.bzLibrary" {
   export function isReady(): boolean;
 
   export function setDebugLevel(level: number): void;
+
+  export function setMaxPoints(num: number): void;
+
+  export function registerController(obj: Hash | string): void;
+
+  export function unregisterController(obj: Hash | string): void;
 }

package/generated/checkpoint.d.ts

@@ -0,0 +1,62 @@
+/** @noSelfInFile **/
+
+/**
+ * @see {@link https://github.com/Klaleus/defold-checkpoint|Github Source}
+ * @noResolution
+ * @example `import * as checkpoint from 'checkpoint.checkpoint'`
+ */
+declare module 'checkpoint.checkpoint' {
+	/**
+	 * The `project.title` from game.project, read once when the module loads. It is
+	 * the name the save directory is derived from.
+	 */
+	const project_title: string;
+
+	/**
+	 * The absolute path of the project's save directory, resolved once when the
+	 * module loads. Every path the other members take is relative to it, and `list`
+	 * returns paths relative to it. Ends with a separator, e.g.
+	 * `/home/klaleus/.local/share/defold-checkpoint/`.
+	 */
+	const project_save_path: string;
+
+	/**
+	 * Loads a saved file. A path ending in `.json` is read as text and decoded with
+	 * `json.decode`; anything else is loaded with `sys.load`. On success the loaded
+	 * value is returned alone, so the error slot is absent; on any failure — the file
+	 * missing, unreadable, or holding invalid content — the first value is `false` and
+	 * the second is the error string. Name the saved shape through the type parameter
+	 * to avoid casting at the call site.
+	 * @param path Path relative to `project_save_path`.
+	 * @returns The loaded value, or `false` and the error that stopped it.
+	 */
+	function read<T = unknown>(path: string): LuaMultiReturn<[T | false, string | undefined]>;
+
+	/**
+	 * Saves a value, creating any missing directories along the path first. A path
+	 * ending in `.json` is encoded with `json.encode` and written as text and flushed
+	 * immediately; anything else is written with `sys.save`. Creating the directories
+	 * goes through `lfs`, so the project needs `britzl/defold-lfs` as a dependency;
+	 * this corpus does not type it.
+	 * @param path Path relative to `project_save_path`.
+	 * @param data The value to save.
+	 * @returns `true`, or `false` and the error that stopped it.
+	 */
+	function write(path: string, data: unknown): LuaMultiReturn<[boolean, string | undefined]>;
+
+	/**
+	 * Whether a saved file exists. Returns a real boolean rather than the underlying
+	 * file attributes, so it reads directly as a condition. Goes through `lfs`, so the
+	 * project needs `britzl/defold-lfs` as a dependency.
+	 * @param path Path relative to `project_save_path`.
+	 */
+	function exists(path: string): boolean;
+
+	/**
+	 * Every saved file, found by walking the save directory breadth-first. Directories
+	 * are descended into rather than listed. Goes through `lfs`, so the project needs
+	 * `britzl/defold-lfs` as a dependency.
+	 * @returns The file paths, relative to `project_save_path`.
+	 */
+	function list(): string[];
+}

package/generated/decore.d.ts

@@ -101,7 +101,7 @@ declare module 'decore.decore' {
 		processingSystem: (table: system | undefined) => system;
 		sortedSystem: (table: system | undefined) => system;
 		sortedProcessingSystem: (table: system | undefined) => system;
-		world: (...args: unknown[]) => LuaMultiReturn<[world, unknown]>;
+		world: (...args: unknown[]) => LuaMultiReturn<[world, ...unknown[]]>;
 		addEntity: (world: world, entity: entity) => entity;
 		addSystem: (world: world, system: system) => system;
 		add: (world: world, ...args: unknown[]) => unknown;