@ts-defold/types 1.2.77 → 1.2.79

package/index.d.ts

@@ -3,8 +3,35 @@
 /// <reference types="lua-types/5.1" />
 /// <reference types="lua-types/special/jit-only" />
 
-// DEFOLD. stable version 1.12.0 (3206f699aaff89f357c9d549050b8453e080c5d2)
+// DEFOLD. stable version 1.12.2 (e43be333aa7a4fc319ab62adc8d405c8e98bf92f)
 
+/**
+ * All ids in the engine are represented as hashes, so a string needs to be hashed
+before it can be compared with an id.
+ * @param s string to hash
+ * @returns a hashed string
+ * @example To compare a message_id in an on-message callback function:
+```lua
+function on_message(self, message_id, message, sender)
+    if message_id == hash("my_message") then
+        -- Act on the message here
+    end
+end
+```
+ */
+declare function hash(s: string): hash;
+/**
+ * Returns a hexadecimal representation of a hash value.
+The returned string is always padded with leading zeros.
+ * @param h hash value to get hex string for
+ * @returns hex representation of the hash
+ * @example ```lua
+local h = hash("my_hash")
+local hexstr = hash_to_hex(h)
+print(hexstr) --> a2bc06d97f580aab
+```
+ */
+declare function hash_to_hex(h: hash): string;
 /**
  * Pretty printing of Lua values. This function prints Lua values
 in a manner similar to +print()+, but will also recurse into tables
@@ -34,33 +61,6 @@ Lua tables is undefined):
 ```
  */
 declare function pprint(...v: any[]): void;
-/**
- * All ids in the engine are represented as hashes, so a string needs to be hashed
-before it can be compared with an id.
- * @param s string to hash
- * @returns a hashed string
- * @example To compare a message_id in an on-message callback function:
-```lua
-function on_message(self, message_id, message, sender)
-    if message_id == hash("my_message") then
-        -- Act on the message here
-    end
-end
-```
- */
-declare function hash(s: string): hash;
-/**
- * Returns a hexadecimal representation of a hash value.
-The returned string is always padded with leading zeros.
- * @param h hash value to get hex string for
- * @returns hex representation of the hash
- * @example ```lua
-local h = hash("my_hash")
-local hexstr = hash_to_hex(h)
-print(hexstr) --> a2bc06d97f580aab
-```
- */
-declare function hash_to_hex(h: hash): string;
 /**
  * A unique identifier used to reference resources, messages, properties, and other entities within the game.
  */
@@ -83,33 +83,6 @@ declare type buffer = object;
 declare type bufferstream = LuaUserdata & number[] & object;
 
 
