update to 1.4.8

Author: d954mas

DefoldDocs/api/collection_factory.lua

@@ -43,6 +43,12 @@ function collectionfactory.get_status(url) end
 ---@param complete_function function(self, url, result)) function to call when resources are loaded.
 function collectionfactory.load(url, complete_function) end
 
+---Changes the prototype for the collection factory.
+---Setting the prototype to "nil" will revert back to the original prototype.
+---@param url string|hash|url the collection factory component
+---@param prototype string|nil the path to the new prototype, or nil
+function collectionfactory.set_prototype(url, prototype) end
+
 ---This decreases the reference count for each resource loaded with collectionfactory.load. If reference is zero, the resource is destroyed.
 ---Calling this function when the factory is not marked as dynamic loading does nothing.
 ---@param url string|hash|url the collection factory component to unload

DefoldDocs/api/factory.lua

@@ -36,6 +36,11 @@ function factory.get_status(url) end
 ---@param complete_function function(self, url, result)) function to call when resources are loaded.
 function factory.load(url, complete_function) end
 
+---Changes the prototype for the factory.
+---@param url string|hash|url the factory component
+---@param prototype string|nil the path to the new prototype, or nil
+function factory.set_prototype(url, prototype) end
+
 ---This decreases the reference count for each resource loaded with factory.load. If reference is zero, the resource is destroyed.
 ---Calling this function when the factory is not marked as dynamic loading does nothing.
 ---@param url string|hash|url the factory component to unload

DefoldDocs/api/game_object.lua

@@ -140,6 +140,11 @@ function go.cancel_animations(url, property) end
 ---@param recursive boolean optional boolean, set to true to recursively delete child hiearchy in child to parent order
 function go.delete(id, recursive) end
 
+---check if the specified game object exists
+---@param url string|hash|url url of the game object to check
+---@return bool true if the game object exists
+function go.exists(url) end
+
 ---gets a named property of the specified game object or component
 ---@param url string|hash|url url of the game object or component having the property
 ---@param property string|hash id of the property to retrieve
@@ -218,7 +223,7 @@ function go.get_world_transform(id) end
 ---The properties defined this way are automatically exposed in the editor in game objects and collections which use the script.
 ---Note that you can only use this function outside any callback-functions like init and update.
 ---@param name string the id of the property
----@param value number|hash|url|vector3|vector4|quaternion|resource default value of the property. In the case of a url, only the empty constructor msg.url() is allowed. In the case of a resource one of the resource constructors (eg resource.atlas(), resource.font() etc) is expected.
+---@param value number|hash|url|vector3|vector4|quaternion|resource|boolean default value of the property. In the case of a url, only the empty constructor msg.url() is allowed. In the case of a resource one of the resource constructors (eg resource.atlas(), resource.font() etc) is expected.
 function go.property(name, value) end
 
 ---sets a named property of the specified game object or component, or a material constant

DefoldDocs/api/gui.lua

@@ -208,7 +208,7 @@ gui.SIZE_MODE_MANUAL = nil
 ---together. See the examples below for more information.
 ---@param node node node to animate
 ---@param property string|constant property to animate
----@param to vector3|vector4 target property value
+---@param to number|vector3|vector4|quaternion target property value
 ---@param easing constant|vector easing to use during animation.      Either specify one of the gui.EASING_* constants or provide a      vector with a custom curve. See the animation guide <> for more information.
 ---@param duration number duration of the animation in seconds.
 ---@param delay number delay before the animation starts in seconds.
@@ -471,6 +471,11 @@ function gui.get_texture(node) end
 ---@return number tracking scaling number (default=0)
 function gui.get_tracking(node) end
 
+---Get a node and all its children as a Lua table.
+---@param node node root node to get node tree from
+---@return table a table mapping node ids to the corresponding nodes
+function gui.get_tree(node) end
+
 ---Returns true if a node is visible and false if it's not.
 ---Invisible nodes are not rendered.
 ---@param node node node to query

DefoldDocs/api/liveupdate.lua

