update to 1.3.3

Author: d954mas

DefoldDocs/api/bitop.lua

@@ -1,6 +1,6 @@
 ---Bitwise operations API documentation
 ---Lua BitOp <http://bitop.luajit.org/api.html> is a C extension module for Lua 5.1/5.2 which adds bitwise operations on numbers.
----Lua BitOp is Copyright © 2008-2012 Mike Pall.
+---Lua BitOp is Copyright © 2008-2012 Mike Pall.
 ---Lua BitOp is free software, released under the MIT license (same license as the Lua core).
 ---Lua BitOp is compatible with the built-in bitwise operations in LuaJIT 2.0 and is used
 ---on platforms where Defold runs without LuaJIT.

DefoldDocs/api/game_object.lua

@@ -124,10 +124,10 @@ go.PLAYBACK_ONCE_PINGPONG = nil
 ---@param complete_function function(self, url, property) optional function to call when the animation has completed
 function go.animate(url, property, playback, to, easing, duration, delay, complete_function) end
 
----By calling this function, all stored animations of the given property will be canceled.
+---By calling this function, all or specified stored property animations of the game object or component will be canceled.
 ---See the properties guide <> for which properties can be animated and the animation guide <> for how to animate them.
----@param url string|hash|url url of the game object or component having the property
----@param property string|hash id of the property to cancel
+---@param url string|hash|url url of the game object or component
+---@param property string|hash optional id of the property to cancel
 function go.cancel_animations(url, property) end
 
 ---Delete one or more game objects identified by id. Deletion is asynchronous meaning that

DefoldDocs/api/io.lua

@@ -2,7 +2,7 @@
 ---Documentation for the Lua io standard library.
 ---From Lua 5.1 Reference Manual <https://www.lua.org/manual/5.1/>
 ---by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.
----Copyright © 2006-2012 Lua.org, PUC-Rio.
+---Copyright © 2006-2012 Lua.org, PUC-Rio.
 ---Freely available under the terms of the Lua license <https://www.lua.org/license.html>.
 ---@class io
 io = {}

DefoldDocs/api/luasocket.lua

@@ -10,7 +10,7 @@
 ---
 ---
 ---
----LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
+---LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
 ---LuaSocket is free software, released under the MIT license (same license as the Lua core).
 ---@class socket
 socket = {}

DefoldDocs/api/math.lua

@@ -2,7 +2,7 @@
 ---Documentation for the Lua math standard library.
 ---From Lua 5.1 Reference Manual <https://www.lua.org/manual/5.1/>
 ---by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.
----Copyright © 2006-2012 Lua.org, PUC-Rio.
+---Copyright © 2006-2012 Lua.org, PUC-Rio.
 ---Freely available under the terms of the Lua license <https://www.lua.org/license.html>.
 ---@class math
 math = {}

DefoldDocs/api/os.lua

@@ -2,7 +2,7 @@
 ---Documentation for the Lua os standard library.
 ---From Lua 5.1 Reference Manual <https://www.lua.org/manual/5.1/>
 ---by Roberto Ierusalimschy, Luiz Henrique de Figueiredo, Waldemar Celes.
----Copyright © 2006-2012 Lua.org, PUC-Rio.
+---Copyright © 2006-2012 Lua.org, PUC-Rio.
 ---Freely available under the terms of the Lua license <https://www.lua.org/license.html>.
 ---@class os
 os = {}

DefoldDocs/api/render.lua

@@ -1,9 +1,9 @@
 ---Rendering API documentation
 ---Rendering functions, messages and constants. The "render" namespace is
 ---accessible only from render scripts.
----The rendering API is built on top of OpenGL ES 2.0, is a subset of the
+---The rendering API was originally built on top of OpenGL ES 2.0, and it uses a subset of the
 ---OpenGL computer graphics rendering API for rendering 2D and 3D computer
----graphics. OpenGL ES 2.0 is supported on all our target platforms.
+---graphics. Our current target is OpenGLES 3.0 with fallbacks to 2.0 on some platforms.
 --- It is possible to create materials and write shaders that
 ---require features not in OpenGL ES 2.0, but those will not work cross platform.
 ---@class render
@@ -41,12 +41,24 @@ render.FILTER_LINEAR = nil
 render.FILTER_NEAREST = nil
 render.FORMAT_DEPTH = nil
 render.FORMAT_LUMINANCE = nil
+---May be nil if the format isn't supported
+render.FORMAT_R16F = nil
+---May be nil if the format isn't supported
+render.FORMAT_R32F = nil
+---May be nil if the format isn't supported
+render.FORMAT_RG16F = nil
+---May be nil if the format isn't supported
+render.FORMAT_RG32F = nil
 render.FORMAT_RGB = nil
+---May be nil if the format isn't supported
+render.FORMAT_RGB16F = nil
+---May be nil if the format isn't supported
+render.FORMAT_RGB32F = nil
 render.FORMAT_RGBA = nil
-render.FORMAT_RGBA_DXT1 = nil
-render.FORMAT_RGBA_DXT3 = nil
-render.FORMAT_RGBA_DXT5 = nil
-render.FORMAT_RGB_DXT1 = nil
+---May be nil if the format isn't supported
+render.FORMAT_RGBA16F = nil
+---May be nil if the format isn't supported
+render.FORMAT_RGBA32F = nil
 render.FORMAT_STENCIL = nil
 render.RENDER_TARGET_DEFAULT = nil
 render.STATE_BLEND = nil
