Merge branch 'master' of https://github.com/defold/defold.github.io

Author: britzl

_data/ref/alpha/physics.json

@@ -1125,6 +1125,37 @@
       "members": [],
       "notes": []
     },
+    {
+      "type": "FUNCTION",
+      "name": "physics.update_mass",
+      "brief": "updates the mass of a dynamic 2D collision object in the physics world.",
+      "description": "The function recalculates the density of each shape based on the total area of all shapes and the specified mass, then updates the mass of the body accordingly.\nNote: Currently only supported in 2D physics.",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "collisionobject",
+          "doc": "the collision object whose mass needs to be updated.",
+          "types": [
+            "string",
+            "hash",
+            "url"
+          ]
+        },
+        {
+          "name": "mass",
+          "doc": "the new mass value to set for the collision object.",
+          "types": [
+            "number"
+          ]
+        }
+      ],
+      "examples": "<div class=\"codehilite\"><pre><span></span><code> <span class=\"n\">physics</span><span class=\"p\">.</span><span class=\"n\">update_mass</span><span class=\"p\">(</span><span class=\"s2\">&quot;#collisionobject&quot;</span><span class=\"p\">,</span> <span class=\"mi\">14</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": []
+    },
     {
       "type": "MESSAGE",
       "name": "apply_force",

_data/ref/beta/dmGraphics.json

@@ -1153,6 +1153,11 @@
           "name": "TYPE_FLOAT_MAT3",
           "doc": "",
           "type": ""
+        },
+        {
+          "name": "TYPE_IMAGE_2D",
+          "doc": "",
+          "type": ""
         }
       ],
       "notes": []

_data/ref/beta/dmTransform.json

