update to 1.2.180

Author: d954mas

DefoldDocs/api/base.lua

@@ -9,11 +9,40 @@
 ---@field z number
 ---@field w number
 
+---@class quaternion
+---@field x number
+---@field y number
+---@field z number
+---@field w number
+
+---@alias quat quaternion
+
 ---@class url
 ---@field socket
 ---@field path
 ---@field fragment
 
+---@alias hash userdata
+---@alias constant userdata
+---@alias bool boolean
+---@alias float number
+---@alias object userdata
+---@alias matrix4 userdata
+---@alias node userdata
+
+--mb use number instead of vector4
+---@alias vector vector4
+
+--luasocket
+---@alias master userdata
+---@alias unconnected userdata
+---@alias client userdata
+
+--render
+---@alias constant_buffer userdata
+---@alias render_target userdata
+---@alias predicate userdata
+
 --- Calls error if the value of its argument `v` is false (i.e., **nil** or
 --- **false**); otherwise, returns all its arguments. In case of error,
 --- `message` is the error object; when absent, it defaults to "assertion

DefoldDocs/api/bitop.lua

@@ -1,12 +1,9 @@
 ---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 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.
----
 ---For clarity the examples assume the definition of a helper function printx().
 ---This prints its argument as an unsigned 32 bit hexadecimal number on all platforms:
 ---function printx(x)
@@ -22,59 +19,70 @@ bit = {}
 ---@param n number number of bits
 ---@return number bitwise arithmetic right-shifted number
 function bit.arshift(x, n) end
+
 ---Returns the bitwise and of all of its arguments. Note that more than two arguments are allowed.
 ---@param x1 number number
----@param ... number number(s)
+--- ... number number(s)
 ---@return number bitwise and of the provided arguments
 function bit.band(x1, ...) end
+
 ---Returns the bitwise not of its argument.
 ---@param x number number
 ---@return number bitwise not of number x
 function bit.bnot(x) end
+
 ---Returns the bitwise or of all of its arguments. Note that more than two arguments are allowed.
 ---@param x1 number number
----@param ... number number(s)
+--- ... number number(s)
 ---@return number bitwise or of the provided arguments
 function bit.bor(x1, ...) end
+
 ---Swaps the bytes of its argument and returns it. This can be used to convert little-endian 32 bit numbers to big-endian 32 bit numbers or vice versa.
 ---@param x number number
 ---@return number bitwise swapped number
 function bit.bswap(x) end
+
 ---Returns the bitwise xor of all of its arguments. Note that more than two arguments are allowed.
 ---@param x1 number number
----@param ... number number(s)
+--- ... number number(s)
 ---@return number bitwise xor of the provided arguments
 function bit.bxor(x1, ...) end
+
 ---Returns the bitwise logical left-shift of its first argument by the number of bits given by the second argument.
 ---Logical shifts treat the first argument as an unsigned number and shift in 0-bits.
 ---Only the lower 5 bits of the shift count are used (reduces to the range [0..31]).
 ---@param x number number
 ---@param n number number of bits
 ---@return number bitwise logical left-shifted number
 function bit.lshift(x, n) end
+
 ---Returns the bitwise left rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back in on the other side.
 ---Only the lower 5 bits of the rotate count are used (reduces to the range [0..31]).
 ---@param x number number
 ---@param n number number of bits
 ---@return number bitwise left-rotated number
 function bit.rol(x, n) end
+
 ---Returns the bitwise right rotation of its first argument by the number of bits given by the second argument. Bits shifted out on one side are shifted back in on the other side.
 ---Only the lower 5 bits of the rotate count are used (reduces to the range [0..31]).
 ---@param x number number
 ---@param n number number of bits
 ---@return number bitwise right-rotated number
 function bit.ror(x, n) end
+
 ---Returns the bitwise logical right-shift of its first argument by the number of bits given by the second argument.
 ---Logical shifts treat the first argument as an unsigned number and shift in 0-bits.
 ---Only the lower 5 bits of the shift count are used (reduces to the range [0..31]).
 ---@param x number number
 ---@param n number number of bits
 ---@return number bitwise logical right-shifted number
 function bit.rshift(x, n) end
+
 ---Normalizes a number to the numeric range for bit operations and returns it. This function is usually not needed since all bit operations already normalize all of their input arguments.
 ---@param x number number to normalize
 ---@return number normalized number
 function bit.tobit(x) end
