@ts-defold/types 1.2.46 → 1.2.48

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.1 (fd1ad4c17bfdcd890ea7176f2672c35102384419)
+// DEFOLD. stable version 1.9.1 (3be87d89fd5a93a63f527351fbedb84f8a875812)
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
 
 
@@ -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
@@ -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
@@ -775,6 +775,7 @@ declare namespace go {
 	* and be a part of the simulation. A component is disabled when it receives the `disable` message.
 	* undefined Components that currently supports this message are:
 	* 
+	* - Camera
 	* - Collection Proxy
 	* - Collision Object
 	* - Gui
@@ -793,6 +794,7 @@ declare namespace go {
 	* and be a part of the simulation. A component is disabled when it receives the `disable` message.
 	* undefined Components that currently supports this message are:
 	* 
+	* - Camera
 	* - Collection Proxy
 	* - Collision Object
 	* - Gui
@@ -1759,6 +1761,11 @@ declare namespace gui {
 	*/
 	export let PROP_INNER_RADIUS: any
 
+	/**
+	* leading property
+	*/
+	export let PROP_LEADING: any
+
 	/**
 	* outline color property
 	*/
@@ -1794,6 +1801,11 @@ declare namespace gui {
 	*/
 	export let PROP_SLICE9: any
 
+	/**
+	* tracking property
+	*/
+	export let PROP_TRACKING: any
+
 	/**
 	* data error
 	*/
@@ -1848,6 +1860,8 @@ declare namespace gui {
 - `"size"`
 - `"fill_angle"` (pie)
 - `"inner_radius"` (pie)
+- `"leading"` (text)
+- `"tracking"` (text)
 - `"slice9"` (slice9)
 
 The following property constants are defined equaling the corresponding property string names.
@@ -1862,6 +1876,8 @@ The following property constants are defined equaling the corresponding property
 - `gui.PROP_SIZE`
 - `gui.PROP_FILL_ANGLE`
 - `gui.PROP_INNER_RADIUS`
+- `gui.PROP_LEADING`
+- `gui.PROP_TRACKING`
 - `gui.PROP_SLICE9`
 
 	* @param to  target property value
@@ -1899,6 +1915,8 @@ with a custom curve. See the animation guide for more information.
 - `"size"`
 - `"fill_angle"` (pie)
 - `"inner_radius"` (pie)
+- `"leading"` (text)
+- `"tracking"` (text)
 - `"slice9"` (slice9)
 
 	*/
@@ -1946,7 +1964,7 @@ with a custom curve. See the animation guide for more information.
 	* Instead of using specific getters such as gui.get_position or gui.get_scale,
 	* you can use gui.get instead and supply the property as a string or a hash.
 	* While this function is similar to go.get, there are a few more restrictions
-	* when operating in the gui namespace. Most notably, only these propertie identifiers are supported:
+	* when operating in the gui namespace. Most notably, only these explicitly named properties are supported:
 	* 
 	* - `"position"`
 	* - `"rotation"`
@@ -1958,14 +1976,19 @@ with a custom curve. See the animation guide for more information.
 	* - `"size"`
 	* - `"fill_angle"` (pie)
 	* - `"inner_radius"` (pie)
+	* - `"leading"` (text)
+	* - `"tracking"` (text)
 	* - `"slice9"` (slice9)
 	* 
 	* The value returned will either be a vmath.vector4 or a single number, i.e getting the "position"
 	* property will return a vec4 while getting the "position.x" property will return a single value.
+	* You can also use this function to get material constants.
 	* @param node  node to get the property for
 	* @param property  the property to retrieve
+	* @param options  optional options table (only applicable for material constants)
+index into array property (1 based)
 	*/
-	export function get(node: node, property: any): void
+	export function get(node: node, property: any, options?: any): void
 
 	/**
 	* Returns the adjust mode of a node.
@@ -1984,8 +2007,9 @@ with a custom curve. See the animation guide for more information.
 	/**
 	* gets the node alpha
 	* @param node  node from which to get alpha
+	* @return alpha  alpha
 	*/
-	export function get_alpha(node: node): void
+	export function get_alpha(node: node): number
 
 	/**
 	* Returns the blend mode of a node.
@@ -2005,7 +2029,7 @@ with a custom curve. See the animation guide for more information.
 	/**
 	* If node is set as an inverted clipping node, it will clip anything inside as opposed to outside.
 	* @param node  node from which to get the clipping inverted state
-	* @return inverted  true or false
+	* @return inverted  `true` or `false`
 	*/
 	export function get_clipping_inverted(node: node): boolean
 
@@ -2023,7 +2047,7 @@ with a custom curve. See the animation guide for more information.
 	/**
 	* If node is set as visible clipping node, it will be shown as well as clipping. Otherwise, it will only clip but not show visually.
 	* @param node  node from which to get the clipping visibility state
-	* @return visible  true or false
+	* @return visible  `true` or `false`
 	*/
 	export function get_clipping_visible(node: node): boolean
 
@@ -2136,8 +2160,9 @@ with a custom curve. See the animation guide for more information.
 	/**
 	* gets the node inherit alpha state
 	* @param node  node from which to get the inherit alpha state
+	* @return inherit_alpha  `true` or `false`
 	*/
-	export function get_inherit_alpha(node: node): void
+	export function get_inherit_alpha(node: node): boolean
 
 	/**
 	* Returns the inner radius of a pie node.
@@ -2179,8 +2204,9 @@ with a custom curve. See the animation guide for more information.
 	* Returns the material of a node.
 	* The material must be mapped to the gui scene in the gui editor.
 	* @param node  node to get the material for
+	* @return materal  material id
 	*/
-	export function get_material(node: node): void
+	export function get_material(node: node): hash
 
 	/**
 	* Retrieves the node with the specified id.
@@ -2558,7 +2584,7 @@ the new state of the emitter:
 	* Instead of using specific setteres such as gui.set_position or gui.set_scale,
 	* you can use gui.set instead and supply the property as a string or a hash.
 	* While this function is similar to go.get and go.set, there are a few more restrictions
-	* when operating in the gui namespace. Most notably, only these propertie identifiers are supported:
+	* when operating in the gui namespace. Most notably, only these named properties identifiers are supported:
 	* 
 	* - `"position"`
 	* - `"rotation"`
@@ -2570,6 +2596,8 @@ the new state of the emitter:
 	* - `"size"`
 	* - `"fill_angle"` (pie)
 	* - `"inner_radius"` (pie)
+	* - `"leading"` (text)
+	* - `"tracking"` (text)
 	* - `"slice9"` (slice9)
 	* 
 	* The value to set must either be a vmath.vector4, vmath.vector3, vmath.quat or a single number and depends on the property name you want to set.
@@ -2578,11 +2606,17 @@ the new state of the emitter:
 	* Note: When setting the rotation using the "rotation" property, you need to pass in a vmath.quat. This behaviour is different than from the gui.set_rotation function,
 	* the intention is to move new functionality closer to go namespace so that migrating between gui and go is easier. To set the rotation using degrees instead,
 	* use the "euler" property instead. The rotation and euler properties are linked, changing one of them will change the backing data of the other.
+	* Similar to go.set, you can also use gui.set for setting material constant values on a node. E.g if a material has specified a constant called `tint` in
+	* the .material file, you can use gui.set to set the value of that constant by calling `gui.set(node, "tint", vmath.vec4(1,0,0,1))`, or `gui.set(node, "matrix", vmath.matrix4())`
+	* if the constant is a matrix. Arrays are also supported by gui.set - to set an array constant, you need to pass in an options table with the 'index' key set.
+	* If the material has a constant array called 'tint_array' specified in the material, you can use `gui.set(node, "tint_array", vmath.vec4(1,0,0,1), { index = 4})` to set the fourth array element to a different value.
 	* @param node  node to set the property for
 	* @param property  the property to set
 	* @param value  the property to set
+	* @param options  optional options table (only applicable for material constants)
+index into array property (1 based)
 	*/
-	export function set(node: node, property: any, value: number | vmath.vector4 | vmath.vector3 | vmath.quaternion): void
+	export function set(node: node, property: any, value: number | vmath.vector4 | vmath.vector3 | vmath.quaternion, options?: any): void
 
 	/**
 	* Sets the adjust mode on a node.
@@ -2623,7 +2657,7 @@ the new state of the emitter:
 	/**
 	* If node is set as an inverted clipping node, it will clip anything inside as opposed to outside.
 	* @param node  node to set clipping inverted state for
-	* @param inverted  true or false
+	* @param inverted  `true` or `false`
 	*/
 	export function set_clipping_inverted(node: node, inverted: boolean): void
 
@@ -2641,7 +2675,7 @@ the new state of the emitter:
 	/**
 	* If node is set as an visible clipping node, it will be shown as well as clipping. Otherwise, it will only clip but not show visually.
 	* @param node  node to set clipping visibility for
-	* @param visible  true or false
+	* @param visible  `true` or `false`
 	*/
 	export function set_clipping_visible(node: node, visible: boolean): void
 
@@ -2739,7 +2773,7 @@ the new state of the emitter:
 	/**
 	* sets the node inherit alpha state
 	* @param node  node from which to set the inherit alpha state
-	* @param inherit_alpha  true or false
+	* @param inherit_alpha  `true` or `false`
 	*/
 	export function set_inherit_alpha(node: node, inherit_alpha: boolean): void
 
@@ -2770,7 +2804,7 @@ the new state of the emitter:
 	* Sets the line-break mode on a text node.
 	* This is only useful for text nodes.
 	* @param node  node to set line-break for
-	* @param line_break  true or false
+	* @param line_break  `true` or `false`
 	*/
 	export function set_line_break(node: node, line_break: boolean): void
 
@@ -4096,6 +4130,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
@@ -4455,6 +4506,14 @@ If true, the renderer will use the cameras view-projection matrix for frustum cu
 	*/
 	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.
@@ -4800,6 +4859,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:
 	* 
@@ -4984,6 +5058,7 @@ The texture type. Supported values:
 
 - `resource.TEXTURE_TYPE_2D`
 - `resource.TEXTURE_TYPE_CUBE_MAP`
+- `resource.TEXTURE_TYPE_IMAGE_2D`
 
 
 `width`
@@ -5028,6 +5103,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`
@@ -5100,6 +5185,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
@@ -5192,7 +5286,15 @@ The attachment buffer type. Supported values:
 - `resource.BUFFER_TYPE_COLOR2`
 - `resource.BUFFER_TYPE_COLOR3`
 - `resource.BUFFER_TYPE_DEPTH`
-- `resource.BUFFER_TYPE_STENCIL`
+
+`resource.BUFFER_TYPE_STENCIL`
+
+
+
+`texture`
+The hashed path to the attachment texture resource. This field is only available if the render target passed in is a resource.
+
+
 
 	*/
 	export function get_render_target_info(path: any): any
@@ -5237,11 +5339,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`
 
@@ -5274,6 +5379,18 @@ The texture type. Supported values:
 	*/
 	export function release(path: hash | string): void
 
+	/**
+	* Constructor-like function with two purposes:
+	* 
+	* - Load the specified resource as part of loading the script
+	* - Return a hash to the run-time version of the resource
+	* 
+	* ⚠ This function can only be called within go.property function calls.
+	* @param path  optional resource path string to the resource
+	* @return path  a path hash to the binary version of the resource
+	*/
+	export function render_target(path?: string): hash
+
 	/**
 	* Sets the resource data for a specific resource
 	* @param path  The path to the resource
@@ -5870,7 +5987,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`.
@@ -7014,6 +7131,97 @@ declare namespace camera {
 	*/
 	export let aspect_ratio: any
 
+	/**
+	* 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.
+	* @return cameras  a table with all camera URLs
+	*/
+	export function get_cameras(): any
+
+	/**
+	* get far z
+	* @param camera  camera id
+	* @return far_z  the far z.
+	*/
+	export function get_far_z(camera: any): number
+
+	/**
+	* get field of view
+	* @param camera  camera id
+	* @return fov  the field of view.
+	*/
+	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.
 	* The type of the property is float.
@@ -7160,13 +7368,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
 
@@ -8062,6 +8272,31 @@ declare namespace tilemap {
 	*/
 	export function get_tile(url: string | hash | url, layer: string | hash, x: number, y: number): number
 
+	/**
+	* Get the tile information at the specified position in the tilemap.
+	* The position is identified by the tile index starting at origin
+	* with index 1, 1. (see tilemap.set_tile())
+	* Which tile map and layer to query is identified by the URL and the
+	* layer name parameters.
+	* @param url  the tile map
+	* @param layer  name of the layer for the tile
+	* @param x  x-coordinate of the tile
+	* @param y  y-coordinate of the tile
+	* @return tile_info  index of the tile
+	*/
+	export function get_tile_info(url: string | hash | url, layer: string | hash, x: number, y: number): any
+
+	/**
+	* Retrieves all the tiles for the specified layer in the tilemap.
+	* It returns a table of rows where the keys are the
+	* tile positions (see tilemap.get_bounds()).
+	* You can iterate it using `tiles[row_index][column_index]`.
+	* @param url  the tilemap
+	* @param layer  the name of the layer for the tiles
+	* @return tiles  a table of rows representing the layer
+	*/
+	export function get_tiles(url: string | hash | url, layer: string | hash): any
+
 	/**
 	* Replace a tile in a tile map with a new tile.
 	* The coordinates of the tiles are indexed so that the "first" tile just

package/package.json

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