@@ -544,7 +544,7 @@
     },
     {
       "type": "FUNCTION",
-      "name": "ToMatrix",
+      "name": "ToMatrix4",
       "brief": "Convert a transform into a 4-dim matrix",
       "description": "Convert a transform into a 4-dim matrix",
       "returnvalues": [

_data/ref/beta/go.json

@@ -1003,6 +1003,35 @@
       "members": [],
       "notes": []
     },
+    {
+      "type": "FUNCTION",
+      "name": "fixed_update",
+      "brief": "called at fixed intervals to update the script component",
+      "description": "This is a callback-function, which is called by the engine at fixed intervals to update the state of a script\ncomponent. The function will be called if 'Fixed Update Frequency' is enabled in the Engine section of game.project.\nIt can for instance be used to update game logic with the physics simulation if using a fixed timestep for the\nphysics (enabled by ticking 'Use Fixed Timestep' in the Physics section of game.project).",
+      "returnvalues": [],
+      "parameters": [
+        {
+          "name": "self",
+          "doc": "reference to the script state to be used for storing data",
+          "types": [
+            "object"
+          ]
+        },
+        {
+          "name": "dt",
+          "doc": "the time-step of the frame update",
+          "types": [
+            "number"
+          ]
+        }
+      ],
+      "examples": "",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": []
+    },
     {
       "type": "FUNCTION",
       "name": "on_message",

_data/ref/beta/gui.json

@@ -3079,7 +3079,7 @@
       "type": "FUNCTION",
       "name": "gui.clone",
       "brief": "clone a node",
-      "description": "Make a clone instance of a node.\nThis function does not clone the supplied node's children nodes.\nUse gui.clone_tree for that purpose.",
+      "description": "Make a clone instance of a node. The cloned node will be identical to the\noriginal node, except the id which is generated as the string \"node\" plus\na sequential unsigned integer value.\nThis function does not clone the supplied node's children nodes.\nUse gui.clone_tree for that purpose.",
       "returnvalues": [
         {
           "name": "clone",

_data/ref/beta/image.json

@@ -93,6 +93,44 @@
       "tparams": [],
       "members": [],
       "notes": []
+    },
+    {
+      "type": "FUNCTION",
+      "name": "image.load_buffer",
+      "brief": "load image from a string into a buffer object",
+      "description": "Load image (PNG or JPEG) from a string buffer.",
+      "returnvalues": [
+        {
+          "name": "image",
+          "doc": "object or <code>nil</code> if loading fails. The object is a table with the following fields:\n<ul>\n<li><span class=\"type\">number</span> <code>width</code>: image width</li>\n<li><span class=\"type\">number</span> <code>height</code>: image height</li>\n<li><span class=\"type\">constant</span> <code>type</code>: image type<ul>\n<li><code>image.TYPE_RGB</code></li>\n<li><code>image.TYPE_RGBA</code></li>\n<li><code>image.TYPE_LUMINANCE</code></li>\n<li><code>image.TYPE_LUMINANCE_ALPHA</code></li>\n</ul>\n</li>\n<li><span class=\"type\">buffer</span> <code>buffer</code>: the script buffer that holds the decompressed image data. See <a href=\"/ref/buffer#buffer.create\">buffer.create</a> how to use the buffer.</li>\n</ul>",
+          "types": [
+            "table",
+            "nil"
+          ]
+        }
+      ],
+      "parameters": [
+        {
+          "name": "buffer",
+          "doc": "image data buffer",
+          "types": [
+            "string"
+          ]
+        },
+        {
+          "name": "[premult]",
+          "doc": "optional flag if alpha should be premultiplied. Defaults to <code>false</code>",
+          "types": [
+            "boolean"
+          ]
+        }
+      ],
+      "examples": "Load an image from an URL as a buffer and create a texture resource from it:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"kd\">local</span> <span class=\"n\">imgurl</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;http://www.site.com/image.png&quot;</span>\n<span class=\"n\">http</span><span class=\"p\">.</span><span class=\"n\">request</span><span class=\"p\">(</span><span class=\"n\">imgurl</span><span class=\"p\">,</span> <span class=\"s2\">&quot;GET&quot;</span><span class=\"p\">,</span> <span class=\"kr\">function</span><span class=\"p\">(</span><span class=\"n\">self</span><span class=\"p\">,</span> <span class=\"n\">id</span><span class=\"p\">,</span> <span class=\"n\">response</span><span class=\"p\">)</span>\n        <span class=\"kd\">local</span> <span class=\"n\">img</span> <span class=\"o\">=</span> <span class=\"n\">image</span><span class=\"p\">.</span><span class=\"n\">load_buffer</span><span class=\"p\">(</span><span class=\"n\">response</span><span class=\"p\">.</span><span class=\"n\">response</span><span class=\"p\">)</span>\n        <span class=\"kd\">local</span> <span class=\"n\">tparams</span> <span class=\"o\">=</span> <span class=\"p\">{</span>\n            <span class=\"n\">width</span>  <span class=\"o\">=</span> <span class=\"n\">img</span><span class=\"p\">.</span><span class=\"n\">width</span><span class=\"p\">,</span>\n            <span class=\"n\">height</span> <span class=\"o\">=</span> <span class=\"n\">img</span><span class=\"p\">.</span><span class=\"n\">height</span><span class=\"p\">,</span>\n            <span class=\"nb\">type</span>   <span class=\"o\">=</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">TEXTURE_TYPE_2D</span><span class=\"p\">,</span>\n            <span class=\"n\">format</span> <span class=\"o\">=</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">TEXTURE_FORMAT_RGBA</span> <span class=\"p\">}</span>\n\n        <span class=\"kd\">local</span> <span class=\"n\">my_texture_id</span> <span class=\"o\">=</span> <span class=\"n\">resource</span><span class=\"p\">.</span><span class=\"n\">create_texture</span><span class=\"p\">(</span><span class=\"s2\">&quot;/my_custom_texture.texturec&quot;</span><span class=\"p\">,</span> <span class=\"n\">tparams</span><span class=\"p\">,</span> <span class=\"n\">img</span><span class=\"p\">.</span><span class=\"n\">buffer</span><span class=\"p\">)</span>\n        <span class=\"c1\">-- Apply the texture to a model</span>\n        <span class=\"n\">go</span><span class=\"p\">.</span><span class=\"n\">set</span><span class=\"p\">(</span><span class=\"s2\">&quot;/go1#model&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;texture0&quot;</span><span class=\"p\">,</span> <span class=\"n\">my_texture_id</span><span class=\"p\">)</span>\n    <span class=\"kr\">end</span><span class=\"p\">)</span>\n</code></pre></div>",
+      "replaces": "",
+      "error": "",
+      "tparams": [],
+      "members": [],
+      "notes": []
     }
   ],
   "info": {

_data/ref/beta/json.json

@@ -21,6 +21,13 @@
           "types": [
             "string"
           ]
+        },
+        {
+          "name": "options",
+          "doc": "table with decode options\n<ul>\n<li><span class=\"type\">string</span> <code>decode_null_as_userdata</code>: wether to decode a JSON null value as json.null or nil (default is nil)</li>\n</ul>",
+          "types": [
+            "table"
+          ]
         }
       ],
       "examples": "Converting a string containing JSON data into a Lua table:\n<div class=\"codehilite\"><pre><span></span><code><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=\"kd\">local</span> <span class=\"n\">jsonstring</span> <span class=\"o\">=</span> <span class=\"s1\">&#39;{&quot;persons&quot;:[{&quot;name&quot;:&quot;John Doe&quot;},{&quot;name&quot;:&quot;Darth Vader&quot;}]}&#39;</span>\n    <span class=\"kd\">local</span> <span class=\"n\">data</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\">jsonstring</span><span class=\"p\">)</span>\n    <span class=\"n\">pprint</span><span class=\"p\">(</span><span class=\"n\">data</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\nResults in the following printout:\n<div class=\"codehilite\"><pre><span></span><code>{\n  persons = {\n    1 = {\n      name = John Doe,\n    }\n    2 = {\n      name = Darth Vader,\n    }\n  }\n}\n</code></pre></div>",
@@ -51,6 +58,13 @@
           "types": [
             "table"
           ]
+        },
+        {
+          "name": "options",
+          "doc": "table with encode options\n<ul>\n<li><span class=\"type\">string</span> <code>encode_empty_table_as_object</code>: wether to encode an empty table as an JSON object or array (default is object)</li>\n</ul>",
+          "types": [
+            "table"
+          ]
         }
       ],
       "examples": "Convert a lua table to a JSON string:\n<div class=\"codehilite\"><pre><span></span><code><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=\"kd\">local</span> <span class=\"n\">tbl</span> <span class=\"o\">=</span> <span class=\"p\">{</span>\n          <span class=\"n\">persons</span> <span class=\"o\">=</span> <span class=\"p\">{</span>\n               <span class=\"p\">{</span> <span class=\"n\">name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;John Doe&quot;</span><span class=\"p\">},</span>\n               <span class=\"p\">{</span> <span class=\"n\">name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;Darth Vader&quot;</span><span class=\"p\">}</span>\n          <span class=\"p\">}</span>\n     <span class=\"p\">}</span>\n     <span class=\"kd\">local</span> <span class=\"n\">jsonstring</span> <span class=\"o\">=</span> <span class=\"n\">json</span><span class=\"p\">.</span><span class=\"n\">encode</span><span class=\"p\">(</span><span class=\"n\">tbl</span><span class=\"p\">)</span>\n     <span class=\"n\">pprint</span><span class=\"p\">(</span><span class=\"n\">jsonstring</span><span class=\"p\">)</span>\n<span class=\"kr\">end</span>\n</code></pre></div>\n\nResults in the following printout:\n<div class=\"codehilite\"><pre><span></span><code>{&quot;persons&quot;:[{&quot;name&quot;:&quot;John Doe&quot;},{&quot;name&quot;:&quot;Darth Vader&quot;}]}\n</code></pre></div>",