+
 ---Converts its first argument to a hex string. The number of hex digits is given by the absolute value of the optional second argument. Positive numbers between 1 and 8 generate lowercase hex digits. Negative numbers generate uppercase hex digits. Only the least-significant 4*|n| bits are used. The default is to generate 8 lowercase hex digits.
 ---@param x number number to convert
 ---@param n number number of hex digits to return
@@ -83,4 +91,5 @@ function bit.tohex(x, n) end
 
 
 
+
 return bit

DefoldDocs/api/built-ins.lua

@@ -7,11 +7,13 @@ builtins = {}
 ---@param s string string to hash
 ---@return hash a hashed string
 function hash(s) end
+
 ---Returns a hexadecimal representation of a hash value.
 ---The returned string is always padded with leading zeros.
 ---@param h hash hash value to get hex string for
 ---@return string hex representation of the hash
 function hash_to_hex(h) end
+
 ---Pretty printing of Lua values. This function prints Lua values
 ---in a manner similar to +print()+, but will also recurse into tables
 ---and pretty print them. There is a limit to how deep the function
@@ -21,4 +23,5 @@ function pprint(v) end
 
 
 
+
 return builtins

DefoldDocs/api/collection_factory.lua

@@ -10,49 +10,45 @@ collectionfactory.STATUS_LOADING = nil
 ---unloaded
 collectionfactory.STATUS_UNLOADED = nil
 ---The URL identifies the collectionfactory component that should do the spawning.
----
 ---Spawning is instant, but spawned game objects get their first update calls the following frame. The supplied parameters for position, rotation and scale
 ---will be applied to the whole collection when spawned.
----
 ---Script properties in the created game objects can be overridden through
 ---a properties-parameter table. The table should contain game object ids
 ---(hash) as keys and property tables as values to be used when initiating each
 ---spawned game object.
----
 ---See go.property for more information on script properties.
----
 ---The function returns a table that contains a key for each game object
 ---id (hash), as addressed if the collection file was top level, and the
 ---corresponding spawned instance id (hash) as value with a unique path
 ---prefix added to each instance.
----
 --- Calling collectionfactory.create <> create on a collection factory that is marked as dynamic without having loaded resources
 ---using collectionfactory.load <> will synchronously load and create resources which may affect application performance.
----@param url string | hash | url the collection factory component to be used
+---@param url string|hash|url the collection factory component to be used
 ---@param position vector3 position to assign to the newly spawned collection
 ---@param rotation quaternion rotation to assign to the newly spawned collection
 ---@param properties table table of script properties to propagate to any new game object instances
 ---@param scale number uniform scaling to apply to the newly spawned collection (must be greater than 0).
 ---@return table a table mapping the id:s from the collection to the new instance id:s
 function collectionfactory.create(url, position, rotation, properties, scale) end
+
 ---This returns status of the collection factory.
----
 ---Calling this function when the factory is not marked as dynamic loading always returns COMP_COLLECTION_FACTORY_STATUS_LOADED.
----@param url string | hash | url the collection factory component to get status from
+---@param url string|hash|url the collection factory component to get status from
 ---@return constant status of the collection factory component
 function collectionfactory.get_status(url) end
+
 ---Resources loaded are referenced by the collection factory component until the existing (parent) collection is destroyed or collectionfactory.unload is called.
----
 ---Calling this function when the factory is not marked as dynamic loading does nothing.
----@param url string | hash | url the collection factory component to load
+---@param url string|hash|url the collection factory component to load
 ---@param complete_function function(self, url, result)) function to call when resources are loaded.
 function collectionfactory.load(url, complete_function) 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
+---@param url string|hash|url the collection factory component to unload
 function collectionfactory.unload(url) end
 
 
 
+
 return collectionfactory

DefoldDocs/api/collection_proxy.lua

@@ -16,4 +16,5 @@ function collectionproxy.missing_resources(collectionproxy) end
 
 
 
+
 return collectionproxy

DefoldDocs/api/collision_object.lua

@@ -13,53 +13,53 @@ physics.JOINT_TYPE_SLIDER = nil
 ---spring joint type
 physics.JOINT_TYPE_SPRING = nil
 ---Create a physics joint between two collision object components.
----
 ---Note: Currently only supported in 2D physics.
 ---@param joint_type number the joint type
----@param collisionobject_a string | hash | url first collision object
----@param joint_id string | hash id of the joint
+---@param collisionobject_a string|hash|url first collision object
+---@param joint_id string|hash id of the joint
 ---@param position_a vector3 local position where to attach the joint on the first collision object
----@param collisionobject_b string | hash | url second collision object
+---@param collisionobject_b string|hash|url second collision object
 ---@param position_b vector3 local position where to attach the joint on the second collision object
