update to 1.2.191

Author: d954mas

DefoldDocs/api/collision_object.lua

@@ -36,6 +36,11 @@ function physics.destroy_joint(collisionobject, joint_id) end
 ---@return vector3 gravity vector of collection
 function physics.get_gravity() end
 
+---Returns the group name of a collision object as a hash.
+---@param url string|hash|url the collision object to return the group of.
+---@return hash hash value of the group. function checkIsEnemy()     local grp = physics.get_group("#collisionobject")     assert( grp == hash("enemy") ) end
+function physics.get_group(url) end
+
 ---Get a table for properties for a connected joint. The joint has to be created before
 ---properties can be retrieved.
 ---Note: Currently only supported in 2D physics.
@@ -60,6 +65,13 @@ function physics.get_joint_reaction_force(collisionobject, joint_id) end
 ---@return float the reaction torque on bodyB in N*m.
 function physics.get_joint_reaction_torque(collisionobject, joint_id) end
 
+---Returns true if the specified group is set in the mask of a collision
+---object, false otherwise.
+---@param url string|hash|url the collision object to check the mask of.
+---@param group string the name of the group to check for.
+---@return boolean boolean value of the maskbit. 'true' if present, 'false' otherwise. function checkCollideWithUser()     -- to check if the collisionobject would collide with "user" group     local hits_user = physics.get_maskbit("#collisionobject","user")     return hits_user end
+function physics.get_maskbit(url, group) end
+
 ---Ray casts are used to test for intersections against collision objects in the physics world.
 ---Collision objects of types kinematic, dynamic and static are tested against. Trigger objects
 ---do not intersect with ray casts.
@@ -95,6 +107,13 @@ function physics.raycast_async(from, to, groups, request_id) end
 ---@param gravity vector3 the new gravity vector
 function physics.set_gravity(gravity) end
 
+---Updates the group property of a collision object to the specified
+---string value. The group name should exist i.e. have been used in
+---a collision object in the editor.
+---@param url string|hash|url the collision object affected.
+---@param group string the new group name to be assigned. function changeCollisionGroup()      physics.set_group("#collisionobject", "enemy") end
+function physics.set_group(url, group) end
+
 ---Flips the collision shapes horizontally for a collision object
 ---@param url string|hash|url the collision object that should flip its shapes
 ---@param flip boolean true if the collision object should flip its shapes, false if not
@@ -108,6 +127,12 @@ function physics.set_hflip(url, flip) end
 ---@param properties table joint specific properties table Note: The collide_connected field cannot be updated/changed after a connection has been made.
 function physics.set_joint_properties(collisionobject, joint_id, properties) end
 
+---Sets or clears the masking of a group (maskbit) in a collision object.
+---@param url string|hash|url the collision object to change the mask of.
+---@param group string the name of the group (maskbit) to modify in the mask.
+---@param type bool  boolean value of the new maskbit. 'true' to enable, 'false' to disable. function makeUserAlly()     -- no longer collide with the "user" group     physics.set_maskbit("#collisionobject","user",false) end
+function physics.set_maskbit(url, group, type) end
+
 ---Flips the collision shapes vertically for a collision object
 ---@param url string|hash|url the collision object that should flip its shapes
 ---@param flip boolean true if the collision object should flip its shapes, false if not

DefoldDocs/api/game_object.lua

@@ -112,7 +112,8 @@ go.PLAYBACK_ONCE_PINGPONG = nil
 ---By starting a new animation in that function, several animations can be sequenced together. See the examples for more information.
 --- If you call go.animate() from a game object's final() function,
 ---any passed complete_function will be ignored and never called upon animation completion.
----See the properties guide <> for which properties can be animated and the animation guide <> for how to animate them.
+---See the properties guide <> for which properties can be animated and the animation guide <> for how
+---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 animate
 ---@param playback constant playback mode of the animation