-declare namespace missingName {
-/**
- * Enables engine throttling.
- * @param enable true if throttling should be enabled
- * @param cooldown the time period to do update + render for (seconds)
- * @example Disable throttling
-```lua
-sys.set_engine_throttle(false)
-```
-
-Enable throttling
-```lua
-sys.set_engine_throttle(true, 1.5)
-```
- */
-export function set_engine_throttle(enable: boolean, cooldown: number): void;
-/**
- * Disables rendering
- * @param enable true if throttling should be enabled
- * @example Disable rendering
-```lua
-sys.set_render_enable(false)
-```
- */
-export function set_render_enable(enable: boolean): void;
-}
-
 declare namespace b2d {
 /**
  * Get the Box2D body from a collision object
@@ -1630,6 +1603,7 @@ export function fixed_update(this: LuaUserdata, dt: number): void;
  * @param options optional options table
 - index number index into array property (1 based)
 - key hash name of internal property
+- keys table array of internal component resources identified by key (e.g. a particle fx emitter, see examples below)
  * @example Get a property "speed" from a script "player", the property must be declared in the player-script:
 ```lua
 go.property("speed", 50)
@@ -1656,18 +1630,21 @@ Getting all values in a material property array as a table
 -- get all vector4's in the constant array
 go.get(url, "example")
 -- result: { vector4, vector4, ... }
-
 -- get all elements of the vector4's from an array
 go.get(url, "example.x")
 -- result: { number1, number2, ... }
 ```Get a named property
-
 ```lua
-function init(self)
-    -- get the resource of a certain gui font
-    local font_hash = go.get("#gui", "fonts", {key = "system_font_BIG"})
-end
-```
+lua
+-- get the resource of a certain gui font
+local font_hash = go.get("#gui", "fonts", {key = "system_font_BIG"})```Get a property from a sub-component, using the "keys" options table
+```lua
+lua
+-- Addressing the first level of a component:
+go.get("#particlefx", "material", { keys = { "cone_emitter" } })```Get a property into a deeper sub-hierarchy (if the component supports it).
+```lua
+-- Note: There is currently no component that supports this, but a custom component could.
+go.get("#my_component", "some_property", { keys = { "root", "child_node" } })
  */
 export function get(url: string | hash | url, property: string | hash, options?: object): unknown;
 /**
@@ -1866,6 +1843,13 @@ end
 ```
  */
 export function init(this: LuaUserdata): void;
+/**
+ * This is a callback-function, which is called by the engine at the end of the frame to update the state of a script
+component. Use it to make final adjustments to the game object instance.
+ * @param this reference to the script state to be used for storing data
+ * @param dt the time-step of the frame update
+ */
+export function late_update(this: LuaUserdata, dt: number): void;
 /**
  * This is a callback-function, which is called by the engine when user input is sent to the game object instance of the script.
 It can be used to take action on the input, e.g. move the instance according to the input.
@@ -2193,6 +2177,7 @@ export function property(name: string, value: number | hash | url | vmath.vector
  * @param options optional options table
 - index integer index into array property (1 based)
 - key hash name of internal property
+- keys table array of internal component resources identified by key (e.g. a particle fx emitter, see examples below)
  * @example Set a property "speed" of a script "player", the property must be declared in the player-script:
 ```lua
 go.property("speed", 50)
@@ -2216,18 +2201,25 @@ go.set(url, "example.x", 7, {index=1})
 
 Set a material property array by a table of vector4
 ```lua
+lua
 -- set the first two vector4's in the array
 -- if the array has more than two elements in the array they will not be set
-go.set(url, "example", { vmath.vector4(1,1,1,1), vmath.vector4(2,2,2,2) })
-```Set a named property
-
+go.set(url, "example", { vmath.vector4(1,1,1,1), vmath.vector4(2,2,2,2) })```Set a named property
 ```lua
 go.property("big_font", resource.font())
-
 function init(self)
     go.set("#gui", "fonts", self.big_font, {key = "system_font_BIG"})
 end
-```
+```Set a property on a sub-component, using the "keys" options table
+```lua
+lua
+go.property("my_material", resource.material)
+function init(self)
+    go.set("#particlefx", "material", self.my_material, { keys = { "cone_emitter" } })
+end```Set a property in a deeper sub-hierarchy (if the component supports it).
+```lua
+-- Note: There is currently no component that supports this, but a custom component could.
+go.set("#my_component", "some_property", some_value, { keys = { "root", "child_node" } })
  */
 export function set(url: string | hash | url, property: string | hash, value: number | boolean | hash | url | vmath.vector3 | vmath.vector4 | vmath.quaternion | any, options?: object): void;
 /**
@@ -2411,8 +2403,10 @@ export type input_message = {
 		gamepad?: number;
 		touch?: touch_input[];
 	};
+export type late_update = (this: any, dt: number) => void;
 export type on_input = (this: any, action_id: hash, action: go.input_message) => void;
 export type on_message = (this: any, message_id: hash, message: object, sender: url) => void;
+export type on_reload = (this: any) => void;
 export type touch_input = {
 		id: number;
 		pressed: boolean;
@@ -3026,6 +3020,22 @@ export const RESULT_OUT_OF_RESOURCES: number;
  * The texture id already exists when trying to use gui.new_texture().
  */
 export const RESULT_TEXTURE_ALREADY_EXISTS: number;
+/**
+ * Safe area mode that applies insets on all edges.
+ */
+export const SAFE_AREA_BOTH: number;
+/**
+ * Safe area mode that applies insets only on the long edges.
+ */
+export const SAFE_AREA_LONG: number;
+/**
+ * Safe area mode that ignores safe area insets.
+ */
+export const SAFE_AREA_NONE: number;
+/**
+ * Safe area mode that applies insets only on the short edges.
+ */
+export const SAFE_AREA_SHORT: number;
 /**
  * The size of the node is determined by the currently assigned texture.
  */
@@ -3058,7 +3068,7 @@ export const TYPE_TEXT: number;
  * This starts an animation of a node property according to the specified parameters.
 If the node property is already being animated, that animation will be canceled and
 replaced by the new one. Note however that several different node properties
-can be animated simultaneously. Use `gui.cancel_animation` to stop the animation
+can be animated simultaneously. Use `gui.cancel_animations` to stop the animation
 before it has completed.
 Composite properties of type vector3, vector4 or quaternion
 also expose their sub-components (x, y, z and w).
@@ -4569,6 +4579,17 @@ The rotation is expressed as a quaternion
  * @param rotation new rotation
  */
 export function set_rotation(node: node, rotation: vmath.quaternion | vmath.vector4): void;
+/**
+ * Sets how the safe area is applied to this gui scene.
+ * @param mode safe area mode
+
+`gui.SAFE_AREA_NONE`
+`gui.SAFE_AREA_LONG`
+`gui.SAFE_AREA_SHORT`
+`gui.SAFE_AREA_BOTH`
+
+ */
+export function set_safe_area_mode(mode: number): void;
 /**
  * Sets the scaling of the supplied node.
  * @param node node to set the scale for
@@ -4803,6 +4824,7 @@ export type final = (this: any) => void;
 export type init = (this: any) => void;
 export type on_input = (this: any, action_id: hash, action: go.input_message) => void;
 export type on_message = (this: any, message_id: hash, message: object, sender: url) => void;
+export type on_reload = (this: any) => void;
 export type update = (this: any, dt: number) => void;
 }
 
@@ -4900,7 +4922,7 @@ function init(self)
 end
 ```
  */
-export function request(url: string, method: string, callback: ((this: any, id: any, response: any) => void), headers?: { [key: string]: string | number }, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean }): void;
+export function request(url: string, method: string, callback: ((this: any, id: any, response: any) => void), headers?: { [key: string]: string | number }, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean; proxy?: string }): void;
 }
 
 declare namespace image {
@@ -6012,7 +6034,7 @@ end
  */
 export function raycast_async(from: vmath.vector3, to: vmath.vector3, groups: hash[] | LuaSet<hash>, request_id?: number): void;
 /**
- * sets a physics world event listener. If a function is set, physics messages will no longer be sent to on_message.
+ * Only one physics world event listener can be set at a time.
  * @param callback A callback that receives an information about all the physics interactions in this physics world.
 
 `self`
@@ -6785,7 +6807,7 @@ function update(self, dt)
 end
 ```
  */
-export function enable_texture(binding: number | string | hash, handle_or_name: number | string | hash, buffer_type?: any | typeof graphics.BUFFER_TYPE_COLOR1_BIT | typeof graphics.BUFFER_TYPE_COLOR2_BIT | typeof graphics.BUFFER_TYPE_COLOR3_BIT | typeof graphics.BUFFER_TYPE_DEPTH_BIT | typeof graphics.BUFFER_TYPE_STENCIL_BIT): void;
+export function enable_texture(binding: number | string | hash, handle_or_name: number | string | hash, buffer_type?: typeof graphics.BUFFER_TYPE_COLOR0_BIT | typeof graphics.BUFFER_TYPE_COLOR1_BIT | typeof graphics.BUFFER_TYPE_COLOR2_BIT | typeof graphics.BUFFER_TYPE_COLOR3_BIT | typeof graphics.BUFFER_TYPE_DEPTH_BIT | typeof graphics.BUFFER_TYPE_STENCIL_BIT): void;
 /**
  * Returns the logical window height that is set in the "game.project" settings.
 Note that the actual window pixel size can change, either by device constraints
@@ -10513,6 +10535,21 @@ sys.set_connectivity_host("www.google.com")
 ```
  */
 export function set_connectivity_host(host: string): void;
+/**
+ * Enables engine throttling.
+ * @param enable true if throttling should be enabled
+ * @param cooldown the time period to do update + render for (seconds)
+ * @example Disable throttling
+```lua
+sys.set_engine_throttle(false)
+```
+
+Enable throttling
+```lua
+sys.set_engine_throttle(true, 1.5)
+```
+ */
+export function set_engine_throttle(enable: boolean, cooldown: number): void;
 /**
  * Set the Lua error handler function.
 The error handler is a function which is called whenever a lua runtime error occurs.
@@ -10546,6 +10583,15 @@ end
 ```
  */
 export function set_error_handler(error_handler: (source: string, message: string, traceback: string,) => void): void;
+/**
+ * Disables rendering
+ * @param enable true if throttling should be enabled
+ * @example Disable rendering
+```lua
+sys.set_render_enable(false)
+```
+ */
+export function set_render_enable(enable: boolean): void;
 /**
  * Set game update-frequency (frame cap). This option is equivalent to `display.update_frequency` in
 the "game.project" settings but set in run-time. If `Vsync` checked in "game.project", the rate will
@@ -11904,6 +11950,36 @@ export function get_display_scale(): number;
  * @returns The lock state
  */
 export function get_mouse_lock(): boolean;
+/**
+ * This returns the safe area rectangle (x, y, width, height) and the inset
+values relative to the window edges. On platforms without a safe area,
+this returns the full window size and zero insets.
+ * @returns safe area data
+
+`safe_area`
+table table containing these keys:
+
+
+number `x`
+number `y`
+number `width`
+number `height`
+number `inset_left`
+number `inset_top`
+number `inset_right`
+number `inset_bottom`
+
+ */
+export function get_safe_area(): {
+						x: number,
+						y: number,
+						width: number,
+						height: number,
+						inset_left: number,
+						inset_top: number,
+						inset_right: number,
+						inset_bottom: number,
+						};
 /**
  * This returns the current window size (width and height).
  * @returns The window width & The window height
@@ -11921,7 +11997,7 @@ This function has no effect on platforms that does not support dimming.
  */
 export function set_dim_mode(mode: number): void;
 /**
- * Sets a window event listener.
+ * Sets a window event listener. Only one window event listener can be set at a time.
  * @param callback A callback which receives info about window events. Pass an empty function or `nil` if you no longer wish to receive callbacks.
 
 `self`

package/package.json

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