@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.13.0/crash_doc.json

@@ -0,0 +1,497 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "crash.write_dump",
+      "brief": "writes crash dump",
+      "description": "Performs the same steps as if a crash had just occured but\nallows the program to continue.\nThe generated dump can be read by crash.load_previous",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.set_file_path",
+      "brief": "sets the file location for crash dumps",
+      "description": "Crashes occuring before the path is set will be stored to a default engine location.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "file path to use",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.load_previous",
+      "brief": "loads a previously written crash dump",
+      "description": "The crash dump will be removed from disk upon a successful\nload, so loading is one-shot.",
+      "returnvalues": [
+        {
+          "name": "handle",
+          "doc": "handle to the loaded dump, or <code>nil</code> if no dump was found",
+          "types": ["number", "nil"]
+        }
+      ],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.release",
+      "brief": "releases a previously loaded crash dump",
+      "description": "releases a previously loaded crash dump",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "handle to loaded crash dump",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.set_user_field",
+      "brief": "stores user-defined string value",
+      "description": "Store a user value that will get written to a crash dump when\na crash occurs. This can be user id:s, breadcrumb data etc.\nThere are 32 slots indexed from 0. Each slot stores at most 255 characters.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "index",
+          "doc": "slot index. 0-indexed",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "value",
+          "doc": "string value to store",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_modules",
+      "brief": "get all loaded modules from when the crash occured",
+      "description": "The function returns a table containing entries with sub-tables that\nhave fields 'name' and 'address' set for all loaded modules.",
+      "returnvalues": [
+        {
+          "name": "modules",
+          "doc": "module table",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_user_field",
+      "brief": "reads user field from a loaded crash dump",
+      "description": "reads user field from a loaded crash dump",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "user data value recorded in the crash dump",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "index",
+          "doc": "user data slot index",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_sys_field",
+      "brief": "reads a system field from a loaded crash dump",
+      "description": "reads a system field from a loaded crash dump",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "value recorded in the crash dump, or <code>nil</code> if it didn't exist",
+          "types": ["string", "nil"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "index",
+          "doc": "system field enum. Must be less than <a href=\"/ref/crash#crash.SYSFIELD_MAX\">crash.SYSFIELD_MAX</a>",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_signum",
+      "brief": "read signal number from a crash report",
+      "description": "read signal number from a crash report",
+      "returnvalues": [
+        {
+          "name": "signal",
+          "doc": "signal number",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_backtrace",
+      "brief": "read backtrace recorded in a loaded crash dump",
+      "description": "A table is returned containing the addresses of the call stack.",
+      "returnvalues": [
+        {
+          "name": "backtrace",
+          "doc": "table containing the backtrace",
+          "types": ["table"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "crash.get_extra_data",
+      "brief": "read text blob recorded in a crash dump",
+      "description": "The format of read text blob is platform specific\nand not guaranteed\nbut can be useful for manual inspection.",
+      "returnvalues": [
+        {
+          "name": "blob",
+          "doc": "string with the platform specific data",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "handle",
+          "doc": "crash dump handle",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_ENGINE_VERSION",
+      "brief": "engine version as release number",
+      "description": "engine version as release number",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_ENGINE_HASH",
+      "brief": "engine version as hash",
+      "description": "engine version as hash",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_DEVICE_MODEL",
+      "brief": "device model as reported by sys.get_sys_info",
+      "description": "device model as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_MANUFACTURER",
+      "brief": "device manufacturer as reported by sys.get_sys_info",
+      "description": "device manufacturer as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_SYSTEM_NAME",
+      "brief": "system name as reported by sys.get_sys_info",
+      "description": "system name as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_SYSTEM_VERSION",
+      "brief": "system version as reported by sys.get_sys_info",
+      "description": "system version as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_LANGUAGE",
+      "brief": "system language as reported by sys.get_sys_info",
+      "description": "system language as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_DEVICE_LANGUAGE",
+      "brief": "system device language as reported by sys.get_sys_info",
+      "description": "system device language as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_TERRITORY",
+      "brief": "system territory as reported by sys.get_sys_info",
+      "description": "system territory as reported by sys.get_sys_info",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_ANDROID_BUILD_FINGERPRINT",
+      "brief": "android build fingerprint",
+      "description": "android build fingerprint",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.SYSFIELD_MAX",
+      "brief": "The max number of sysfields.",
+      "description": "The max number of sysfields.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.USERFIELD_MAX",
+      "brief": "The max number of user fields.",
+      "description": "The max number of user fields.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "CONSTANT",
+      "name": "crash.USERFIELD_SIZE",
+      "brief": "The max size of a single user field.",
+      "description": "The max size of a single user field.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "crash",
+    "name": "Crash",
+    "brief": "Crash API documentation",
+    "description": "Native crash logging functions and constants.",
+    "path": "engine/crash/src/script_crash.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  }
+}