_data/ref/beta/liveupdate.json

@@ -63,7 +63,9 @@
       "error": "",
       "tparams": [],
       "members": [],
-      "notes": []
+      "notes": [
+        "deprecated"
+      ]
     },
     {
       "type": "FUNCTION",
@@ -92,7 +94,9 @@
       "error": "",
       "tparams": [],
       "members": [],
-      "notes": []
+      "notes": [
+        "deprecated"
+      ]
     },
     {
       "type": "FUNCTION",
@@ -128,7 +132,9 @@
       "error": "",
       "tparams": [],
       "members": [],
-      "notes": []
+      "notes": [
+        "deprecated"
+      ]
     },
     {
       "type": "FUNCTION",
@@ -150,7 +156,9 @@
       "error": "",
       "tparams": [],
       "members": [],
-      "notes": []
+      "notes": [
+        "deprecated"
+      ]
     },
     {
       "type": "FUNCTION",
@@ -167,7 +175,7 @@
         }
       ],
       "parameters": [],
-      "examples": "",
+      "examples": "Output the current resource mounts\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">pprint</span><span class=\"p\">(</span><span class=\"s2\">&quot;MOUNTS&quot;</span><span class=\"p\">,</span> <span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">get_mounts</span><span class=\"p\">())</span>\n</code></pre></div>\n\nGive an output like:\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">DEBUG</span><span class=\"p\">:</span><span class=\"n\">SCRIPT</span><span class=\"p\">:</span> <span class=\"n\">MOUNTS</span><span class=\"p\">,</span>\n<span class=\"p\">{</span> <span class=\"cm\">--[[0x119667bf0]]</span>\n  <span class=\"mi\">1</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"cm\">--[[0x119667c50]]</span>\n    <span class=\"n\">name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;liveupdate&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">uri</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;zip:/device/path/to/acchives/liveupdate.zip&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">priority</span> <span class=\"o\">=</span> <span class=\"mi\">5</span>\n  <span class=\"p\">},</span>\n  <span class=\"mi\">2</span> <span class=\"o\">=</span> <span class=\"p\">{</span> <span class=\"cm\">--[[0x119667d50]]</span>\n    <span class=\"n\">name</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;_base&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">uri</span> <span class=\"o\">=</span> <span class=\"s2\">&quot;archive:build/default/game.dmanifest&quot;</span><span class=\"p\">,</span>\n    <span class=\"n\">priority</span> <span class=\"o\">=</span> <span class=\"o\">-</span><span class=\"mi\">10</span>\n  <span class=\"p\">}</span>\n<span class=\"p\">}</span>\n</code></pre></div>",
       "replaces": "",
       "error": "",
       "tparams": [],
