@defold-typescript/library-types 0.23.0 → 0.24.0

package/api-doc/defsave.json

@@ -0,0 +1,518 @@
+{
+  "info": {
+    "namespace": "defsave",
+    "brief": "Save and load config and user data persistently between a Defold project's sessions",
+    "description": "Save and load config and user data persistently between a Defold project's sessions"
+  },
+  "elements": [
+    {
+      "type": "VARIABLE",
+      "name": "autosave",
+      "brief": "Set to true to autosave all loaded files that are changed on a timer",
+      "description": "Set to true to autosave all loaded files that are changed on a timer",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "autosave_timer",
+      "brief": "Amount of seconds between autosaves if changes have been made",
+      "description": "Amount of seconds between autosaves if changes have been made",
+      "types": [
+        "number"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "timer",
+      "brief": "Current timer value, only increases if autosave is enabled",
+      "description": "Current timer value, only increases if autosave is enabled",
+      "types": [
+        "number"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "changed",
+      "brief": "Locally used but can be useful to have exposed",
+      "description": "Locally used but can be useful to have exposed",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "verbose",
+      "brief": "If true then more information will be printed, such as autosaves",
+      "description": "If true then more information will be printed, such as autosaves",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "block_reloading",
+      "brief": "If true then files already loaded will never be overwritten with a reload",
+      "description": "If true then files already loaded will never be overwritten with a reload",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "appname",
+      "brief": "Determines part of the path for saving files to",
+      "description": "Determines part of the path for saving files to",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "loaded",
+      "brief": "List of files currently loaded",
+      "description": "List of files currently loaded",
+      "types": [
+        "LuaMap<string, unknown>"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "sysinfo",
+      "brief": "System information captured at module load",
+      "description": "System information captured at module load",
+      "types": [
+        "ReturnType<typeof sys.get_sys_info>"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "use_default_data",
+      "brief": "If true will attempt to load default data from the default_data table when loading an empty file",
+      "description": "If true will attempt to load default data from the default_data table when loading an empty file",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "enable_encryption",
+      "brief": "If true then all data saved and loaded will be encrypted with AES - SLOWER",
+      "description": "If true then all data saved and loaded will be encrypted with AES - SLOWER",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "encryption_key",
+      "brief": "Pick an encryption key to use if you're using encryption",
+      "description": "Pick an encryption key to use if you're using encryption",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "enable_obfuscation",
+      "brief": "If true then all data saved and loaded will be XOR obfuscated - FASTER",
+      "description": "If true then all data saved and loaded will be XOR obfuscated - FASTER",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "obfuscation_key",
+      "brief": "Pick an obfuscation key to use if you're using obfuscation; the longer the key the better",
+      "description": "Pick an obfuscation key to use if you're using obfuscation; the longer the key the better",
+      "types": [
+        "string"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "use_serialize",
+      "brief": "If true then data is serialized with sys.serialize rather than encoded as JSON",
+      "description": "If true then data is serialized with sys.serialize rather than encoded as JSON",
+      "types": [
+        "boolean"
+      ]
+    },
+    {
+      "type": "VARIABLE",
+      "name": "default_data",
+      "brief": "Default data to set files to if any cannot be loaded",
+      "description": "Default data to set files to if any cannot be loaded",
+      "types": [
+        "LuaMap<string, unknown>"
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "set_appname",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "name",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "obfuscate",
+      "brief": "XOR the input against a key, cycling the key as needed. Defaults to obfuscation_key.",
+      "description": "XOR the input against a key, cycling the key as needed. Defaults to obfuscation_key.",
+      "parameters": [
+        {
+          "name": "input",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "key",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "string"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "get_file_path",
+      "brief": "The save path a file resolves to, or nil when no file was given",
+      "description": "The save path a file resolves to, or nil when no file was given",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "string | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "load",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "get",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "key",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "unknown"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "set",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "key",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "value",
+          "doc": "",
+          "types": [
+            "any"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "save",
+      "brief": "",
+      "description": "",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "force",
+          "doc": "",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "save_all",
+      "brief": "You can save all files at once. By default, it will only actually save files with changes, but you can force saving all files by setting the force flag to true.",
+      "description": "You can save all files at once. By default, it will only actually save files with changes, but you can force saving all files by setting the force flag to true.",
+      "parameters": [
+        {
+          "name": "force",
+          "doc": "false only saves changed files and true saves all files",
+          "types": [
+            "boolean"
+          ],
+          "is_optional": "True"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "key_exists",
+      "brief": "Whether a key is set on a loaded file. Returns nil when the file is loaded but the key is absent.",
+      "description": "Whether a key is set on a loaded file. Returns nil when the file is loaded but the key is absent.",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "key",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "isset",
+      "brief": "Alias of key_exists",
+      "description": "Alias of key_exists",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        },
+        {
+          "name": "key",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "reset_to_default",
+      "brief": "Reset a file to its default_data entry, or to empty when it has none",
+      "description": "Reset a file to its default_data entry, or to empty when it has none",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean | undefined"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "is_loaded",
+      "brief": "Whether a file is currently in the loaded list",
+      "description": "Whether a file is currently in the loaded list",
+      "parameters": [
+        {
+          "name": "file",
+          "doc": "",
+          "types": [
+            "string"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": [
+        {
+          "name": "",
+          "doc": "",
+          "types": [
+            "boolean"
+          ]
+        }
+      ]
+    },
+    {
+      "type": "FUNCTION",
+      "name": "update",
+      "brief": "In your update, if you want autosave to be enabled, you will need to include",
+      "description": "In your update, if you want autosave to be enabled, you will need to include",
+      "parameters": [
+        {
+          "name": "dt",
+          "doc": "",
+          "types": [
+            "number"
+          ],
+          "is_optional": "False"
+        }
+      ],
+      "returnvalues": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "final",
+      "brief": "Save all loaded files; call from your script's final",
+      "description": "Save all loaded files; call from your script's final",
+      "parameters": [],
+      "returnvalues": []
+    }
+  ]
+}