@ts-defold/types 1.2.4 → 1.2.8

package/README.md

@@ -1,6 +1,6 @@
 # Defold Types
-<a href="https://discord.gg/eukcq5m"><img alt="Chat with us!" src="https://img.shields.io/discord/766898804896038942.svg?colorB=7581dc&logo=discord&logoColor=white"></a>
 <a href="https://www.npmjs.com/package/@ts-defold/type-gen"><img alt="npm install" src="https://img.shields.io/npm/dt/@ts-defold/types?color=%23CA0000&label=npm&logo=npm"></a>
+<a href="https://discord.gg/eukcq5m"><img alt="Chat with us!" src="https://img.shields.io/discord/766898804896038942.svg?colorB=7581dc&logo=discord&logoColor=white"></a>
 > TypeScript definitions for [Defold](https://defold.com/)
 
 ## Installation

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.2.188 (6bfeea3b13d7b8920483ea2cba9c181a8650b84d)
+// DEFOLD. stable version 1.2.190 (d31d6397a72178541a5ef6e7ef2bed090d828f58)
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
 
 
@@ -742,9 +742,12 @@ The id of the animated property.
 	* gets a named property of the specified game object or component
 	* @param url  url of the game object or component having the property
 	* @param property  id of the property to retrieve
+	* @param options  (optional) options table
+index into array property (1 based)
+name of internal property
 	* @return value  the value of the specified property
 	*/
-	export function get(url: string | hash | url, property: string | hash): any
+	export function get(url: string | hash | url, property: string | hash, options?: any): any
 
 	/**
 	* Returns or constructs an instance identifier. The instance id is a hash
@@ -848,8 +851,11 @@ The id of the animated property.
 	* @param url  url of the game object or component having the property
 	* @param property  id of the property to set
 	* @param value  the value to set
+	* @param options  (optional) options table
+index into array property (1 based)
+name of internal property
 	*/
-	export function set(url: string | hash | url, property: string | hash, value: any): void
+	export function set(url: string | hash | url, property: string | hash, value: any, options?: any): void
 
 	/**
 	* Sets the parent for a game object instance. This means that the instance will exist in the geometrical space of its parent,
@@ -930,6 +936,12 @@ The id of the animated property.
 declare namespace gui {
 
 
+	/**
+	* The fonts used in the gui. The type of the property is hash.
+	* Key must be specified in options table.
+	*/
+	export let fonts: any
+
 	/**
 	* fit adjust mode
 	*/
@@ -1523,6 +1535,12 @@ with a custom curve. See the animation guide for more information.
 	*/
 	export function get_adjust_mode(node: node): any
 
+	/**
+	* gets the node alpha
+	* @param node  node from which to get alpha
+	*/
+	export function get_alpha(node: node): void
+
 	/**
 	* Returns the blend mode of a node.
 	* Blend mode defines how the node will be blended with the background.
@@ -1631,6 +1649,13 @@ with a custom curve. See the animation guide for more information.
 	*/
 	export function get_font(node: node): hash
 
+	/**
+	* This is only useful for text nodes. The font must be mapped to the gui scene in the gui editor.
+	* @param font_name  font of which to get the path hash
+	* @return hash  path hash to resource
+	*/
+	export function get_font_resource(font_name: hash | string): hash
+
 	/**
 	* Returns the scene height.
 	* @return height  scene height
@@ -1884,37 +1909,6 @@ with a custom curve. See the animation guide for more information.
 	*/
 	export function get_text(node: node): string
 
-	/**
-	* Get text metrics given the provided font, text and parameters.
-	* @param font  font id
-	* @param text  text to measure
-	* @param width  max-width. Use for line-breaks (default=FLT_MAX)
-	* @param line_break  true to break lines accordingly to width (default=false)
-	* @param leading  scale value for line spacing (default=1)
-	* @param tracking  scale value for letter spacing (default=0)
-	* @return metrics  a table with the following fields:
-
-- width
-- height
-- max_ascent
-- max_descent
-
-	*/
-	export function get_text_metrics(font: string | hash, text: string, width: number, line_break: boolean, leading: number, tracking: number): any
-
-	/**
-	* Get the text metrics from a text node.
-	* @param node  text node to measure text from
-	* @return metrics  a table with the following fields:
-
-- width
-- height
-- max_ascent
-- max_descent
-
-	*/
-	export function get_text_metrics_from_node(node: node): any
-
 	/**
 	* Returns the texture of a node.
 	* This is currently only useful for box or pie nodes.
@@ -2163,6 +2157,13 @@ The rate with which the animation will be played. Must be positive
 	*/
 	export function set_adjust_mode(node: node, adjust_mode: any): void
 
+	/**
+	* sets the node alpha
+	* @param node  node for which to set alpha
+	* @param alpha  0..1 alpha color
+	*/
+	export function set_alpha(node: node, alpha: number): void
+
 	/**
 	* Set the blend mode of a node.
 	* Blend mode defines how the node will be blended with the background.
@@ -2348,7 +2349,7 @@ The rate with which the animation will be played. Must be positive
 	* @param parent  parent node to set
 	* @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
@@ -2587,6 +2588,12 @@ The rate with which the animation will be played. Must be positive
 
 
 
+	/**
+	* The textures used in the gui. The type of the property is hash.
+	* Key must be specified in options table.
+	*/
+	export let textures: any
+
 
 }
 // =^..^=   =^..^=   =^..^=    =^..^=    =^..^=    =^..^=    =^..^= //
@@ -3946,6 +3953,30 @@ declare namespace resource {
 	*/
 	export function get_current_manifest(): number
 
+	/**
+	* Gets the text metrics from a font
+	* @param url  the font to get the (unscaled) metrics from
+	* @param options  A table containing parameters for the text. Supported entries:
+
+`width`
+The width of the text field. Not used if `line_break` is false.
+`leading`
+The leading (default 1.0)
+`tracking`
+The leading (default 0.0)
+`line_break`
+If the calculation should consider line breaks (default false)
+
+	* @return metrics  a table with the following fields:
+
+- width
+- height
+- max_ascent
+- max_descent
+
+	*/
+	export function get_text_metrics(url: hash, options: any): any
+
 	/**
 	* 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.
@@ -5674,19 +5705,6 @@ declare namespace label {
 	*/
 	export function get_text(url: string | hash | url): string
 
-	/**
-	* Gets the text metrics from a label component
-	* @param url  the label to get the (unscaled) metrics from
-	* @return metrics  a table with the following fields:
-
-- width
-- height
-- max_ascent
-- max_descent
-
-	*/
-	export function get_text_metrics(url: string | hash | url): any
-
 	/**
 	* Sets the text of a label component
 	* ⚠ This method uses the message passing that means the value will be set after `dispatch messages` step.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ts-defold/types",
-  "version": "1.2.4",
+  "version": "1.2.8",
   "description": "TypeScript definitions for Defold",
   "repository": "github:ts-defold/types",
   "keywords": [
@@ -27,7 +27,7 @@
     "lua-types": "^2.10.1"
   },
   "devDependencies": {
-    "@ts-defold/type-gen": "^0.5.0",
+    "@ts-defold/type-gen": "^0.5.2",
     "typescript": "4.3.4",
     "typescript-to-lua": "^1.0.1"
   },