@defold-typescript/types 0.52.0 → 0.54.0

package/fixtures/defold-1.13.2/sys_doc.json

@@ -0,0 +1,1347 @@
+{
+  "elements": [
+    {
+      "type": "FUNCTION",
+      "name": "sys.set_engine_throttle",
+      "brief": "Enables engine throttling.",
+      "description": "Enables engine throttling.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "enable",
+          "doc": "true if throttling should be enabled",
+          "types": ["boolean"],
+          "is_optional": "False"
+        },
+        {
+          "name": "cooldown",
+          "doc": "the time period to do update + render for (seconds)",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Disable throttling\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_engine_throttle</span><span class=\"p\">(</span><span class=\"kc\">false</span><span class=\"p\">)</span>\n</code></pre></div>\n\nEnable throttling\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_engine_throttle</span><span class=\"p\">(</span><span class=\"kc\">true</span><span class=\"p\">,</span> <span class=\"mf\">1.5</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "It will automatically wake up on input events",
+        "It will automatically throttle again after the cooldown period",
+        "It skips entire update+render loop on the main thread. E.g loading of assets, callbacks from threads (http)",
+        "On threaded systems, Sound will continue to play any started non-streaming sounds. (e.g. looping background music)"
+      ],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.set_render_enable",
+      "brief": "Disables rendering",
+      "description": "Disables rendering",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "enable",
+          "doc": "true if throttling should be enabled",
+          "types": ["boolean"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Disable rendering\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_render_enable</span><span class=\"p\">(</span><span class=\"kc\">false</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": ["It will will leave the back buffer as-is"],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "exit",
+      "brief": "exits application",
+      "description": "Terminates the game application and reports the specified <code>code</code> to the OS.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "code",
+          "doc": "exit code to report to the OS, 0 means clean exit",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "This examples demonstrates how to exit the application when some kind of quit messages is received (maybe from gui or similar):\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;quit&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;exit&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">code</span> <span class=\"o\">=</span> <span class=\"mi\">0</span><span class=\"p\">})</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "toggle_profile",
+      "brief": "shows/hides the on-screen profiler",
+      "description": "Toggles the on-screen profiler.\nThe profiler is a real-time tool that shows the numbers of milliseconds spent\nin each scope per frame as well as counters. The profiler is very useful for\ntracking down performance and resource problems.\nIn addition to the on-screen profiler, Defold includes a web-based profiler that\nallows you to sample a series of data points and then analyze them in detail.\nThe web profiler is available at <code>http://&lt;device IP&gt;:8002</code> where <device IP> is\nthe IP address of the device you are running your game on.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;toggle_profile&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "toggle_physics_debug",
+      "brief": "shows/hides the on-screen physics visual debugging",
+      "description": "Toggles the on-screen physics visual debugging mode which is very useful for\ntracking down issues related to physics. This mode visualizes\nall collision object shapes and normals at detected contact points. Toggling\nthis mode on is equal to setting <code>physics.debug</code> in the \"game.project\" settings,\nbut set in run-time.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;toggle_physics_debug&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "start_record",
+      "brief": "starts video recording",
+      "description": "Starts video recording of the game frame-buffer to file. Current video format is the\nopen vp8 codec in the ivf container. It's possible to upload this format directly\nto YouTube. The VLC video player has native support but with the known issue that\nnot the entire file is played back. It's probably an issue with VLC.\nThe Miro Video Converter has support for vp8/ivf.\n<span class=\"icon-macos\"></span> <span class=\"icon-windows\"></span> <span class=\"icon-linux\"></span> Video recording is only supported on desktop platforms.\n<span class=\"icon-attention\"></span> Audio is currently not supported\n<span class=\"icon-attention\"></span> Window width and height must be a multiple of 8 to be able to record video.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "file_name",
+          "doc": "file name to write the video to",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "frame_period",
+          "doc": "frame period to record, ie write every nth frame. Default value is <code>2</code>",
+          "types": ["number"],
+          "is_optional": "False"
+        },
+        {
+          "name": "fps",
+          "doc": "frames per second. Playback speed for the video. Default value is <code>30</code>. The fps value doens't affect the recording. It's only meta-data in the written video file.",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Record a video in 30 fps given that the native game fps is 60:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;start_record&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span> <span class=\"n\">file_name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;test_rec.ivf&quot;</span> <span class=\"p\">}</span> <span class=\"p\">)</span>\n</code></pre></div>\n\nTo write a video in 60 fps given that the native game fps is 60:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;start_record&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span> <span class=\"n\">file_name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;test_rec.ivf&quot;</span><span class=\"p\">,</span> <span class=\"n\">frame_period</span> <span class=\"o\">=</span> <span class=\"mi\">1</span><span class=\"p\">,</span> <span class=\"n\">fps</span> <span class=\"o\">=</span> <span class=\"mi\">60</span> <span class=\"p\">}</span> <span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "stop_record",
+      "brief": "stop current video recording",
+      "description": "Stops the currently active video recording.\n<span class=\"icon-macos\"></span> <span class=\"icon-windows\"></span> <span class=\"icon-linux\"></span> Video recording is only supported on desktop platforms.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;stop_record&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "reboot",
+      "brief": "reboot engine with arguments",
+      "description": "Reboots the game engine with a specified set of arguments.\nArguments will be translated into command line arguments. Sending the reboot\ncommand is equivalent to starting the engine with the same arguments.\nOn startup the engine reads configuration from \"game.project\" in the\nproject root.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "arg1",
+          "doc": "argument 1",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "arg2",
+          "doc": "argument 2",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "arg3",
+          "doc": "argument 3",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "arg4",
+          "doc": "argument 4",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "arg5",
+          "doc": "argument 5",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "arg6",
+          "doc": "argument 6",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "How to reboot engine with a specific bootstrap collection.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">arg1</span> <span class=\"o\">=</span> <span class=\"s1\">&#39;--config=bootstrap.main_collection=/my.collectionc&#39;</span>\n<span class=\"kd\">local</span> <span class=\"n\">arg2</span> <span class=\"o\">=</span> <span class=\"s1\">&#39;build/game.projectc&#39;</span>\n<span class=\"n\">msg</span><span class=\"p\">.</span><span class=\"n\">post</span><span class=\"p\">(</span><span class=\"s2\">&quot;@system:&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;reboot&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">arg1</span> <span class=\"o\">=</span> <span class=\"n\">arg1</span><span class=\"p\">,</span> <span class=\"n\">arg2</span> <span class=\"o\">=</span> <span class=\"n\">arg2</span><span class=\"p\">})</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "set_vsync",
+      "brief": "set vsync swap interval",
+      "description": "Request a presentation interval relative to vertical blanks (v-blank).\n0 requests disabling vsync and 1 requests presenting every refresh (the default).\nOpenGL may support larger intervals, such as 2 for every other refresh.\nVulkan and Metal treat any nonzero interval as enabling vsync; DX12 clamps\nintervals to the supported range 0 through 4. Actual behavior depends on\nthe backend, platform, and driver.\nOn platforms where Defold owns the application loop, a positive\n<code>display.update_frequency</code> or a positive value set by <code>sys.set_update_frequency()</code>\nuses timer pacing and requests a swap interval of 0. The requested\nswap interval is retained and applied again when the update frequency is set to 0.\nThis setting may be overridden by driver settings.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "swap_interval",
+          "doc": "target swap interval.",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<pre>\nmsg.post(\"@system:\", \"set_vsync\", { swap_interval = 1 } )\n</pre>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "set_update_frequency",
+      "brief": "set update frequency",
+      "description": "Set game update-frequency (frame cap). This option is equivalent to\n<code>display.update_frequency</code> in the \"game.project\" settings but set at run-time.\nOn platforms where Defold owns the application loop, a positive value uses\ntimer pacing and requests a swap interval of 0 to avoid an additional vsync\nwait where supported. Setting the frequency to 0 restores the requested swap\ninterval and uses variable-rate updates. Platform-owned loops, such as HTML5\nand iOS, retain their platform scheduling and presentation behavior. There is\nno guarantee that the frame cap will be achieved depending on platform and\nhardware constraints.\nWith engine-side timer pacing, the update dt can be shortened or enlarged to\naccount for elapsed time; the frame cap does not guarantee a constant dt.\nElapsed time beyond max(engine.max_time_step, 1 / frequency) is discarded,\nso accumulated dt can trail wall-clock time after hitches. An intentional\nfixed interval longer than engine.max_time_step is allowed. This setting\nis separate from the fixed_update() timestep.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "frequency",
+          "doc": "target frequency in hertz. 0 selects a variable\nframe rate; negative values are treated as 0.",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<pre>\nmsg.post(\"@system:\", \"set_update_frequency\", { frequency = 60 } )\n</pre>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "MESSAGE",
+      "name": "resume_rendering",
+      "brief": "resume rendering",
+      "description": "Resume rendering.\nThis message can only be sent to the designated <code>@system</code> socket.",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "<pre>\nmsg.post(\"@system:\", \"resume_rendering\")\n</pre>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "ENUM",
+      "name": "sys.REQUEST_STATUS",
+      "brief": "Asynchronous request status values",
+      "description": "Asynchronous request status values",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "sys.REQUEST_STATUS_ERROR_IO_ERROR",
+          "doc": "An I/O error occurred.",
+          "type": ""
+        },
+        {
+          "name": "sys.REQUEST_STATUS_ERROR_NOT_FOUND",
+          "doc": "The requested resource was not found.",
+          "type": ""
+        },
+        {
+          "name": "sys.REQUEST_STATUS_FINISHED",
+          "doc": "The request completed successfully.",
+          "type": ""
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.load_buffer_result",
+      "brief": "Asynchronous buffer-load result",
+      "description": "Asynchronous buffer-load result",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "status",
+          "doc": "Request status.",
+          "type": "sys.REQUEST_STATUS"
+        },
+        {
+          "name": "buffer?",
+          "doc": "Loaded payload for a successful request.",
+          "type": "buffer_data"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.load_buffer",
+      "brief": "loads a buffer from a resource or disk path",
+      "description": "The sys.load_buffer function will first try to load the resource\nfrom any of the mounted resource locations and return the data if\nany matching entries found. If not, the path will be tried\nas is from the primary disk on the device.\nIn order for the engine to include custom resources in the build process, you need\nto specify them in the \"custom_resources\" key in your \"game.project\" settings file.\nYou can specify single resource files or directories. If a directory is included\nin the resource list, all files and directories in that directory is recursively\nincluded:\nFor example \"main/data/,assets/level_data.json\".",
+      "returnvalues": [
+        {
+          "name": "buffer",
+          "doc": "the buffer with data",
+          "types": ["buffer_data"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "the path to load the buffer from",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Load binary data from a custom project resource:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">my_buffer</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_buffer</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/my_level_data.bin&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">data_str</span> <span class=\"o\">=</span> <span class=\"n\">buffer</span><span class=\"p\">.</span><span class=\"n\">get_bytes</span><span class=\"p\">(</span><span class=\"n\">my_buffer</span><span class=\"p\">,</span> <span class=\"s2\">&quot;data&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">has_my_header</span> <span class=\"o\">=</span> <span class=\"nb\">string.sub</span><span class=\"p\">(</span><span class=\"n\">data_str</span><span class=\"p\">,</span><span class=\"mi\">1</span><span class=\"p\">,</span><span class=\"mi\">6</span><span class=\"p\">)</span> <span class=\"o\">==</span> <span class=\"s2\">&quot;D3F0LD&quot;</span>\n</code></pre></div>\n\nLoad binary data from non-custom resource files on disk:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">asset_1</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_buffer</span><span class=\"p\">(</span><span class=\"s2\">&quot;folder_next_to_binary/my_level_asset.txt&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">asset_2</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_buffer</span><span class=\"p\">(</span><span class=\"s2\">&quot;/my/absolute/path&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.load_buffer_async",
+      "brief": "loads a buffer from a resource or disk path asynchronously",
+      "description": "The sys.load_buffer function will first try to load the resource\nfrom any of the mounted resource locations and return the data if\nany matching entries found. If not, the path will be tried\nas is from the primary disk on the device.\nIn order for the engine to include custom resources in the build process, you need\nto specify them in the \"custom_resources\" key in your \"game.project\" settings file.\nYou can specify single resource files or directories. If a directory is included\nin the resource list, all files and directories in that directory is recursively\nincluded:\nFor example \"main/data/,assets/level_data.json\".\nNote that issuing multiple requests of the same resource will yield\nindividual buffers per request. There is no implicit caching of the buffers\nbased on request path.",
+      "returnvalues": [
+        {
+          "name": "handle",
+          "doc": "a handle to the request",
+          "types": ["integer"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "the path to load the buffer from",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "status_callback",
+          "doc": "callback invoked when the request completes or fails",
+          "types": ["fun(self:script_instance, request_id:integer, result:sys.load_buffer_result)"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Load binary data from a custom project resource and update a texture resource:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">my_callback</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">request_id</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span>\n  <span class=\"kr\">if</span> <span class=\"n\">result</span><span class=\"p\">.</span><span class=\"n\">status</span> <span class=\"o\">==</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">REQUEST_STATUS_FINISHED</span> <span class=\"kr\">then</span>\n     <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">set_texture</span><span class=\"p\">(</span><span class=\"s2\">&quot;/my_texture&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span> <span class=\"p\">...</span> <span class=\"p\">},</span> <span class=\"n\">result</span><span class=\"p\">.</span><span class=\"n\">buffer</span><span class=\"p\">)</span>\n  <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n\n<span class=\"kd\">local</span> <span class=\"n\">my_request</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_buffer_async</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/my_level_data.bin&quot;</span><span class=\"p\">,</span> <span class=\"n\">my_callback</span><span class=\"p\">)</span>\n</code></pre></div>\n\nLoad binary data from non-custom resource files on disk:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">my_callback</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">request_id</span><span class=\"p\">,</span> <span class=\"n\">result</span><span class=\"p\">)</span>\n  <span class=\"kr\">if</span> <span class=\"n\">result</span><span class=\"p\">.</span><span class=\"n\">status</span> <span class=\"o\">~=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">REQUEST_STATUS_FINISHED</span> <span class=\"kr\">then</span>\n    <span class=\"c1\">-- uh oh! File could not be found, do something graceful</span>\n  <span class=\"kr\">elseif</span> <span class=\"n\">request_id</span> <span class=\"o\">==</span> <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">first_request</span> <span class=\"kr\">then</span>\n    <span class=\"c1\">-- result.buffer contains data from my_level_asset.bin</span>\n  <span class=\"kr\">elseif</span> <span class=\"n\">request_id</span> <span class=\"o\">==</span> <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">second_request</span> <span class=\"kr\">then</span>\n    <span class=\"c1\">-- result.buffer contains data from &#39;my_level.bin&#39;</span>\n  <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n  <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">first_request</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_buffer_async</span><span class=\"p\">(</span><span class=\"s2\">&quot;folder_next_to_binary/my_level_asset.bin&quot;</span><span class=\"p\">,</span> <span class=\"n\">my_callback</span><span class=\"p\">)</span>\n  <span class=\"n\">self</span><span class=\"p\">.</span><span class=\"n\">second_request</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_buffer_async</span><span class=\"p\">(</span><span class=\"s2\">&quot;/some_absolute_path/my_level.bin&quot;</span><span class=\"p\">,</span> <span class=\"n\">my_callback</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "ENUM",
+      "name": "sys.NETWORK",
+      "brief": "Network connectivity states",
+      "description": "Network connectivity states",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "sys.NETWORK_CONNECTED",
+          "doc": "Connected through Wi-Fi or another non-cellular network.",
+          "type": ""
+        },
+        {
+          "name": "sys.NETWORK_CONNECTED_CELLULAR",
+          "doc": "Connected through a cellular network.",
+          "type": ""
+        },
+        {
+          "name": "sys.NETWORK_DISCONNECTED",
+          "doc": "No network connection was found.",
+          "type": ""
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.open_url_attributes",
+      "brief": "URL opening attributes",
+      "description": "URL opening attributes",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "target?",
+          "doc": "HTML5 browsing context: <code>_self</code>, <code>_blank</code>, <code>_parent</code>, <code>_top</code>, or a named window.",
+          "type": "string"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.sys_info_options",
+      "brief": "System-information options",
+      "description": "System-information options",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "ignore_secure?",
+          "doc": "Omit operating-system-protected values such as <code>device_ident</code>.",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.sys_info",
+      "brief": "System information",
+      "description": "System information",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "device_model?",
+          "doc": "Device model on iOS and Android.",
+          "type": "string"
+        },
+        {
+          "name": "manufacturer?",
+          "doc": "Device manufacturer on iOS and Android.",
+          "type": "string"
+        },
+        {
+          "name": "system_name",
+          "doc": "Operating-system name.",
+          "type": "string"
+        },
+        {
+          "name": "system_version",
+          "doc": "Operating-system version.",
+          "type": "string"
+        },
+        {
+          "name": "api_version",
+          "doc": "Platform API version.",
+          "type": "string"
+        },
+        {
+          "name": "language",
+          "doc": "ISO 639 language code.",
+          "type": "string"
+        },
+        {
+          "name": "device_language",
+          "doc": "Preferred device language, optionally followed by an ISO 15924 script code.",
+          "type": "string"
+        },
+        {
+          "name": "territory",
+          "doc": "ISO 3166-1 alpha-2 country code or UN M.49 numeric region code.",
+          "type": "string"
+        },
+        {
+          "name": "gmt_offset",
+          "doc": "Current GMT offset in minutes.",
+          "type": "number"
+        },
+        {
+          "name": "device_ident?",
+          "doc": "Operating-system-protected device identifier.",
+          "type": "string"
+        },
+        {
+          "name": "user_agent?",
+          "doc": "HTTP user agent on HTML5.",
+          "type": "string"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.engine_info",
+      "brief": "Engine information",
+      "description": "Engine information",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "version",
+          "doc": "Defold engine version.",
+          "type": "string"
+        },
+        {
+          "name": "version_sha1",
+          "doc": "Engine build SHA-1.",
+          "type": "string"
+        },
+        {
+          "name": "is_debug",
+          "doc": "Whether this is a debug engine build.",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.application_info",
+      "brief": "Application information",
+      "description": "Application information",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "installed",
+          "doc": "Whether the queried application is installed.",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "STRUCT",
+      "name": "sys.interface_info",
+      "brief": "Network-interface information",
+      "description": "Network-interface information",
+      "returnvalues": [],
+      "parameters": [],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [
+        {
+          "name": "name",
+          "doc": "Interface name.",
+          "type": "string"
+        },
+        {
+          "name": "address?",
+          "doc": "IP address, when available.",
+          "type": "string"
+        },
+        {
+          "name": "mac?",
+          "doc": "Hardware MAC address, when available.",
+          "type": "string"
+        },
+        {
+          "name": "up",
+          "doc": "Whether the interface can transmit and receive data.",
+          "type": "boolean"
+        },
+        {
+          "name": "running",
+          "doc": "Whether the interface is running.",
+          "type": "boolean"
+        }
+      ],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.save",
+      "brief": "saves a lua table to a file stored on disk",
+      "description": "The table can later be loaded by <code>sys.load</code>.\nUse <code>sys.get_save_file</code> to obtain a valid location for the file.\nInternally, this function uses a workspace buffer sized output file sized 512kb.\nThis size reflects the output file size which must not exceed this limit.\nAdditionally, the total number of rows that any one table may contain is limited to 65536\n(i.e. a 16 bit range). When tables are used to represent arrays, the values of\nkeys are permitted to fall within a 32 bit range, supporting sparse arrays, however\nthe limit on the total number of rows remains in effect.\nThis function will raise a Lua error if an error occurs while saving the table.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "filename",
+          "doc": "file to write to",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "table",
+          "doc": "lua table to save",
+          "types": ["table<any, any>"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Save data:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">my_table</span> <span class=\"o\">=</span> <span class=\"p\">{}</span>\n<span class=\"nb\">table.insert</span><span class=\"p\">(</span><span class=\"n\">my_table</span><span class=\"p\">,</span> <span class=\"s2\">&quot;my_value&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">my_file_path</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_save_file</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;my_file&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">save</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">,</span> <span class=\"n\">my_table</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.load",
+      "brief": "loads a lua table from a file on disk",
+      "description": "If the file exists, it must have been created by <code>sys.save</code> to be loaded.\nThis function will raise a Lua error if an error occurs while loading the file.",
+      "returnvalues": [
+        {
+          "name": "loaded",
+          "doc": "lua table, which is empty if the file could not be found",
+          "types": ["table<any, any>"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "filename",
+          "doc": "file to read from",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Load data that was previously saved, e.g. an earlier game session:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">my_file_path</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_save_file</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;my_file&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">my_table</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span>\n<span class=\"kr\">if</span> <span class=\"ow\">not</span> <span class=\"nb\">next</span><span class=\"p\">(</span><span class=\"n\">my_table</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n  <span class=\"c1\">-- empty table</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.exists",
+      "brief": "check if a path exists",
+      "description": "Check if a path exists\nGood for checking if a file exists before loading a large file",
+      "returnvalues": [
+        {
+          "name": "result",
+          "doc": "<code>true</code> if the path exists, <code>false</code> otherwise",
+          "types": ["boolean"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "path",
+          "doc": "path to check",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Load data but return nil if path didn't exist\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">if</span> <span class=\"ow\">not</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">exists</span><span class=\"p\">(</span><span class=\"n\">path</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n    <span class=\"kr\">return</span> <span class=\"kc\">nil</span>\n<span class=\"kr\">end</span>\n<span class=\"kr\">return</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load</span><span class=\"p\">(</span><span class=\"n\">path</span><span class=\"p\">)</span> <span class=\"c1\">-- returns {} if it failed</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_host_path",
+      "brief": "create a path to the host device for unit testing",
+      "description": "Create a path to the host device for unit testing\nUseful for saving logs etc during development",
+      "returnvalues": [
+        {
+          "name": "host_path",
+          "doc": "the path prefixed with the proper host mount",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "filename",
+          "doc": "file to read from",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Save data on the host\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">host_path</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_host_path</span><span class=\"p\">(</span><span class=\"s2\">&quot;logs/test.txt&quot;</span><span class=\"p\">)</span>\n<span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">save</span><span class=\"p\">(</span><span class=\"n\">host_path</span><span class=\"p\">,</span> <span class=\"n\">mytable</span><span class=\"p\">)</span>\n</code></pre></div>\n\nLoad data from the host\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">host_path</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_host_path</span><span class=\"p\">(</span><span class=\"s2\">&quot;logs/test.txt&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">table</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load</span><span class=\"p\">(</span><span class=\"n\">host_path</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": ["Only enabled in debug builds. In release builds returns the string unchanged"],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_save_file",
+      "brief": "gets the save-file path",
+      "description": "The save-file path is operating system specific and is typically located under the user's home directory.\nThis function will raise a Lua error if unable to get the save file path.",
+      "returnvalues": [
+        {
+          "name": "path",
+          "doc": "path to save-file",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "application_id",
+          "doc": "user defined id of the application, which helps define the location of the save-file",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "file_name",
+          "doc": "file-name to get path for",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Find a path where we can store data:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">my_file_path</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_save_file</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;my_file&quot;</span><span class=\"p\">)</span>\n<span class=\"c1\">-- macOS: /Users/foobar/Library/Application Support/my_game/my_file</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /Users/foobar/Library/Application Support/my_game/my_file</span>\n\n<span class=\"c1\">-- Windows: C:\\Users\\foobar\\AppData\\Roaming\\my_game\\my_file</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; C:\\Users\\foobar\\AppData\\Roaming\\my_game\\my_file</span>\n\n<span class=\"c1\">-- Linux: $XDG_DATA_HOME/my_game/my_file or /home/foobar/.my_game/my_file</span>\n<span class=\"c1\">-- Linux: Defaults to /home/foobar/.local/share/my_game/my_file if neither exist.</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /home/foobar/.local/share/my_game/my_file</span>\n\n<span class=\"c1\">-- Android package name: com.foobar.packagename</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /data/data/0/com.foobar.packagename/files/my_file</span>\n\n<span class=\"c1\">-- iOS: my_game.app</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /var/mobile/Containers/Data/Application/123456AB-78CD-90DE-12345678ABCD/my_game/my_file</span>\n\n<span class=\"c1\">-- HTML5 path inside the IndexedDB: /data/.my_game/my_file or /.my_game/my_file</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">my_file_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /data/.my_game/my_file</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [
+        "Setting the environment variable `DM_SAVE_HOME` overrides the default application support path."
+      ],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_application_path",
+      "brief": "gets the application path",
+      "description": "The path from which the application is run.\nThis function will raise a Lua error if unable to get the application support path.",
+      "returnvalues": [
+        {
+          "name": "path",
+          "doc": "path to application executable",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [],
+      "examples": "Find a path where we can store data (the example path is on the macOS platform):\n<div class=\"codehilite\"><pre><span></span><code><span class=\"c1\">-- macOS: /Applications/my_game.app</span>\n<span class=\"kd\">local</span> <span class=\"n\">application_path</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_application_path</span><span class=\"p\">()</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">application_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /Applications/my_game.app</span>\n\n<span class=\"c1\">-- Windows: C:\\Program Files\\my_game\\my_game.exe</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">application_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; C:\\Program Files\\my_game</span>\n\n<span class=\"c1\">-- Linux: /home/foobar/my_game/my_game</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">application_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /home/foobar/my_game</span>\n\n<span class=\"c1\">-- Android package name: com.foobar.my_game</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">application_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /data/user/0/com.foobar.my_game</span>\n\n<span class=\"c1\">-- iOS: my_game.app</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">application_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; /var/containers/Bundle/Applications/123456AB-78CD-90DE-12345678ABCD/my_game.app</span>\n\n<span class=\"c1\">-- HTML5: http://www.foobar.com/my_game/</span>\n<span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">application_path</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; http://www.foobar.com/my_game</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_config_string",
+      "brief": "get string config value with optional default value",
+      "description": "Get string config value from the game.project configuration file with optional default value",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "config value as a string. default_value if the config key does not exist. nil if no default value was supplied.",
+          "types": ["string", "nil"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "key",
+          "doc": "key to get value for. The syntax is SECTION.KEY",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "default_value",
+          "doc": "(optional) default value to return if the value does not exist",
+          "types": ["string"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "Get user config value\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">text</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_config_string</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game.text&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;default text&quot;</span><span class=\"p\">)</span>\n</code></pre></div>\n\nStart the engine with a bootstrap config override and add a custom config value\n<div class=\"codehilite\"><pre><span></span><code>$ dmengine --config<span class=\"o\">=</span>bootstrap.main_collection<span class=\"o\">=</span>/mytest.collectionc --config<span class=\"o\">=</span>mygame.testmode<span class=\"o\">=</span><span class=\"m\">1</span>\n</code></pre></div>\n\nRead the custom config value from the command line\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">testmode</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_config_int</span><span class=\"p\">(</span><span class=\"s2\">&quot;mygame.testmode&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_config_int",
+      "brief": "get integer config value with optional default value",
+      "description": "Get integer config value from the game.project configuration file with optional default value",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "config value as an integer. default_value if the config key does not exist. 0 if no default value was supplied.",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "key",
+          "doc": "key to get value for. The syntax is SECTION.KEY",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "default_value",
+          "doc": "(optional) default value to return if the value does not exist",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "Get user config value\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">speed</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_config_int</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game.speed&quot;</span><span class=\"p\">,</span> <span class=\"mi\">20</span><span class=\"p\">)</span> <span class=\"c1\">-- with default value</span>\n</code></pre></div>\n\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">testmode</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_config_int</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game.testmode&quot;</span><span class=\"p\">)</span> <span class=\"c1\">-- without default value</span>\n<span class=\"kr\">if</span> <span class=\"n\">testmode</span> <span class=\"o\">~=</span> <span class=\"kc\">nil</span> <span class=\"kr\">then</span>\n    <span class=\"c1\">-- do stuff</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_config_number",
+      "brief": "get number config value with optional default value",
+      "description": "Get number config value from the game.project configuration file with optional default value",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "config value as an number. default_value if the config key does not exist. 0 if no default value was supplied.",
+          "types": ["number"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "key",
+          "doc": "key to get value for. The syntax is SECTION.KEY",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "default_value",
+          "doc": "(optional) default value to return if the value does not exist",
+          "types": ["number"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "Get user config value\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">speed</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_config_number</span><span class=\"p\">(</span><span class=\"s2\">&quot;my_game.speed&quot;</span><span class=\"p\">,</span> <span class=\"mf\">20.0</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_config_boolean",
+      "brief": "get boolean config value with optional default value",
+      "description": "Get boolean config value from the game.project configuration file with optional default value",
+      "returnvalues": [
+        {
+          "name": "value",
+          "doc": "config value as a boolean. default_value if the config key does not exist. false if no default value was supplied.",
+          "types": ["boolean"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "key",
+          "doc": "key to get value for. The syntax is SECTION.KEY",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "default_value",
+          "doc": "(optional) default value to return if the value does not exist",
+          "types": ["boolean"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "Get user config value\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">vsync</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_config_boolean</span><span class=\"p\">(</span><span class=\"s2\">&quot;display.vsync&quot;</span><span class=\"p\">,</span> <span class=\"kc\">false</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.open_url",
+      "brief": "open url in default application",
+      "description": "Open URL in default application, typically a browser",
+      "returnvalues": [
+        {
+          "name": "success",
+          "doc": "a boolean indicating if the url could be opened or not",
+          "types": ["boolean"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "url",
+          "doc": "url to open",
+          "types": ["string"],
+          "is_optional": "False"
+        },
+        {
+          "name": "attributes",
+          "doc": "optional URL opening attributes",
+          "types": ["sys.open_url_attributes"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "Open an URL:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">success</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">open_url</span><span class=\"p\">(</span><span class=\"s2\">&quot;http://www.defold.com&quot;</span><span class=\"p\">,</span> <span class=\"p\">{</span><span class=\"n\">target</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;_blank&quot;</span><span class=\"p\">})</span>\n<span class=\"kr\">if</span> <span class=\"ow\">not</span> <span class=\"n\">success</span> <span class=\"kr\">then</span>\n  <span class=\"c1\">-- could not open the url...</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.load_resource",
+      "brief": "loads resource from game data",
+      "description": "Loads a custom resource. Specify the full filename of the resource that you want\nto load. When loaded, the file data is returned as a string.\nIf loading fails, the function returns <code>nil</code> plus the error message.\nIn order for the engine to include custom resources in the build process, you need\nto specify them in the \"custom_resources\" key in your \"game.project\" settings file.\nYou can specify single resource files or directories. If a directory is included\nin the resource list, all files and directories in that directory is recursively\nincluded:\nFor example \"main/data/,assets/level_data.json\".",
+      "returnvalues": [
+        {
+          "name": "data",
+          "doc": "loaded data, or <code>nil</code> if the resource could not be loaded",
+          "types": ["string", "nil"]
+        },
+        {
+          "name": "error",
+          "doc": "the error message, or <code>nil</code> if no error occurred",
+          "types": ["string", "nil"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "filename",
+          "doc": "resource to load, full path",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"c1\">-- Load level data into a string</span>\n<span class=\"kd\">local</span> <span class=\"n\">data</span><span class=\"p\">,</span> <span class=\"nb\">error</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">load_resource</span><span class=\"p\">(</span><span class=\"s2\">&quot;/assets/level_data.json&quot;</span><span class=\"p\">)</span>\n<span class=\"c1\">-- Decode json string to a Lua table</span>\n<span class=\"kr\">if</span> <span class=\"n\">data</span> <span class=\"kr\">then</span>\n  <span class=\"kd\">local</span> <span class=\"n\">data_table</span> <span class=\"o\">=</span> <span class=\"n\">json</span><span class=\"p\">.</span><span class=\"n\">decode</span><span class=\"p\">(</span><span class=\"n\">data</span><span class=\"p\">)</span>\n  <span class=\"n\">pprint</span><span class=\"p\">(</span><span class=\"n\">data_table</span><span class=\"p\">)</span>\n<span class=\"kr\">else</span>\n  <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"nb\">error</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_sys_info",
+      "brief": "get system information",
+      "description": "Returns a table with system information.",
+      "returnvalues": [
+        {
+          "name": "sys_info",
+          "doc": "system information",
+          "types": ["sys.sys_info"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "options",
+          "doc": "optional system-information options",
+          "types": ["sys.sys_info_options"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to get system information:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">info</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_sys_info</span><span class=\"p\">()</span>\n<span class=\"kr\">if</span> <span class=\"n\">info</span><span class=\"p\">.</span><span class=\"n\">system_name</span> <span class=\"o\">==</span> <span class=\"s2\">&quot;HTML5&quot;</span> <span class=\"kr\">then</span>\n  <span class=\"c1\">-- We are running in a browser.</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_engine_info",
+      "brief": "get engine information",
+      "description": "Returns a table with engine information.",
+      "returnvalues": [
+        {
+          "name": "engine_info",
+          "doc": "engine information",
+          "types": ["sys.engine_info"]
+        }
+      ],
+      "parameters": [],
+      "examples": "How to retrieve engine information:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"c1\">-- Update version text label so our testers know what version we&#39;re running</span>\n<span class=\"kd\">local</span> <span class=\"n\">engine_info</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_engine_info</span><span class=\"p\">()</span>\n<span class=\"kd\">local</span> <span class=\"n\">version_str</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;Defold &quot;</span> <span class=\"o\">..</span> <span class=\"n\">engine_info</span><span class=\"p\">.</span><span class=\"n\">version</span> <span class=\"o\">..</span> <span class=\"s2\">&quot;</span><span class=\"se\">\\n</span><span class=\"s2\">&quot;</span> <span class=\"o\">..</span> <span class=\"n\">engine_info</span><span class=\"p\">.</span><span class=\"n\">version_sha1</span>\n<span class=\"n\">gui</span><span class=\"p\">.</span><span class=\"n\">set_text</span><span class=\"p\">(</span><span class=\"n\">gui</span><span class=\"p\">.</span><span class=\"n\">get_node</span><span class=\"p\">(</span><span class=\"s2\">&quot;version&quot;</span><span class=\"p\">),</span> <span class=\"n\">version_str</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_application_info",
+      "brief": "get application information",
+      "description": "Returns a table with application information for the requested app.\n<span class=\"icon-ios\"></span> On iOS, the <code>app_string</code> is an url scheme for the app that is queried. Your\ngame needs to list the schemes that are queried in an <code>LSApplicationQueriesSchemes</code> array\nin a custom \"Info.plist\".\n<span class=\"icon-android\"></span> On Android, the <code>app_string</code> is the package identifier for the app.",
+      "returnvalues": [
+        {
+          "name": "app_info",
+          "doc": "application information",
+          "types": ["sys.application_info"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "app_string",
+          "doc": "platform specific string with application package or query, see above for details.",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Check if twitter is installed:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sysinfo</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_sys_info</span><span class=\"p\">()</span>\n<span class=\"n\">twitter</span> <span class=\"o\">=</span> <span class=\"p\">{}</span>\n\n<span class=\"kr\">if</span> <span class=\"n\">sysinfo</span><span class=\"p\">.</span><span class=\"n\">system_name</span> <span class=\"o\">==</span> <span class=\"s2\">&quot;Android&quot;</span> <span class=\"kr\">then</span>\n  <span class=\"n\">twitter</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_application_info</span><span class=\"p\">(</span><span class=\"s2\">&quot;com.twitter.android&quot;</span><span class=\"p\">)</span>\n<span class=\"kr\">elseif</span> <span class=\"n\">sysinfo</span><span class=\"p\">.</span><span class=\"n\">system_name</span> <span class=\"o\">==</span> <span class=\"s2\">&quot;iPhone OS&quot;</span> <span class=\"kr\">then</span>\n  <span class=\"n\">twitter</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_application_info</span><span class=\"p\">(</span><span class=\"s2\">&quot;twitter:&quot;</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n\n<span class=\"kr\">if</span> <span class=\"n\">twitter</span><span class=\"p\">.</span><span class=\"n\">installed</span> <span class=\"kr\">then</span>\n  <span class=\"c1\">-- twitter is installed!</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\n<span class=\"icon-ios\"></span> Info.plist for the iOS app needs to list the schemes that are queried:\n<div class=\"codehilite\"><pre><span></span><code>...\n<span class=\"nt\">&lt;key&gt;</span>LSApplicationQueriesSchemes<span class=\"nt\">&lt;/key&gt;</span>\n <span class=\"nt\">&lt;array&gt;</span>\n   <span class=\"nt\">&lt;string&gt;</span>twitter<span class=\"nt\">&lt;/string&gt;</span>\n <span class=\"nt\">&lt;/array&gt;</span>\n...\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_ifaddrs",
+      "brief": "enumerate network interfaces",
+      "description": "Returns an array of tables with information on network interfaces.",
+      "returnvalues": [
+        {
+          "name": "ifaddrs",
+          "doc": "network interfaces",
+          "types": ["sys.interface_info[]"]
+        }
+      ],
+      "parameters": [],
+      "examples": "How to get the IP address of interface \"en0\":\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">ifaddrs</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_ifaddrs</span><span class=\"p\">()</span>\n<span class=\"kr\">for</span> <span class=\"n\">_</span><span class=\"p\">,</span><span class=\"n\">interface</span> <span class=\"kr\">in</span> <span class=\"nb\">ipairs</span><span class=\"p\">(</span><span class=\"n\">ifaddrs</span><span class=\"p\">)</span> <span class=\"kr\">do</span>\n  <span class=\"kr\">if</span> <span class=\"n\">interface</span><span class=\"p\">.</span><span class=\"n\">name</span> <span class=\"o\">==</span> <span class=\"s2\">&quot;en0&quot;</span> <span class=\"kr\">then</span>\n    <span class=\"kd\">local</span> <span class=\"n\">ip</span> <span class=\"o\">=</span> <span class=\"n\">interface</span><span class=\"p\">.</span><span class=\"n\">address</span>\n  <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.set_error_handler",
+      "brief": "set the error handler",
+      "description": "Set the Lua error handler function.\nThe error handler is a function which is called whenever a lua runtime error occurs.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "error_handler",
+          "doc": "the function to be called on error\n<dl>\n<dt><code>source</code></dt>\n<dd><span class=\"type\">string</span> The runtime context of the error. Currently, this is always <code>\"lua\"</code>.</dd>\n<dt><code>message</code></dt>\n<dd><span class=\"type\">string</span> The source file, line number and error message.</dd>\n<dt><code>traceback</code></dt>\n<dd><span class=\"type\">string</span> The stack traceback.</dd>\n</dl>",
+          "types": ["fun(source:string, message:string, traceback:string)"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Install error handler that just prints the errors\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"kr\">function</span> <span class=\"nf\">my_error_handler</span><span class=\"p\">(</span><span class=\"n\">source</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">traceback</span><span class=\"p\">)</span>\n  <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">source</span><span class=\"p\">)</span>    <span class=\"c1\">--&gt; lua</span>\n  <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">message</span><span class=\"p\">)</span>   <span class=\"c1\">--&gt; main/my.script:10: attempt to perform arithmetic on a string value</span>\n  <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"n\">traceback</span><span class=\"p\">)</span> <span class=\"c1\">--&gt; stack traceback:</span>\n                   <span class=\"c1\">--&gt;         main/test.script:10: in function &#39;boom&#39;</span>\n                   <span class=\"c1\">--&gt;         main/test.script:15: in function &lt;main/my.script:13&gt;</span>\n<span class=\"kr\">end</span>\n\n<span class=\"kd\">local</span> <span class=\"kr\">function</span> <span class=\"nf\">boom</span><span class=\"p\">()</span>\n  <span class=\"kr\">return</span> <span class=\"mi\">10</span> <span class=\"o\">+</span> <span class=\"s2\">&quot;string&quot;</span>\n<span class=\"kr\">end</span>\n\n<span class=\"kr\">function</span> <span class=\"nf\">init</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">)</span>\n  <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_error_handler</span><span class=\"p\">(</span><span class=\"n\">my_error_handler</span><span class=\"p\">)</span>\n  <span class=\"n\">boom</span><span class=\"p\">()</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.set_connectivity_host",
+      "brief": "set host to check for network connectivity against",
+      "description": "Sets the host that is used to check for network connectivity against.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "host",
+          "doc": "hostname to check against",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_connectivity_host</span><span class=\"p\">(</span><span class=\"s2\">&quot;www.google.com&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.get_connectivity",
+      "brief": "get current network connectivity status",
+      "description": "<span class=\"icon-ios\"></span> <span class=\"icon-android\"></span> Returns the current network connectivity status\non mobile platforms.\nOn desktop, this function always return <code>sys.NETWORK_CONNECTED</code>.",
+      "returnvalues": [
+        {
+          "name": "status",
+          "doc": "network connectivity status",
+          "types": ["sys.NETWORK"]
+        }
+      ],
+      "parameters": [],
+      "examples": "Check if we are connected through a cellular connection\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">if</span> <span class=\"p\">(</span><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">NETWORK_CONNECTED_CELLULAR</span> <span class=\"o\">==</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">get_connectivity</span><span class=\"p\">())</span> <span class=\"kr\">then</span>\n  <span class=\"nb\">print</span><span class=\"p\">(</span><span class=\"s2\">&quot;Connected via cellular, avoid downloading big files!&quot;</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.exit",
+      "brief": "exits application",
+      "description": "Terminates the game application and reports the specified <code>code</code> to the OS.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "code",
+          "doc": "exit code to report to the OS, 0 means clean exit",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "This examples demonstrates how to exit the application when some kind of quit messages is received (maybe from gui or similar):\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kr\">function</span> <span class=\"nf\">on_message</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">message_id</span><span class=\"p\">,</span> <span class=\"n\">message</span><span class=\"p\">,</span> <span class=\"n\">sender</span><span class=\"p\">)</span>\n    <span class=\"kr\">if</span> <span class=\"n\">message_id</span> <span class=\"o\">==</span> <span class=\"n\">hash</span><span class=\"p\">(</span><span class=\"s2\">&quot;quit&quot;</span><span class=\"p\">)</span> <span class=\"kr\">then</span>\n        <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">exit</span><span class=\"p\">(</span><span class=\"mi\">0</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span>\n<span class=\"kr\">end</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.reboot",
+      "brief": "reboot engine with arguments",
+      "description": "Reboots the game engine with a specified set of arguments.\nArguments will be translated into command line arguments. Calling reboot\nfunction is equivalent to starting the engine with the same arguments.\nOn startup the engine reads configuration from \"game.project\" in the\nproject root.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "arg1",
+          "doc": "argument 1",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "arg2",
+          "doc": "argument 2",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "arg3",
+          "doc": "argument 3",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "arg4",
+          "doc": "argument 4",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "arg5",
+          "doc": "argument 5",
+          "types": ["string"],
+          "is_optional": "True"
+        },
+        {
+          "name": "arg6",
+          "doc": "argument 6",
+          "types": ["string"],
+          "is_optional": "True"
+        }
+      ],
+      "examples": "How to reboot engine with a specific bootstrap collection.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">arg1</span> <span class=\"o\">=</span> <span class=\"s1\">&#39;--config=bootstrap.main_collection=/my.collectionc&#39;</span>\n<span class=\"kd\">local</span> <span class=\"n\">arg2</span> <span class=\"o\">=</span> <span class=\"s1\">&#39;build/game.projectc&#39;</span>\n<span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">reboot</span><span class=\"p\">(</span><span class=\"n\">arg1</span><span class=\"p\">,</span> <span class=\"n\">arg2</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.set_vsync_swap_interval",
+      "brief": "set vsync swap interval",
+      "description": "Request a presentation interval relative to vertical blanks (v-blank).\n0 requests disabling vsync and 1 requests presenting every refresh (the default).\nOpenGL may support larger intervals, such as 2 for every other refresh.\nVulkan and Metal treat any nonzero interval as enabling vsync; DX12 clamps\nintervals to the supported range 0 through 4. Actual behavior depends on\nthe backend, platform, and driver.\nOn platforms where Defold owns the application loop, a positive\n<code>display.update_frequency</code> or a positive value set by <code>sys.set_update_frequency()</code>\nuses timer pacing and requests a swap interval of 0. The requested\nswap interval is retained and applied again when the update frequency is set to 0.\nThis setting may be overridden by driver settings.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "swap_interval",
+          "doc": "target swap interval.",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Setting the swap interval to swap every v-blank\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_vsync_swap_interval</span><span class=\"p\">(</span><span class=\"mi\">1</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.set_update_frequency",
+      "brief": "set update frequency",
+      "description": "Set game update-frequency (frame cap). This option is equivalent to\n<code>display.update_frequency</code> in the \"game.project\" settings but set at run-time.\nOn platforms where Defold owns the application loop, a positive value uses\ntimer pacing and requests a swap interval of 0 to avoid an additional vsync\nwait where supported. Setting the frequency to 0 restores the requested swap\ninterval and uses variable-rate updates. Platform-owned loops, such as HTML5\nand iOS, retain their platform scheduling and presentation behavior. There is\nno guarantee that the frame cap will be achieved depending on platform and\nhardware constraints.\nWith engine-side timer pacing, the update dt can be shortened or enlarged to\naccount for elapsed time; the frame cap does not guarantee a constant dt.\nElapsed time beyond max(engine.max_time_step, 1 / frequency) is discarded,\nso accumulated dt can trail wall-clock time after hitches. An intentional\nfixed interval longer than engine.max_time_step is allowed. This setting\nis separate from the fixed_update() timestep.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "frequency",
+          "doc": "target frequency in hertz. 0 selects a variable\nframe rate; negative values are treated as 0.",
+          "types": ["number"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Setting the update frequency to 60 frames per second\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">set_update_frequency</span><span class=\"p\">(</span><span class=\"mi\">60</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.serialize",
+      "brief": "serializes a lua table to a buffer and returns it",
+      "description": "The buffer can later deserialized by <code>sys.deserialize</code>.\nThis function has all the same limitations as <code>sys.save</code>.\nThis function will raise a Lua error if an error occurs while serializing the table.",
+      "returnvalues": [
+        {
+          "name": "buffer",
+          "doc": "serialized data buffer",
+          "types": ["string"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "table",
+          "doc": "lua table to serialize",
+          "types": ["table<any, any>"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Serialize table:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">my_table</span> <span class=\"o\">=</span> <span class=\"p\">{}</span>\n<span class=\"nb\">table.insert</span><span class=\"p\">(</span><span class=\"n\">my_table</span><span class=\"p\">,</span> <span class=\"s2\">&quot;my_value&quot;</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">buffer</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">serialize</span><span class=\"p\">(</span><span class=\"n\">my_table</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    },
+    {
+      "type": "FUNCTION",
+      "name": "sys.deserialize",
+      "brief": "deserializes buffer into a lua table",
+      "description": "This function will raise a Lua error if an error occurs while deserializing the buffer.",
+      "returnvalues": [
+        {
+          "name": "table",
+          "doc": "lua table with deserialized data",
+          "types": ["table<any, any>"]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "buffer",
+          "doc": "buffer to deserialize from",
+          "types": ["string"],
+          "is_optional": "False"
+        }
+      ],
+      "examples": "Deserialize a lua table that was previously serialized:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">buffer</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">serialize</span><span class=\"p\">(</span><span class=\"n\">my_table</span><span class=\"p\">)</span>\n<span class=\"kd\">local</span> <span class=\"n\">table</span> <span class=\"o\">=</span> <span class=\"n\">sys</span><span class=\"p\">.</span><span class=\"n\">deserialize</span><span class=\"p\">(</span><span class=\"n\">buffer</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": [],
+      "language": ""
+    }
+  ],
+  "info": {
+    "namespace": "sys",
+    "name": "System",
+    "brief": "System API documentation",
+    "description": "Functions and messages for using system resources, controlling the engine,\nerror handling and debugging.",
+    "path": "engine/engine/src/script/script_engine.cpp",
+    "file": "",
+    "notes": [],
+    "language": "Lua"
+  },
+  "format_version": 2
+}