@@ -96,11 +108,12 @@ function render.disable_texture(unit) end
 ---system constants buffer is used containing constants as defined in materials and set through
 ---go.set <> (or particlefx.set_constant <>) on visual components.
 ---@param predicate predicate predicate to draw for
----@param constants constant_buffer optional constants to use while rendering
-function render.draw(predicate, constants) end
+---@param options table optional table with properties:
+function render.draw(predicate, options) end
 
 ---Draws all 3d debug graphics such as lines drawn with "draw_line" messages and physics visualization.
-function render.draw_debug3d() end
+---@param options table optional table with properties:
+function render.draw_debug3d(options) end
 
 ---If another material was already enabled, it will be automatically disabled
 ---and the specified material is used instead.
@@ -173,7 +186,7 @@ function render.predicate(tags) end
 ---of parameters. The following parameter keys are available:
 ---
 ---Key                           Values
----format                        render.FORMAT_LUMINANCErender.FORMAT_RGBrender.FORMAT_RGBA render.FORMAT_RGB_DXT1render.FORMAT_RGBA_DXT1render.FORMAT_RGBA_DXT3 render.FORMAT_RGBA_DXT5render.FORMAT_DEPTHrender.FORMAT_STENCIL
+---format                        render.FORMAT_LUMINANCErender.FORMAT_RGBrender.FORMAT_RGBArender.FORMAT_DEPTHrender.FORMAT_STENCILrender.FORMAT_RGBA32Frender.FORMAT_RGBA16F
 ---width                         number
 ---height                        number
 ---min_filter                    render.FILTER_LINEARrender.FILTER_NEAREST
@@ -292,7 +305,7 @@ function render.set_depth_mask(depth) end
 ---offset for each polygon. The initial value is 0.
 ---units is multiplied by an implementation-specific value to create a
 ---constant depth offset. The initial value is 0.
----The value of the offset is computed as factor ? DZ + r ? units
+---The value of the offset is computed as factor × DZ + r × units
 ---DZ is a measurement of the depth slope of the polygon which is the change in z (depth)
 ---values divided by the change in either x or y coordinates, as you traverse a polygon.
 ---The depth values are in window coordinates, clamped to the range [0, 1].

DefoldDocs/api/resource.lua

@@ -121,11 +121,15 @@ function resource.set_sound(path, buffer) end
 ---@param buffer buffer The buffer of precreated pixel data  Currently, only 1 mipmap is generated.
 function resource.set_texture(path, table, buffer) end
 
----Stores a zip file and uses it for live update content.
----The path is renamed and stored in the (internal) live update location
+---Stores a zip file and uses it for live update content. The contents of the
+---zip file will be verified against the manifest to ensure file integrity.
+---It is possible to opt out of the resource verification using an option passed
+---to this function.
+---The path is stored in the (internal) live update location.
 ---@param path string the path to the original file on disc
 ---@param callback function(self, status) the callback function executed after the storage has completed
-function resource.store_archive(path, callback) end
+---@param options table optional table with extra parameters. Supported entries:
+function resource.store_archive(path, callback, options) end
 
 ---Create a new manifest from a buffer. The created manifest is verified
 ---by ensuring that the manifest was signed using the bundled public/private

DefoldDocs/api/sound.lua

@@ -40,7 +40,7 @@ function sound.get_peak(group, window) end
 ---square root of the mean (average) value of the squared function of
 ---the instantaneous values.
 ---For instance: for a sinewave signal with a peak gain of -1.94 dB (0.8 linear),
----the RMS is 0.8 ? 1/sqrt(2) which is about 0.566.
+---the RMS is 0.8 × 1/sqrt(2) which is about 0.566.
 --- Note the returned value might be an approximation and in particular
 ---the effective window might be larger than specified.
 ---@param group string|hash group name

DefoldDocs/api/vector_math.lua

@@ -38,7 +38,7 @@ vmath = {}
 function vmath.conj(q1) end
 
 ---Given two linearly independent vectors P and Q, the cross product,
----P ? Q, is a vector that is perpendicular to both P and Q and
+---P × Q, is a vector that is perpendicular to both P and Q and
 ---therefore normal to the plane containing them.
 ---If the two vectors have the same direction (or have the exact
 ---opposite direction from one another, i.e. are not linearly independent)
@@ -49,8 +49,8 @@ function vmath.conj(q1) end
 function vmath.cross(v1, v2) end
 
 ---The returned value is a scalar defined as:
----P ? Q = |P| |Q| cos ?
----where ? is the angle between the vectors P and Q.
+---P ⋅ Q = |P| |Q| cos θ
+---where θ is the angle between the vectors P and Q.
 ---
 ---
 --- * If the dot product is positive then the angle between the vectors is below 90 degrees.
@@ -232,8 +232,8 @@ function vmath.ortho_inv(m1) end
 
 ---Calculates the extent the projection of the first vector onto the second.
 ---The returned value is a scalar p defined as:
----p = |P| cos ? / |Q|
----where ? is the angle between the vectors P and Q.
+---p = |P| cos θ / |Q|
+---where θ is the angle between the vectors P and Q.
 ---@param v1 vector3 vector to be projected on the second
 ---@param v2 vector3 vector onto which the first will be projected, must not have zero length
 ---@return number the projected extent of the first vector onto the second