@@ -126,7 +127,7 @@ function go.animate(url, property, playback, to, easing, duration, delay, comple
 ---By calling this function, all stored animations of the given property 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 ide of the property to animate
+---@param property string|hash 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
@@ -142,8 +143,9 @@ function go.delete(id, recursive) 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
+---@param options table (optional) options table - index integer index into array property (1 based) - key hash name of internal property
 ---@return any the value of the specified property
-function go.get(url, property) end
+function go.get(url, property, options) end
 
 ---Returns or constructs an instance identifier. The instance id is a hash
 ---of the absolute path to the instance.
@@ -223,7 +225,8 @@ function go.property(name, value) end
 ---@param url string|hash|url url of the game object or component having the property
 ---@param property string|hash id of the property to set
 ---@param value any the value to set
-function go.set(url, property, value) end
+---@param options table (optional) options table - index integer index into array property (1 based) - key hash name of internal property
+function go.set(url, property, value, options) end
 
 ---Sets the parent for a game object instance. This means that the instance will exist in the geometrical space of its parent,
 ---like a basic transformation hierarchy or scene graph. If no parent is specified, the instance will be detached from any parent and exist in world

DefoldDocs/api/gui.lua

@@ -258,6 +258,10 @@ function gui.delete_texture(texture) end
 ---@return constant the current adjust mode
 function gui.get_adjust_mode(node) end
 
+---gets the node alpha
+---@param node node node from which to get alpha
+function gui.get_alpha(node) end
+
 ---Returns the blend mode of a node.
 ---Blend mode defines how the node will be blended with the background.
 ---@param node node node from which to get the blend mode
@@ -316,6 +320,11 @@ function gui.get_flipbook_playback_rate(node) end
 ---@return hash font id
 function gui.get_font(node) end
 
+---This is only useful for text nodes. The font must be mapped to the gui scene in the gui editor.
+---@param font_name hash|string font of which to get the path hash
+---@return hash path hash to resource
+function gui.get_font_resource(font_name) end
+
 ---Returns the scene height.
 ---@return number scene height
 function gui.get_height() end
@@ -488,21 +497,6 @@ function gui.get_spine_skin(node) end
 ---@return string text value
 function gui.get_text(node) end
 
----Get text metrics given the provided font, text and parameters.
----@param font string|hash font id
----@param text string text to measure
----@param width number max-width. Use for line-breaks (default=FLT_MAX)
----@param line_break boolean true to break lines accordingly to width (default=false)
----@param leading number scale value for line spacing (default=1)
----@param tracking number scale value for letter spacing (default=0)
----@return table a table with the following fields:
-function gui.get_text_metrics(font, text, width, line_break, leading, tracking) end
-
----Get the text metrics from a text node.
----@param node node text node to measure text from
----@return table a table with the following fields:
-function gui.get_text_metrics_from_node(node) end
-
 ---Returns the texture of a node.
 ---This is currently only useful for box or pie nodes.
 ---The texture must be mapped to the gui scene in the gui editor.
@@ -639,6 +633,11 @@ function gui.reset_nodes() end
 ---@param adjust_mode constant adjust mode to set
 function gui.set_adjust_mode(node, adjust_mode) end
 
+---sets the node alpha
+---@param node node node for which to set alpha
+---@param alpha number 0..1 alpha color
+function gui.set_alpha(node, alpha) end
+
 ---Set the blend mode of a node.
 ---Blend mode defines how the node will be blended with the background.
 ---@param node node node to set blend mode for

DefoldDocs/api/label.lua

@@ -7,11 +7,6 @@ label = {}
 ---@return string the label text
 function label.get_text(url) end
 
----Gets the text metrics from a label component
----@param url string|hash|url the label to get the (unscaled) metrics from
----@return table a table with the following fields:
-function label.get_text_metrics(url) end
-
 ---Sets the text of a label component
 --- This method uses the message passing that means the value will be set after dispatch messages step.
 ---More information is available in the Application Lifecycle manual <>.

DefoldDocs/api/resource.lua

@@ -71,6 +71,13 @@ function resource.get_buffer(path) end
 ---@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

DefoldDocs/api/sound.lua

@@ -89,6 +89,7 @@ function sound.pause(url, pause) end
 ---@param url string|hash|url the sound that should play
 ---@param play_properties table 
 ---@param complete_function function(self, message_id, message, sender)) function to call when the sound has finished playing.
+---@return number The identifier for the sound voice
 function sound.play(url, play_properties, complete_function) end
 
 ---Set gain on all active playing voices of a sound.

DefoldDocs/api/spine.lua

@@ -2,67 +2,6 @@
 ---Spine model API documentation
 ---@class spine
 spine = {}
----Cancels all running animations on a specified spine model component.
----@param url string|hash|url the spine model for which to cancel the animation
-function spine.cancel(url) end
-
----Returns the id of the game object that corresponds to a specified skeleton bone.
----The returned game object can be used for parenting and transform queries.
----This function has complexity O(n), where n is the number of bones in the spine model skeleton.
----Game objects corresponding to a spine model skeleton bone can not be individually deleted.
----@param url string|hash|url the spine model to query
----@param bone_id string|hash id of the corresponding bone
----@return hash id of the game object
-function spine.get_go(url, bone_id) end
-
----Plays a specified animation on a spine model component with specified playback
----mode and parameters.
----An optional completion callback function can be provided that will be called when
----the animation has completed playing. If no function is provided,
----a spine_animation_done <> message is sent to the script that started the animation.
---- The callback is not called (or message sent) if the animation is
----cancelled with spine.cancel <>. The callback is called (or message sent) only for
----animations that play with the following playback modes:
----
----
---- * go.PLAYBACK_ONCE_FORWARD
----
---- * go.PLAYBACK_ONCE_BACKWARD
----
---- * go.PLAYBACK_ONCE_PINGPONG
----@param url string|hash|url the spine model for which to play the animation
----@param anim_id string|hash id of the animation to play
----@param playback constant playback mode of the animation
----@param play_properties table optional table with properties:
----@param complete_function function(self, message_id, message, sender)) function to call when the animation has completed.
-function spine.play_anim(url, anim_id, playback, play_properties, complete_function) end
-
----Resets any previously set IK target of a spine model, the position will be reset
----to the original position from the spine scene.
----@param url string|hash|url the spine model containing the object
----@param ik_constraint_id string|hash id of the corresponding IK constraint object
-function spine.reset_ik_target(url, ik_constraint_id) end
-
----Sets a game object as target position of an inverse kinematic (IK) object. As the
----target game object's position is updated, the constraint object is updated with the
----new position.
----@param url string|hash|url the spine model containing the object
----@param ik_constraint_id string|hash id of the corresponding IK constraint object
----@param target_url string|hash|url target game object
-function spine.set_ik_target(url, ik_constraint_id, target_url) end
-
----Sets a static (vector3) target position of an inverse kinematic (IK) object.
----@param url string|hash|url the spine model containing the object
----@param ik_constraint_id string|hash id of the corresponding IK constraint object
----@param position vector3 target position
-function spine.set_ik_target_position(url, ik_constraint_id, position) end
-
----Sets the spine skin on a spine model.
----@param url string|hash|url the spine model for which to set skin
----@param spine_skin string|hash spine skin id
----@param spine_slot string|hash optional slot id to only change a specific slot
-function spine.set_skin(url, spine_skin, spine_slot) end
-
 
 
 