----@param properties table optional joint specific properties table
+---@param properties table optional joint specific properties table See each joint type for possible properties field. The one field that is accepted for all joint types is: - boolean collide_connected: Set this flag to true if the attached bodies should collide.
 function physics.create_joint(joint_type, collisionobject_a, joint_id, position_a, collisionobject_b, position_b, properties) end
+
 ---Destroy an already physics joint. The joint has to be created before a
 ---destroy can be issued.
----
 ---Note: Currently only supported in 2D physics.
----@param collisionobject string | hash | url collision object where the joint exist
----@param joint_id string | hash id of the joint
+---@param collisionobject string|hash|url collision object where the joint exist
+---@param joint_id string|hash id of the joint
 function physics.destroy_joint(collisionobject, joint_id) end
+
 ---Get the gravity in runtime. The gravity returned is not global, it will return
 ---the gravity for the collection that the function is called from.
----
 ---Note: For 2D physics the z component will always be zero.
----@return [type:vector3] gravity vector of collection
+---@return vector3 gravity vector of collection
 function physics.get_gravity() 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.
----@param collisionobject string | hash | url collision object where the joint exist
----@param joint_id string | hash id of the joint
----@return boolean 
+---@param collisionobject string|hash|url collision object where the joint exist
+---@param joint_id string|hash id of the joint
+---@return table properties table. See the joint types for what fields are available, the only field available for all types is:
 function physics.get_joint_properties(collisionobject, joint_id) end
+
 ---Get the reaction force for a joint. The joint has to be created before
 ---the reaction force can be calculated.
----
 ---Note: Currently only supported in 2D physics.
----@param collisionobject string | hash | url collision object where the joint exist
----@param joint_id string | hash id of the joint
+---@param collisionobject string|hash|url collision object where the joint exist
+---@param joint_id string|hash id of the joint
 ---@return vector3 reaction force for the joint
 function physics.get_joint_reaction_force(collisionobject, joint_id) end
+
 ---Get the reaction torque for a joint. The joint has to be created before
 ---the reaction torque can be calculated.
----
 ---Note: Currently only supported in 2D physics.
----@param collisionobject string | hash | url collision object where the joint exist
----@param joint_id string | hash id of the joint
+---@param collisionobject string|hash|url collision object where the joint exist
+---@param joint_id string|hash id of the joint
 ---@return float the reaction torque on bodyB in N*m.
 function physics.get_joint_reaction_torque(collisionobject, joint_id) 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.
@@ -68,8 +68,10 @@ function physics.get_joint_reaction_torque(collisionobject, joint_id) end
 ---@param from vector3 the world position of the start of the ray
 ---@param to vector3 the world position of the end of the ray
 ---@param groups table a lua table containing the hashed groups for which to test collisions against
----@return table It returns a table. If missed it returns nil. See 
-function physics.raycast(from, to, groups) end
+---@param options table a lua table containing options for the raycast.
+---@return table It returns a list. If missed it returns nil. See ray_cast_response for details on the returned values.
+function physics.raycast(from, to, groups, options) 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.
@@ -81,35 +83,37 @@ function physics.raycast(from, to, groups) end
 --- * If an object is hit, the result will be reported via a ray_cast_response message.
 ---
 --- * If there is no object hit, the result will be reported via a ray_cast_missed message.
-
 ---@param from vector3 the world position of the start of the ray
 ---@param to vector3 the world position of the end of the ray
 ---@param groups table a lua table containing the hashed groups for which to test collisions against
----@param request_id number a number between [0,-255]. It will be sent back in the response for identification, 0 by default
+---@param request_id number] a number between [0,-255 . It will be sent back in the response for identification, 0 by default
 function physics.raycast_async(from, to, groups, request_id) end
+
 ---Set the gravity in runtime. The gravity change is not global, it will only affect
 ---the collection that the function is called from.
----
 ---Note: For 2D physics the z component of the gravity vector will be ignored.
 ---@param gravity vector3 the new gravity vector
 function physics.set_gravity(gravity) 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 
+---@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
 function physics.set_hflip(url, flip) end
+
 ---Updates the properties for an already connected joint. The joint has to be created before
 ---properties can be changed.
----
 ---Note: Currently only supported in 2D physics.
----@param collisionobject string | hash | url collision object where the joint exist
----@param joint_id string | hash id of the joint
----@param properties table joint specific properties table
+---@param collisionobject string|hash|url collision object where the joint exist
+---@param joint_id string|hash id of the joint
+---@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
+
 ---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 
+---@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
 function physics.set_vflip(url, flip) end
 
 
 
+
 return physics