@@ -218,7 +226,7 @@
           ]
         }
       ],
-      "examples": "",
+      "examples": "Add multiple mounts. Higher priority takes precedence.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">add_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;common&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;zip:/path/to/common_stuff.zip&quot;</span><span class=\"p\">,</span> <span class=\"mi\">10</span><span class=\"p\">)</span> <span class=\"c1\">-- base pack</span>\n<span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">add_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;levelpack_1&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;zip:/path/to/levels_1_to_20.zip&quot;</span><span class=\"p\">,</span> <span class=\"mi\">20</span><span class=\"p\">)</span> <span class=\"c1\">-- level pack</span>\n<span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">add_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;season_pack_1&quot;</span><span class=\"p\">,</span> <span class=\"s2\">&quot;zip:/path/to/easter_pack_1.zip&quot;</span><span class=\"p\">,</span> <span class=\"mi\">30</span><span class=\"p\">)</span> <span class=\"c1\">-- season pack, overriding content in the other packs</span>\n</code></pre></div>",
       "replaces": "",
       "error": "",
       "tparams": [],
@@ -252,7 +260,7 @@
           ]
         }
       ],
-      "examples": "",
+      "examples": "Add multiple mounts. Higher priority takes precedence.\n<div class=\"codehilite\"><pre><span></span><code><span class=\"n\">liveupdate</span><span class=\"p\">.</span><span class=\"n\">remove_mount</span><span class=\"p\">(</span><span class=\"s2\">&quot;season_pack_1&quot;</span><span class=\"p\">)</span>\n</code></pre></div>",
       "replaces": "",
       "error": "",
       "tparams": [],