@@ -0,0 +1,47 @@
+---LiveUpdate API documentation
+---Functions and constants to access resources.
+---@class liveupdate
+liveupdate = {}
+---Return a reference to the Manifest that is currently loaded.
+---@return number reference to the Manifest that is currently loaded
+function liveupdate.get_current_manifest() end
+
+---Is any liveupdate data mounted and currently in use?
+---This can be used to determine if a new manifest or zip file should be downloaded.
+---@return bool true if a liveupdate archive (any format) has been loaded
+function liveupdate.is_using_liveupdate_data() end
+
+---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
+---@param options table optional table with extra parameters. Supported entries:
+function liveupdate.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
+---key-pair during the bundle process and that the manifest supports the current
+---running engine version. Once the manifest is verified it is stored on device.
+---The next time the engine starts (or is rebooted) it will look for the stored
+---manifest before loading resources. Storing a new manifest allows the
+---developer to update the game, modify existing resources, or add new
+---resources to the game through LiveUpdate.
+---@param manifest_buffer string the binary data that represents the manifest
+---@param callback function(self, status) the callback function executed once the engine has attempted to store the manifest.
+function liveupdate.store_manifest(manifest_buffer, callback) end
+
+---add a resource to the data archive and runtime index. The resource will be verified
+---internally before being added to the data archive.
+---@param manifest_reference number The manifest to check against.
+---@param data string The resource data that should be stored.
+---@param hexdigest string The expected hash for the resource, retrieved through collectionproxy.missing_resources.
+---@param callback function(self, hexdigest, status) The callback function that is executed once the engine has been attempted to store the resource.
+function liveupdate.store_resource(manifest_reference, data, hexdigest, callback) end
+
+
+
+
+return liveupdate

DefoldDocs/api/render.lua

@@ -136,8 +136,8 @@ function render.enable_state(state) end
 ---used as texture with the specified unit.
 ---A material shader can then use the texture to sample from.
 ---@param unit number texture unit to enable texture for
----@param render_target render_target render target from which to enable the specified texture unit
----@param buffer_type constant buffer type from which to enable the texture
+---@param render_target handle render target or texture from which to enable the specified texture unit
+---@param buffer_type constant optional buffer type from which to enable the texture. Note that this argument only applies to render targets. Defaults to render.BUFFER_COLOR_BIT
 function render.enable_texture(unit, render_target, buffer_type) end
 
 ---Returns the logical window height that is set in the "game.project" settings.
@@ -202,6 +202,13 @@ function render.predicate(tags) end
 ---The render target can be created to support multiple color attachments. Each attachment can have different format settings and texture filters,
 ---but attachments must be added in sequence, meaning you cannot create a render target at slot 0 and 3.
 ---Instead it has to be created with all four buffer types ranging from [0..3] (as denoted by render.BUFFER_COLORX_BIT where 'X' is the attachment you want to create).
+---It is not guaranteed that the device running the script can support creating render targets with multiple color attachments. To check if the device can support multiple attachments,
+---you can check if the render table contains any of the BUFFER_COLOR1_BIT, BUFFER_COLOR2_BIT or BUFFER_COLOR3_BIT constants:
+---function init(self)
+---    if render.BUFFER_COLOR1_BIT == nil then
+---        -- this devices does not support multiple color attachments
+---    end
+---end
 ---@param name string render target name
 ---@param parameters table table of buffer parameters, see the description for available keys and values
 ---@return render_target new render target

DefoldDocs/api/resource.lua

@@ -6,28 +6,28 @@ resource = {}
 resource.COMPRESSION_TYPE_BASIS_UASTC = nil
 ---COMPRESSION_TYPE_DEFAULT compression type
 resource.COMPRESSION_TYPE_DEFAULT = nil
