@ts-defold/types 1.2.45 → 1.2.47

package/index.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="lua-types/5.1" />
 /// <reference types="@typescript-to-lua/language-extensions" />
 
-// DEFOLD. stable version 1.8.0 (9141d9d3605e3f5d51c71293116d769da2613d39)
+// DEFOLD. stable version 1.9.0 (d6882f432beca85d460ec42497888157c356d058)
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
 
 
@@ -315,13 +315,6 @@ declare namespace b2d.body {
 	*/
 	export function get_angular_damping(body: any): number
 
-	/**
-	* Set the angular velocity.
-	* @param body  body
-	* @param omega  the new angular velocity in radians/second.
-	*/
-	export function get_angular_velocity(body: any, omega: number): void
-
 	/**
 	* Get the angular velocity.
 	* @param body  body
@@ -358,17 +351,17 @@ declare namespace b2d.body {
 	export function get_linear_velocity(body: any): vmath.vector3
 
 	/**
-	* Get the world linear velocity of a world point attached to this body.
+	* Get the world velocity of a local point.
 	* @param body  body
-	* @param world_point  a point in world coordinates.
+	* @param local_point  a point in local coordinates.
 	* @return velocity  the world velocity of a point.
 	*/
-	export function get_linear_velocity_from_world_point(body: any, world_point: vmath.vector3): vmath.vector3
+	export function get_linear_velocity_from_local_point(body: any, local_point: vmath.vector3): vmath.vector3
 
 	/**
-	* Get the world velocity of a local point.
+	* Get the world linear velocity of a world point attached to this body.
 	* @param body  body
-	* @param world_point  a point in local coordinates.
+	* @param world_point  a point in world coordinates.
 	* @return velocity  the world velocity of a point.
 	*/
 	export function get_linear_velocity_from_world_point(body: any, world_point: vmath.vector3): vmath.vector3
@@ -529,6 +522,13 @@ declare namespace b2d.body {
 	*/
 	export function set_angular_damping(body: any, damping: number): void
 
+	/**
+	* Set the angular velocity.
+	* @param body  body
+	* @param omega  the new angular velocity in radians/second.
+	*/
+	export function set_angular_velocity(body: any, omega: number): void
+
 	/**
 	* Set the sleep state of the body. A sleeping body has very low CPU cost.
 	* @param body  body
@@ -2398,7 +2398,7 @@ with a custom curve. See the animation guide for more information.
 	* @param recursive  check hierarchy recursively
 	* @return enabled  whether the node is enabled or not
 	*/
-	export function is_enabled(node: node, recursive: boolean): boolean
+	export function is_enabled(node: node, recursive?: boolean): boolean
 
 	/**
 	* Alters the ordering of the two supplied nodes by moving the first node
@@ -2805,10 +2805,10 @@ the new state of the emitter:
 	/**
 	* Sets the parent node of the specified node.
 	* @param node  node for which to set its parent
-	* @param parent  parent node to set
+	* @param parent  parent node to set, pass `nil` to remove parent
 	* @param keep_scene_transform  optional flag to make the scene position being perserved
 	*/
-	export function set_parent(node: node, parent: node, keep_scene_transform?: boolean): void
+	export function set_parent(node: node, parent?: node, keep_scene_transform?: boolean): void
 
 	/**
 	* Set the paricle fx for a gui node
@@ -2925,7 +2925,7 @@ the new state of the emitter:
 	* @param node  node to set text for
 	* @param text  text to set
 	*/
-	export function set_text(node: node, text: string): void
+	export function set_text(node: node, text: string | number): void
 
 	/**
 	* Set the texture on a box or pie node. The texture must be mapped to
@@ -3019,7 +3019,7 @@ the new state of the emitter:
 `clear`: instantly clear spawned particles
 
 	*/
-	export function stop_particlefx(node: node, options: any): void
+	export function stop_particlefx(node: node, options?: any): void
 
 
 	/**
@@ -3162,6 +3162,26 @@ declare namespace physics {
 	*/
 	export let JOINT_TYPE_WHEEL: any
 
+	/**
+	* 
+	*/
+	export let SHAPE_TYPE_BOX: any
+
+	/**
+	* 
+	*/
+	export let SHAPE_TYPE_CAPSULE: any
+
+	/**
+	* 
+	*/
+	export let SHAPE_TYPE_HULL: any
+
+	/**
+	* 
+	*/
+	export let SHAPE_TYPE_SPHERE: any
+
 	/**
 	* Create a physics joint between two collision object components.
 	* Note: Currently only supported in 2D physics.
@@ -3312,7 +3332,7 @@ Set to `true` to return all ray cast hits. If `false`, it will only return the c
 
 	* @return result  It returns a list. If missed it returns `nil`. See ray_cast_response for details on the returned values.
 	*/
-	export function raycast(from: vmath.vector3, to: vmath.vector3, groups: any, options: any): LuaMultiReturn<[any, any]>
+	export function raycast(from: vmath.vector3, to: vmath.vector3, groups: any, options?: any): LuaMultiReturn<[any, any]>
 
 	/**
 	* Ray casts are used to test for intersections against collision objects in the physics world.
@@ -3418,17 +3438,20 @@ See physics.get_shape for a detailed description of each field in the data table
 `local function set_shape_data()
     -- set capsule shape data
     local data = {}
+    data.type = physics.SHAPE_TYPE_CAPSULE
     data.diameter = 10
     data.height = 20
     physics.set_shape(&quot;#collisionobject&quot;, &quot;my_capsule_shape&quot;, data)
 
     -- set sphere shape data
     data = {}
+    data.type = physics.SHAPE_TYPE_SPHERE
     data.diameter = 10
     physics.set_shape(&quot;#collisionobject&quot;, &quot;my_sphere_shape&quot;, data)
 
     -- set box shape data
     data = {}
+    data.type = physics.SHAPE_TYPE_BOX
     data.dimensions = vmath.vector3(10, 10, 5)
     physics.set_shape(&quot;#collisionobject&quot;, &quot;my_box_shape&quot;, data)
 end
@@ -4073,6 +4096,23 @@ declare namespace render {
 	*/
 	export function disable_texture(binding: number | string | hash): void
 
+	/**
+	* Dispatches the currently enabled compute program. The dispatch call takes three arguments x,y,z which constitutes
+	* the 'global working group' of the compute dispatch. Together with the 'local working group' specified in the compute shader
+	* as a layout qualifier, these two sets of parameters forms the number of invocations the compute shader will execute.
+	* An optional constant buffer can be provided to override the default constants. If no constants buffer is provided, a default
+	* system constants buffer is used containing constants as defined in the compute program.
+	* @param x  global work group size X
+	* @param y  global work group size Y
+	* @param z  global work group size Z
+	* @param options  optional table with properties:
+
+`constants`
+optional constants to use while rendering
+
+	*/
+	export function dispatch_compute(x: number, y: number, z: number, options?: any): void
+
 	/**
 	* Draws all objects that match a specified predicate. An optional constant buffer can be
 	* provided to override the default constants. If no constants buffer is provided, a default
@@ -4405,6 +4445,23 @@ to enable those textures as well. Currently 4 color attachments are supported:
 	*/
 	export function set_blend_func(source_factor: any, destination_factor: any): void
 
+	/**
+	* Sets the current render camera to be used for rendering. If a render camera
+	* has been set by the render script, the renderer will be using its projection and view matrix
+	* during rendering. If a projection and/or view matrix has been set by the render script,
+	* they will not be used until the current render camera has been reset by calling `render.set_camera()`.
+	* If the 'use_frustum' flag in the options table has been set to true, the renderer will automatically use the
+	* camera frustum for frustum culling regardless of what frustum is being passed into the render.draw() function.
+	* Note that the frustum plane option in render.draw can still be used together with the camera.
+	* @param camera  camera id to use, or nil to reset
+	* @param options  optional table with properties:
+
+`use_frustum`
+If true, the renderer will use the cameras view-projection matrix for frustum culling (default: false)
+
+	*/
+	export function set_camera(camera: any, options?: any): void
+
 	/**
 	* Specifies whether the individual color components in the frame buffer is enabled for writing (`true`) or disabled (`false`). For example, if `blue` is `false`, nothing is written to the blue component of any pixel in any of the color buffers, regardless of the drawing operation attempted. Note that writing are either enabled or disabled for entire color components, not the individual bits of a component.
 	* The component masks are all initially `true`.
@@ -4415,6 +4472,14 @@ to enable those textures as well. Currently 4 color attachments are supported:
 	*/
 	export function set_color_mask(red: boolean, green: boolean, blue: boolean, alpha: boolean): void
 
+	/**
+	* The name of the compute program must be specified in the ".render" resource set
+	* in the "game.project" setting. If nil (or no arguments) are passed to this function,
+	* the current compute program will instead be disabled.
+	* @param compute  compute id to use, or nil to disable
+	*/
+	export function set_compute(compute: any): void
+
 	/**
 	* Specifies whether front- or back-facing polygons can be culled
 	* when polygon culling is enabled. Polygon culling is initially disabled.
@@ -4760,6 +4825,21 @@ declare namespace resource {
 	*/
 	export let TEXTURE_TYPE_CUBE_MAP: any
 
+	/**
+	* Usage hint for creating textures that uses temporary memory
+	*/
+	export let TEXTURE_USAGE_FLAG_MEMORYLESS: any
+
+	/**
+	* Usage hint for creating textures that can be sampled in a shader
+	*/
+	export let TEXTURE_USAGE_FLAG_SAMPLE: any
+
+	/**
+	* Usage hint for creating textures that can be used for writing in a shader
+	*/
+	export let TEXTURE_USAGE_FLAG_STORAGE: any
+
 	/**
 	* Constructor-like function with two purposes:
 	* 
@@ -4926,7 +5006,7 @@ optional flag to determine wether or not the resource should take over ownership
 
 	* @return path  Returns the buffer resource path
 	*/
-	export function create_buffer(path: string, table: any): hash
+	export function create_buffer(path: string, table?: any): hash
 
 	/**
 	* Creates a new texture resource that can be used in the same way as any texture created during build time.
@@ -4944,6 +5024,7 @@ The texture type. Supported values:
 
 - `resource.TEXTURE_TYPE_2D`
 - `resource.TEXTURE_TYPE_CUBE_MAP`
+- `resource.TEXTURE_TYPE_IMAGE_2D`
 
 
 `width`
@@ -4988,6 +5069,16 @@ end
 `
 
 
+`flags`
+Texture creation flags that can be used to dictate how the texture is created. The default value is resource.TEXTURE_USAGE_FLAG_SAMPLE, which means that the texture can be sampled from a shader.
+These flags may or may not be supported on the running device and/or the underlying graphics API and is simply used internally as a 'hint' when creating the texture. There is no guarantee that any of these will have any effect. Supported values:
+
+
+- `resource.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
+- `resource.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
+- `resource.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
+
+
 `max_mipmaps`
 optional max number of mipmaps. Defaults to zero, i.e no mipmap support
 `compression_type`
@@ -5060,6 +5151,15 @@ These constants might not be available on the device:
 - `resource.TEXTURE_FORMAT_R32F`
 - `resource.TEXTURE_FORMAT_RG32F`
 
+
+`flags`
+Texture creation flags that can be used to dictate how the texture is created. Supported values:
+
+
+- `resource.TEXTURE_USAGE_FLAG_SAMPLE` - The texture can be sampled from a shader (default)
+- `resource.TEXTURE_USAGE_FLAG_MEMORYLESS` - The texture can be used as a memoryless texture, i.e only transient memory for the texture is used during rendering
+- `resource.TEXTURE_USAGE_FLAG_STORAGE` - The texture can be used as a storage texture, which is required for a shader to write to the texture
+
 You can test if the device supports these values by checking if a specific enum is nil or not:
 `if resource.TEXTURE_FORMAT_RGBA16F ~= nil then
     -- it is safe to use this format
@@ -5197,11 +5297,14 @@ height of the texture
 depth of the texture (i.e 1 for a 2D texture and 6 for a cube map)
 `mipmaps`
 number of mipmaps of the texture
+`flags`
+usage hints of the texture.
 `type`
 The texture type. Supported values:
 
 
 - `resource.TEXTURE_TYPE_2D`
+- `resource.TEXTURE_TYPE_IMAGE_2D`
 - `resource.TEXTURE_TYPE_CUBE_MAP`
 - `resource.TEXTURE_TYPE_2D_ARRAY`
 
@@ -5370,7 +5473,7 @@ optional flag to determine wether or not the resource should take over ownership
 
 
 	*/
-	export function set_buffer(path: hash | string, buffer: buffer, table: any): void
+	export function set_buffer(path: hash | string, buffer: buffer, table?: any): void
 
 	/**
 	* Update internal sound resource (wavc/oggc) with new data
@@ -5830,7 +5933,7 @@ If the request was successfull, this will contain the request payload in a buffe
 	* @param arg5  argument 5
 	* @param arg6  argument 6
 	*/
-	export function reboot(arg1: string, arg2: string, arg3: string, arg4: string, arg5: string, arg6: string): void
+	export function reboot(arg1?: string, arg2?: string, arg3?: string, arg4?: string, arg5?: string, arg6?: string): void
 
 	/**
 	* The table can later be loaded by `sys.load`.
@@ -6229,7 +6332,7 @@ The response data. Contains the fields:
 	* @param options  optional table with request parameters. Supported entries:
 
 `timeout`: timeout in seconds
-Not available in HTML5 build
+Path should be absolute
 Not available in HTML5 build
 Not available in HTML5 build
 
@@ -6330,7 +6433,7 @@ declare namespace json {
 
 	* @return data  decoded json
 	*/
-	export function decode(json: string, options: any): any
+	export function decode(json: string, options?: any): any
 
 	/**
 	* Encode a lua table to a JSON string.
@@ -6342,7 +6445,7 @@ declare namespace json {
 
 	* @return json  encoded json
 	*/
-	export function encode(tbl: any, options: any): string
+	export function encode(tbl: any, options?: any): string
 
 	/**
 	* null
@@ -6967,14 +7070,6 @@ declare namespace zlib {
 
 declare namespace camera {
 
-	/**
-	* Post this message to a camera-component to activate it.
-	* Several cameras can be active at the same time, but only the camera that was last activated will be used for rendering.
-	* When the camera is deactivated (see `release_camera_focus`), the previously activated camera will again be used for rendering automatically.
-	* The reason it is called "camera focus" is the similarity to how acquiring input focus works (see `acquire_input_focus`).
-	*/
-	export type acquire_camera_focus = "acquire_camera_focus"
-
 	/**
 	* The ratio between the frustum width and height. Used when calculating the
 	* projection of a perspective camera.
@@ -6983,16 +7078,96 @@ declare namespace camera {
 	export let aspect_ratio: any
 
 	/**
-	* makes camera active
-	* @param url  url of camera component
+	* get aspect ratio
+	* @param camera  camera id
+	* @return aspect_ratio  the aspect ratio.
+	*/
+	export function get_aspect_ratio(camera: any): number
+
+	/**
+	* This function returns a table with all the camera URLs that have been
+	* registered in the render context.
+	* @param camera  camera id
+	* @return cameras  a table with all camera URLs
+	*/
+	export function get_cameras(camera: any): any
+
+	/**
+	* get far z
+	* @param camera  camera id
+	* @return far_z  the far z.
 	*/
-	export function acquire_focus(url: string | hash | url): void
+	export function get_far_z(camera: any): number
 
 	/**
-	* deactivate camera
-	* @param url  url of camera component
+	* get field of view
+	* @param camera  camera id
+	* @return fov  the field of view.
 	*/
-	export function release_focus(url: string | hash | url): void
+	export function get_fov(camera: any): number
+
+	/**
+	* get near z
+	* @param camera  camera id
+	* @return near_z  the near z.
+	*/
+	export function get_near_z(camera: any): number
+
+	/**
+	* get orthographic zoom
+	* @param camera  camera id
+	* @return orthographic_zoom  true if the camera is using an orthographic projection.
+	*/
+	export function get_orthographic_zoom(camera: any): boolean
+
+	/**
+	* get projection matrix
+	* @param camera  camera id
+	* @return projection  the projection matrix.
+	*/
+	export function get_projection(camera: any): vmath.matrix4
+
+	/**
+	* get view matrix
+	* @param camera  camera id
+	* @return view  the view matrix.
+	*/
+	export function get_view(camera: any): vmath.matrix4
+
+	/**
+	* set aspect ratio
+	* @param camera  camera id
+	* @param aspect_ratio  the aspect ratio.
+	*/
+	export function set_aspect_ratio(camera: any, aspect_ratio: number): void
+
+	/**
+	* set far z
+	* @param camera  camera id
+	* @param far_z  the far z.
+	*/
+	export function set_far_z(camera: any, far_z: number): void
+
+	/**
+	* set field of view
+	* @param camera  camera id
+	* @param fov  the field of view.
+	*/
+	export function set_fov(camera: any, fov: number): void
+
+	/**
+	* set near z
+	* @param camera  camera id
+	* @param near_z  the near z.
+	*/
+	export function set_near_z(camera: any, near_z: number): void
+
+	/**
+	* set orthographic zoom
+	* @param camera  camera id
+	* @param orthographic_zoom  true if the camera is using an orthographic projection.
+	*/
+	export function set_orthographic_zoom(camera: any, orthographic_zoom: boolean): void
 
 	/**
 	* Camera frustum far plane.
@@ -7024,14 +7199,6 @@ declare namespace camera {
 	*/
 	export let projection: any
 
-	/**
-	* 
-	* Post this message to a camera-component to deactivate it. The camera is then removed from the active cameras.
-	* See `acquire_camera_focus` for more information how the active cameras are used in rendering.
-	* 
-	*/
-	export type release_camera_focus = "release_camera_focus"
-
 	/**
 	* 
 	* Post this message to a camera-component to set its properties at run-time.
@@ -7148,13 +7315,15 @@ declare namespace collectionproxy {
 	export type async_load = "async_load"
 
 	/**
-	* return an indexed table of resources for a collection proxy. Each
-	* entry is a hexadecimal string that represents the data of the specific
-	* resource. This representation corresponds with the filename for each
-	* individual resource that is exported when you bundle an application with
-	* LiveUpdate functionality.
+	* return an indexed table of resources for a collection proxy where the
+	* referenced collection has been excluded using LiveUpdate. Each entry is a
+	* hexadecimal string that represents the data of the specific resource.
+	* This representation corresponds with the filename for each individual
+	* resource that is exported when you bundle an application with LiveUpdate
+	* functionality.
 	* @param collectionproxy  the collectionproxy to check for resources.
-	* @return resources  the resources
+	* @return resources  the resources, or an empty list if the
+collection was not excluded.
 	*/
 	export function get_resources(collectionproxy: url): any
 
@@ -7613,7 +7782,7 @@ the new state of the emitter:
 `clear`: instantly clear spawned particles
 
 	*/
-	export function stop(url: string | hash | url, options: any): void
+	export function stop(url: string | hash | url, options?: any): void
 
 }
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-defold/types",
-  "version": "1.2.45",
+  "version": "1.2.47",
   "description": "TypeScript definitions for Defold",
   "repository": "github:ts-defold/types",
   "keywords": [