DefoldDocs/api/system.lua

@@ -9,6 +9,11 @@ sys.NETWORK_CONNECTED = nil
 sys.NETWORK_CONNECTED_CELLULAR = nil
 ---no network connection found
 sys.NETWORK_DISCONNECTED = nil
+---deserializes buffer into a lua table
+---@param buffer string buffer to deserialize from
+---@return table lua table with deserialized data
+function sys.deserialize(buffer) end
+
 ---Terminates the game application and reports the specified code to the OS.
 ---@param code number exit code to report to the OS, 0 means clean exit
 function sys.exit(code) end
@@ -114,6 +119,12 @@ function sys.reboot(arg1, arg2, arg3, arg4, arg5, arg6) end
 ---@return boolean a boolean indicating if the table could be saved or not
 function sys.save(filename, table) end
 
+---The buffer can later deserialized by sys.deserialize.
+---This method has all the same limitations as sys.save.
+---@param table table lua table to serialize
+---@return string serialized data buffer
+function sys.serialize(table) end
+
 ---Sets the host that is used to check for network connectivity against.
 ---@param host string hostname to check against
 function sys.set_connectivity_host(host) end

DefoldDocs/api/tilemap.lua

@@ -2,6 +2,16 @@
 ---Functions and messages used to manipulate tile map components.
 ---@class tilemap
 tilemap = {}
+---flip tile horizontally
+tilemap.H_FLIP = nil
+---rotate tile 180 degrees clockwise
+tilemap.ROTATE_180 = nil
+---rotate tile 270 degrees clockwise
+tilemap.ROTATE_270 = nil
+---rotate tile 90 degrees clockwise
+tilemap.ROTATE_90 = nil
+---flip tile vertically
+tilemap.V_FLIP = nil
 ---Get the bounds for a tile map. This function returns multiple values:
 ---The lower left corner index x and y coordinates (1-indexed),
 ---the tile map width and the tile map height.
@@ -45,14 +55,16 @@ function tilemap.get_tile(url, layer, x, y) end
 ---The coordinates must be within the bounds of the tile map as it were created.
 ---That is, it is not possible to extend the size of a tile map by setting tiles outside the edges.
 ---To clear a tile, set the tile to number 0. Which tile map and layer to manipulate is identified by the URL and the layer name parameters.
+---Transform bitmask is arithmetic sum of one or both FLIP constants (tilemap.H_FLIP, tilemap.V_FLIP) and/or one of ROTATION constants
+---(tilemap.ROTATE_90, tilemap.ROTATE_180, tilemap.ROTATE_270).
+---Flip always applies before rotation (clockwise).
 ---@param url string|hash|url the tile map
 ---@param layer string|hash name of the layer for the tile
 ---@param x number x-coordinate of the tile
 ---@param y number y-coordinate of the tile
 ---@param tile number index of new tile to set. 0 resets the cell
----@param h_flipped boolean optional if the tile should be horizontally flipped
----@param v_flipped boolean optional i the tile should be vertically flipped
-function tilemap.set_tile(url, layer, x, y, tile, h_flipped, v_flipped) end
+---@param transform_bitmask number optional flip and/or rotation should be applied to the tile
+function tilemap.set_tile(url, layer, x, y, tile, transform_bitmask) end
 
 ---Sets the visibility of the tilemap layer
 ---@param url string|hash|url the tile map

DefoldDocs/api/timer.lua

@@ -25,6 +25,11 @@ function timer.cancel(handle) end
 ---@return hash handle identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created
 function timer.delay(delay, _repeat, callback) 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
+function timer.trigger(handle) end
+