----LIVEUPDATE_BUNDLED_RESOURCE_MISMATCH
-resource.LIVEUPDATE_BUNDLED_RESOURCE_MISMATCH = nil
----LIVEUPDATE_ENGINE_VERSION_MISMATCH
-resource.LIVEUPDATE_ENGINE_VERSION_MISMATCH = nil
----LIVEUPDATE_FORMAT_ERROR
-resource.LIVEUPDATE_FORMAT_ERROR = nil
----LIVEUPDATE_INVALID_RESOURCE
-resource.LIVEUPDATE_INVALID_RESOURCE = nil
----LIVEUPDATE_OK
-resource.LIVEUPDATE_OK = nil
----LIVEUPDATE_SCHEME_MISMATCH
-resource.LIVEUPDATE_SCHEME_MISMATCH = nil
----LIVEUPDATE_SIGNATURE_MISMATCH
-resource.LIVEUPDATE_SIGNATURE_MISMATCH = nil
----LIVEUPDATE_VERSION_MISMATCH
-resource.LIVEUPDATE_VERSION_MISMATCH = nil
 ---luminance type texture format
 resource.TEXTURE_FORMAT_LUMINANCE = nil
+---R16F type texture format
+resource.TEXTURE_FORMAT_R16F = nil
+---R32F type texture format
+resource.TEXTURE_FORMAT_R32F = nil
+---RG16F type texture format
+resource.TEXTURE_FORMAT_RG16F = nil
+---RG32F type texture format
+resource.TEXTURE_FORMAT_RG32F = nil
 ---RGB type texture format
 resource.TEXTURE_FORMAT_RGB = nil
+---RGB16F type texture format
+resource.TEXTURE_FORMAT_RGB16F = nil
+---RGB32F type texture format
+resource.TEXTURE_FORMAT_RGB32F = nil
 ---RGBA type texture format
 resource.TEXTURE_FORMAT_RGBA = nil
+---RGBA16F type texture format
+resource.TEXTURE_FORMAT_RGBA16F = nil
+---RGBA32F type texture format
+resource.TEXTURE_FORMAT_RGBA32F = nil
 ---RGBA_ASTC_4x4 type texture format
 resource.TEXTURE_FORMAT_RGBA_ASTC_4x4 = nil
 ---RGBA_BC3 type texture format
@@ -54,6 +54,8 @@ resource.TEXTURE_FORMAT_RG_BC5 = nil
 resource.TEXTURE_FORMAT_R_BC4 = nil
 ---2D texture type
 resource.TEXTURE_TYPE_2D = nil
+---2D Array texture type
+resource.TEXTURE_TYPE_2D_ARRAY = nil
 ---Cube map texture type
 resource.TEXTURE_TYPE_CUBE_MAP = nil
 ---Constructor-like function with two purposes:
@@ -95,15 +97,29 @@ function resource.buffer(path) end
 ---@return hash Returns the atlas resource path
 function resource.create_atlas(path, table) end
 
+---This function creates a new buffer resource that can be used in the same way as any buffer created during build time.
+---The function requires a valid buffer created from either buffer.create <> or another pre-existing buffer resource.
+---By default, the new resource will take ownership of the buffer lua reference, meaning the buffer will not automatically be removed
+---when the lua reference to the buffer is garbage collected. This behaviour can be overruled by specifying 'transfer_ownership = false'
+---in the argument table. If the new buffer resource is created from a buffer object that is created by another resource,
+---the buffer object will be copied and the new resource will effectively own a copy of the buffer instead.
+---Note that the path to the new resource must have the '.bufferc' extension, "/path/my_buffer" is not a valid path but "/path/my_buffer.bufferc" is.
+---The path must also be unique, attempting to create a buffer with the same name as an existing resource will raise an error.
+---@param path string The path to the resource.
+---@param table table A table containing info about how to create the buffer. Supported entries:
+---@return hash Returns the buffer resource path
+function resource.create_buffer(path, table) end
+
 ---Creates a new texture resource that can be used in the same way as any texture created during build time.
 ---The path used for creating the texture must be unique, trying to create a resource at a path that is already
 ---registered will trigger an error. If the intention is to instead modify an existing texture, use the resource.set_texture <>
 ---function. Also note that the path to the new texture resource must have a '.texturec' extension,
 ---meaning "/path/my_texture" is not a valid path but "/path/my_texture.texturec" is.
 ---@param path string The path to the resource.
 ---@param table table A table containing info about how to create the texture. Supported entries:
+---@param buffer buffer optional buffer of precreated pixel data
 ---@return hash The path to the resource.
-function resource.create_texture(path, table) end
+function resource.create_texture(path, table, buffer) end
 
 ---Constructor-like function with two purposes:
 ---
@@ -127,21 +143,17 @@ function resource.get_atlas(path) end
 ---@return buffer The resource buffer
 function resource.get_buffer(path) end
 
----Return a reference to the Manifest that is currently loaded.
----@return number reference to the Manifest that is currently loaded
-function resource.get_current_manifest() end
-
 ---Gets the text metrics from a font
 ---@param url hash the font to get the (unscaled) metrics from
 ---@param text string text to measure
 ---@param options table A table containing parameters for the text. Supported entries:
 ---@return table a table with the following fields:
 function resource.get_text_metrics(url, text, options) end
 
----Is any liveupdate data mounted and currently in use?
----This can be used to determine if a new manifest or zip file should be downloaded.
----@return bool true if a liveupdate archive (any format) has been loaded
-function resource.is_using_liveupdate_data() end
+---Gets texture info from a texture resource path or a texture handle
+---@param path hash|string|handle The path to the resource or a texture handle
+---@return table A table containing info about the texture:
+function resource.get_texture_info(path) end
 
 ---Loads the resource data for a specific resource.
 ---@param path string The path to the resource
@@ -201,36 +213,6 @@ function resource.set_sound(path, buffer) end
 ---@param buffer buffer The buffer of precreated pixel data  To update a cube map texture you need to pass in six times the amount of data via the buffer, since a cube map has six sides!
 function resource.set_texture(path, table, buffer) end
 
----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
----@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
----key-pair during the bundle process and that the manifest supports the current
----running engine version. Once the manifest is verified it is stored on device.
----The next time the engine starts (or is rebooted) it will look for the stored
----manifest before loading resources. Storing a new manifest allows the
----developer to update the game, modify existing resources, or add new
----resources to the game through LiveUpdate.
----@param manifest_buffer string the binary data that represents the manifest
----@param callback function(self, status) the callback function executed once the engine has attempted to store the manifest.
-function resource.store_manifest(manifest_buffer, callback) end
-
----add a resource to the data archive and runtime index. The resource will be verified
----internally before being added to the data archive.
----@param manifest_reference number The manifest to check against.
----@param data string The resource data that should be stored.
----@param hexdigest string The expected hash for the resource, retrieved through collectionproxy.missing_resources.
----@param callback function(self, hexdigest, status) The callback function that is executed once the engine has been attempted to store the resource.
-function resource.store_resource(manifest_reference, data, hexdigest, callback) end
-
 ---Constructor-like function with two purposes:
 ---
 ---

DefoldDocs/api/system.lua

@@ -59,6 +59,12 @@ function sys.get_connectivity() end
 ---@return table table with engine information in the following fields:
 function sys.get_engine_info() end
 
+---Create a path to the host device for unit testing
+---Useful for saving logs etc during development
+---@param filename string file to read from
+---@return string the path prefixed with the proper host mount
+function sys.get_host_path(filename) end
+
 ---Returns an array of tables with information on network interfaces.
 ---@return table an array of tables. Each table entry contain the following fields:
 function sys.get_ifaddrs() end

DefoldDocs/api/timer.lua

@@ -22,9 +22,14 @@ function timer.cancel(handle) end
 ---@param delay number time interval in seconds
 ---@param _repeat boolean true = repeat timer until cancel, false = one-shot timer
 ---@param callback function(self, handle, time_elapsed) timer callback function
----@return hash handle identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created
+---@return hash identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created
 function timer.delay(delay, _repeat, callback) end
 
+---Get information about timer.
+---@param handle hash the timer handle returned by timer.delay()
+---@return table or nil if timer is cancelled/completed. table with data in the following fields:
+function timer.get_info(handle) end
+
 ---Manual triggering a callback for a timer.
 ---@param handle hash the timer handle returned by timer.delay()
 ---@return boolean if the timer was active, false if the timer is already cancelled / complete